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 ModuleAttributesInterface

All values returned from these operations are invariants.

Direct known implementers

Nethgui\Module\SimpleModuleAttributesProvider, Nethgui\Renderer\TemplateRenderer, Nethgui\Test\Unit\Nethgui\View\TranslatorTestModule

Indirect known implementers

Nethgui\Module\CompositeModuleAttributesProvider, Nethgui\Module\Help\Renderer, Nethgui\Module\SystemModuleAttributesProvider, Nethgui\Renderer\Xhtml, Nethgui\Widget\Xhtml\ElementRenderer
Namespace: Nethgui\Module
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Module/ModuleAttributesInterface.php
Methods summary
public string
# getTitle( )

Gets the Module title

Gets the Module title

Returns

string

Api

public string
# getDescription( )

Gets the Module description

Gets the Module description

Returns

string

Api

public string
# getTags( )

Gets module tags.

Gets module tags.

Any composite module must take care of getTags children's call.

Tags are used to search a module among the others

Returns

string

Api

public string
# getCategory( )

The category of the aggregated module

The category of the aggregated module

Returns

string
Unique parent module identifier

Api

public string
# getMenuPosition( )

The menu position of the aggregated module

The menu position of the aggregated module

Returns

string

Api

public string|array
# getLanguageCatalog( )

The name of the language catalog where to search the translated strings

The name of the language catalog where to search the translated strings

Returns

string|array
The language catalog name, or catalog name list

Api

Nethgui Framework API documentation generated by ApiGen