Class Composite

A composition of modules forwards request handling to its parts.

Inheriting classes must define the composition behaviour.

Nethgui\Module\AbstractModule implements Nethgui\Module\ModuleInterface, Nethgui\View\ViewableInterface, Nethgui\Log\LogConsumerInterface, Nethgui\Utility\PhpConsumerInterface, Nethgui\Authorization\AuthorizationAttributesProviderInterface, Nethgui\System\PlatformConsumerInterface, Nethgui\Authorization\PolicyEnforcementPointInterface

Nethgui\Module\Composite implements Nethgui\Module\ModuleCompositeInterface, Nethgui\Component\DependencyInjectorAggregate

Direct known subclasses

Nethgui\Controller\CompositeController, Nethgui\Controller\ListComposite, Nethgui\Test\Unit\Nethgui\Module\ConcreteCompositeModule1

Indirect known subclasses

Nethgui\Controller\CollectionController, Nethgui\Controller\Table\PluginCollector, Nethgui\Controller\TableController, Nethgui\Controller\TabsController, Nethgui\Module\Help, Nethgui\Module\Main

Abstract
Namespace: Nethgui\Module
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
See: Controller
See: List
Api
Located at Module/Composite.php

Methods summary
`public`	# `initialize( )` Propagates initialize() message to children. Propagates initialize() message to children. See `Nethgui\Module\Composite::loadChildren()` Api Overrides `Nethgui\Module\AbstractModule::initialize()`
`public Nethgui\Module\Composite`	# `addChild( Nethgui\Module\ModuleInterface $childModule )` Adds a child to Composite, initializing it, if current Composite is initialized. Adds a child to Composite, initializing it, if current Composite is initialized. Parameters `$childModule` Returns `Nethgui\Module\Composite` Api Implementation of `Nethgui\Module\ModuleCompositeInterface::addChild()`
`public array`	# `getChildren( )` Get the parts of this Composite. Get the parts of this Composite. Returns array Api Implementation of `Nethgui\Module\ModuleCompositeInterface::getChildren()`
`public Nethgui\System\PlatformConsumerInterface`	# `setPlatform( Nethgui\System\PlatformInterface $platform )` Set the Platform object Set the Platform object Returns `Nethgui\System\PlatformConsumerInterface` Api Overrides `Nethgui\Module\AbstractModule::setPlatform()`
`protected Nethgui\Module\Composite`	# `loadChildren( type $classList )` Instantiates the given classes, adding the created objects as children of the composite module. Instantiates the given classes, adding the created objects as children of the composite module. If the first character is `*` (asterisk), the container class name is prepended. Deprecated since 1.6 Parameters `$classList` Returns `Nethgui\Module\Composite` See `Nethgui\Module\Composite::addChild()` Link http://redmine.nethesis.it/issues/196
`public Nethgui\Module\Composite`	# `loadChildrenDirectory( Nethgui\Module\ModuleInterface $module = NULL, string $childrenDir = NULL )` Search all php files under the "children" directory and instantiates any class implementing ModuleInterface. Search all php files under the "children" directory and instantiates any class implementing ModuleInterface. The "children" directory has the dirname() of $module php source file, and by default its name is the basename() of $module php source file without .php extension. You can specify an alternate children directory name in $childrenDir parameter. Parameters `$module` Optional the reference module, $this by default `$childrenDir` $path Optional the children directory name, same as $module php source file by default Returns `Nethgui\Module\Composite`
`protected void;`	# `sortChildren( callable $callback )` Sort children applying the given callback function Sort children applying the given callback function Parameters `$callback` Returns void; See http://php.net/manual/en/function.usort.php
`public Nethgui\Log\LogConsumerInterface`	# `setLog( Nethgui\Log\LogInterface $log )` Change the log attached to the interface implementor Change the log attached to the interface implementor Parameters `$log` Returns `Nethgui\Log\LogConsumerInterface` Api Overrides `Nethgui\Module\AbstractModule::setLog()`
`public Nethgui\Authorization\PolicyEnforcementPointInterface`	# `setPolicyDecisionPoint( Nethgui\Authorization\PolicyDecisionPointInterface $pdp )` Interface implementor will receive the PDP object through this setter Interface implementor will receive the PDP object through this setter Parameters `$pdp` Returns `Nethgui\Authorization\PolicyEnforcementPointInterface` Api Overrides `Nethgui\Module\AbstractModule::setPolicyDecisionPoint()`
`public Nethgui\Component\DependencyInjectorAggregate`	# `setDependencyInjector( callable $di )` Parameters `$di` Returns `Nethgui\Component\DependencyInjectorAggregate` The object itself Implementation of `Nethgui\Component\DependencyInjectorAggregate::setDependencyInjector()`

Methods inherited from Nethgui\Module\AbstractModule
`__construct(), asAuthorizationString(), getAttributesProvider(), getAuthorizationAttribute(), getIdentifier(), getLog(), getParent(), getPhpWrapper(), getPlatform(), getPolicyDecisionPoint(), getViewTemplate(), hasPlatform(), initializeAttributes(), isInitialized(), prepareView(), setParent(), setPhpWrapper(), setViewTemplate()`

Constants inherited from Nethgui\Module\ModuleInterface
`ACTION_INSTANTIATE`

Properties summary
`protected callable`	`$dependencyInjector`	#

Namespaces

Classes

Interfaces

Class Composite

Direct known subclasses

Indirect known subclasses

See

Api

Overrides

Parameters

Returns

Api

Implementation of

Returns

Api

Implementation of

Returns

Api

Overrides

Deprecated

Parameters

Returns

See

Link

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Api

Overrides

Parameters

Returns

Api

Overrides

Parameters

Returns

Implementation of