Class: Group

Source Location: /classes/group.php

Class Overview

Object
   |
   --Module
      |
      --Group

Groups contain multiple modules, and render only those modules.

Author(s):

Daryl Koopersmith

Variables

$children

Methods

Child classes:

Selection: A Selection is an anonymous Group meant for manipulating modules.

Inherited Variables

Class: Module

Module::$classes
Module::$id
Module::$type

Inherited Methods

Class: Module

Module::__construct(): Constructs a new Module.
Module::add_class(): C L A S S E S A P I
Module::apply_atomic(): An interface to elastic_apply_atomic() for an instance of a Module.
Module::apply_atomic_specific(): An interface to elastic_apply_atomic_specific() for an instance of a Module.
Module::do_atomic(): An interface to elastic_do_atomic() for an instance of a Module.
Module::do_atomic_specific(): An interface to elastic_do_atomic_specific() for an instance of a Module.
Module::do_view(): Returns the output of the most contextually-specific set view.
Module::format_hook(): Formats a hook for this module.
Module::get_module(): Get a module by id.
Module::get_modules(): Function that provides a framework for searching all modules based on a slug and a callback.
Module::get_modules_by_type(): Get a module by type.
Module::has_class()
Module::has_view()
Module::load_default_views(): Loads and sets default views
Module::load_views_folder(): Loads and sets views from a folder.
Module::remove_class()
Module::remove_view(): Removes any view associated with a provided context.
Module::run(): Calls the hooks and generates the output.
Module::set_view(): Binds a callback to a view. At any time, only one callback will be bound to a view.

Class: Object

Object::__construct()
Object::Object(): Object

Class Details

[line 11]
Groups contain multiple modules, and render only those modules.

A group's views cannot be set.

Tags:

author:	Daryl Koopersmith
todo:	add children manipulation functions

[ Top ]

Class Variables

$children =

[line 12]

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 14]

Group __construct(

$id, [
$children = null])

Overridden in child classes as:

Selection::__construct()

Overrides Module::__construct() (Constructs a new Module.)

Parameters:

	$id
	$children

[ Top ]

method remove_view [line 48]

void remove_view(
)

Override remove_view. Groups have only one view.

Tags:

author:

Daryl Koopersmith

Overrides Module::remove_view() (Removes any view associated with a provided context.)

[ Top ]

method set_view [line 39]

void set_view(
)

Override set_view. Groups have only one view.

Tags:

author:

Daryl Koopersmith

Overrides Module::set_view() (Binds a callback to a view. At any time, only one callback will be bound to a view.)

[ Top ]

method _view [line 27]

void _view(
)

The only group view: run all of its children.

Tags:

author:

Daryl Koopersmith

[ Top ]

Documentation generated on Sat, 24 Oct 2009 17:17:45 -0500 by phpDocumentor 1.4.3