Class AbstractModule

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

Direct known subclasses

Nethgui\Controller\AbstractController, Nethgui\Module\Composite, Nethgui\Module\Notification

Indirect known subclasses

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

Methods summary
`public`	# `__construct( $identifier = NULL )`
`public Nethgui\System\PlatformConsumerInterface`	# `setPlatform( Nethgui\System\PlatformInterface $platform )` Set the Platform object Set the Platform object Returns `Nethgui\System\PlatformConsumerInterface` Api Implementation of `Nethgui\System\PlatformConsumerInterface::setPlatform()`
`public Nethgui\System\PlatformInterface`	# `getPlatform( )` Get the Platform object Get the Platform object Returns `Nethgui\System\PlatformInterface` Api Implementation of `Nethgui\System\PlatformConsumerInterface::getPlatform()`
`public boolean`	# `hasPlatform( )` Tell if the Platform object has been set Tell if the Platform object has been set Returns boolean TRUE if the Platform has been set, FALSE otherwise Api Implementation of `Nethgui\System\PlatformConsumerInterface::hasPlatform()`
`public`	# `initialize( )` Overriding methods can read current state from model. Overriding methods can read current state from model. Implementation of `Nethgui\Module\ModuleInterface::initialize()`
`public boolean`	# `isInitialized( )` Prevents double initialization. Prevents double initialization. Returns boolean FALSE, if not yet initialized, TRUE otherwise. Api Implementation of `Nethgui\Module\ModuleInterface::isInitialized()`
`public string`	# `getIdentifier( )` The Module Identifier is a string that univocally identifies a Module. The Module Identifier is a string that univocally identifies a Module. Returns string Returns the unique module identifier Api Implementation of `Nethgui\Module\ModuleInterface::getIdentifier()`
`public Nethgui\Module\ModuleInterface`	# `setParent( Nethgui\Module\ModuleInterface $parentModule )` Sets the reference to the parent Module. Sets the reference to the parent Module. Returns `Nethgui\Module\ModuleInterface` See ModuleCompositeInterface addChild() operation. Api Implementation of `Nethgui\Module\ModuleInterface::setParent()`
`public Nethgui\Module\ModuleInterface`	# `getParent( )` Gets a reference to the parent Module. Gets a reference to the parent Module. Returns `Nethgui\Module\ModuleInterface` Api Implementation of `Nethgui\Module\ModuleInterface::getParent()`
`public`	# `prepareView( Nethgui\View\ViewInterface $view )` Prepare view layer data, putting it into $view. Prepare view layer data, putting it into $view. Parameters `$view` The view to put the data into See ViewInterface Api Implementation of `Nethgui\View\ViewableInterface::prepareView()`
`protected Nethgui\Module\AbstractModule`	# `setViewTemplate( string\|callable $template )` Parameters `$template` Returns `Nethgui\Module\AbstractModule`
`protected string\|callable`	# `getViewTemplate( )` Returns string\|callable
`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 Implementation of `Nethgui\Log\LogConsumerInterface::setLog()`
`public Nethgui\Log\LogInterface`	# `getLog( )` The log attached to the interface implementor The log attached to the interface implementor Returns `Nethgui\Log\LogInterface` Api Implementation of `Nethgui\Log\LogConsumerInterface::getLog()`
`protected Nethgui\Module\ModuleAttributesInterface`	# `initializeAttributes( Nethgui\Module\ModuleAttributesInterface $attributes )` Called after a default attributes provider object is created Called after a default attributes provider object is created Parameters `$attributes` $descriptor Returns `Nethgui\Module\ModuleAttributesInterface` See `Nethgui\Module\AbstractModule::getAttributesProvider()`
`public Nethgui\Module\ModuleAttributesInterface`	# `getAttributesProvider( )` Gain access to the attributes of this module Gain access to the attributes of this module Returns `Nethgui\Module\ModuleAttributesInterface` Api Implementation of `Nethgui\Module\ModuleInterface::getAttributesProvider()`
`public Nethgui\Utility\PhpConsumerInterface`	# `setPhpWrapper( Nethgui\Utility\PhpWrapper $object )` Parameters `$object` Returns `Nethgui\Utility\PhpConsumerInterface` Implementation of `Nethgui\Utility\PhpConsumerInterface::setPhpWrapper()`
`protected Nethgui\Utility\PhpWrapper`	# `getPhpWrapper( )` Returns `Nethgui\Utility\PhpWrapper`
`public string`	# `asAuthorizationString( )` Convert an object to a default string representation Convert an object to a default string representation Returns string The string representing the object in authorization rules Api Implementation of `Nethgui\Authorization\AuthorizationAttributesProviderInterface::asAuthorizationString()`
`public mixed`	# `getAuthorizationAttribute( $attributeName )` Get the value of an attribute Get the value of an attribute Returns mixed The value of the authorization attribute Api Implementation of `Nethgui\Authorization\AuthorizationAttributesProviderInterface::getAuthorizationAttribute()`
`protected Nethgui\Authorization\PolicyDecisionPointInterface`	# `getPolicyDecisionPoint( )` Access the associated PDP object. If no PDP has been associated to this object, an always-pass PDP is returned by default. Access the associated PDP object. If no PDP has been associated to this object, an always-pass PDP is returned by default. Returns `Nethgui\Authorization\PolicyDecisionPointInterface`
`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 Implementation of `Nethgui\Authorization\PolicyEnforcementPointInterface::setPolicyDecisionPoint()`

Constants inherited from Nethgui\Module\ModuleInterface
`ACTION_INSTANTIATE`

Namespaces

Classes

Interfaces

Class AbstractModule

Direct known subclasses

Indirect known subclasses

Returns

Api

Implementation of

Returns

Api

Implementation of

Returns

Api

Implementation of

Implementation of

Returns

Api

Implementation of

Returns

Api

Implementation of

Returns

See

Api

Implementation of

Returns

Api

Implementation of

Parameters

See

Api

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Api

Implementation of

Returns

Api

Implementation of

Parameters

Returns

See

Returns

Api

Implementation of

Parameters

Returns

Implementation of

Returns

Returns

Api

Implementation of

Returns

Api

Implementation of

Returns

Parameters

Returns

Api

Implementation of