Overview

Namespaces

  • Nethgui
    • Adapter
    • Authorization
    • Component
    • Controller
      • Collection
      • Table
    • Exception
    • Log
    • Model
    • Module
      • Help
      • Notification
    • Renderer
    • Serializer
    • System
    • Test
      • Tool
      • Unit
        • Nethgui
          • Adapter
            • ParameterSet
          • Authorization
          • Log
          • Module
            • Notification
          • Renderer
          • Serializer
          • System
          • Utility
          • View
        • Test
          • Tool
    • Utility
    • View
    • Widget
      • Xhtml
  • None
  • Test
    • Tool

Classes

  • AbstractModule
  • Composite
  • CompositeModuleAttributesProvider
  • Help
  • Language
  • Login
  • Logout
  • Main
  • Menu
  • ModuleLoader
  • Notification
  • Resource
  • SimpleModuleAttributesProvider
  • SystemModuleAttributesProvider
  • Tracker

Interfaces

  • ModuleAttributesInterface
  • ModuleCompositeInterface
  • ModuleInterface
  • ModuleSetInterface
  • Overview
  • Namespace
  • Class
  • Deprecated

Interface ModuleInterface

Core module operations

A module interface implementation is delegated to - initialize the module (and its submodules) - prepare view parameters

Direct known implementers

Nethgui\Controller\Collection\ActionInterface, Nethgui\Module\AbstractModule, Nethgui\Test\Unit\Nethgui\View\TranslatorTestModule, Nethgui\Widget\Xhtml\ElementModule

Indirect known implementers

Nethgui\Controller\AbstractController, Nethgui\Controller\Collection\AbstractAction, Nethgui\Controller\Table\Read, Nethgui\Controller\Table\RowAbstractAction, Nethgui\Controller\Table\RowPluginAction, Nethgui\Controller\TableController, Nethgui\Controller\TabsController, Nethgui\Module\Composite, Nethgui\Module\Help, Nethgui\Module\Help\Common, Nethgui\Module\Help\Read, Nethgui\Module\Help\Show, Nethgui\Controller\CollectionController, Nethgui\Module\Help\Template, Nethgui\Module\Language, Nethgui\Module\Login, Nethgui\Module\Logout, Nethgui\Module\Main, Nethgui\Module\Menu, Nethgui\Module\Notification, Nethgui\Module\Resource, Nethgui\Module\Tracker, Nethgui\Test\Unit\Nethgui\Module\ConcreteCompositeModule1, Nethgui\Controller\CompositeController, Nethgui\Test\Unit\Nethgui\Module\ConcreteStandardModule1, Nethgui\Controller\ListComposite, Nethgui\Controller\Table\AbstractAction, Nethgui\Controller\Table\Help, Nethgui\Controller\Table\Modify, Nethgui\Controller\Table\PluggableAction, Nethgui\Controller\Table\PluginCollector
Namespace: Nethgui\Module
Since: 1.0
See: Nethgui\Controller\RequestHandlerInterface
Api
Located at Module/ModuleInterface.php
Methods summary
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

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

public Nethgui\Module\ModuleInterface
# getParent( )

Gets a reference to the parent Module.

Gets a reference to the parent Module.

Returns

Nethgui\Module\ModuleInterface

Api

public
# initialize( )

After initialization a module...

After initialization a module...

Api

public boolean
# isInitialized( )

Prevents double initialization.

Prevents double initialization.

Returns

boolean
FALSE, if not yet initialized, TRUE otherwise.

Api

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

Constants summary
string ACTION_INSTANTIATE

Authorization required to create a module instance

Authorization required to create a module instance

# 'INSTANTIATE'
Nethgui Framework API documentation generated by ApiGen