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

  • AbstractAction
  • Help
  • Modify
  • PluggableAction
  • PluginCollector
  • Read
  • RowAbstractAction
  • RowPluginAction
  • Overview
  • Namespace
  • Class
  • Deprecated

Class Read

Display a table adapter as a TABLE element

Each column is rendered through a prepareColumn() callback that you should define on the parent module or on the inheritor class.

Note that a simple implementation for 'Key' and 'Actions' columns is provided by this class.

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
Extended by Nethgui\Controller\AbstractController implements Nethgui\Controller\RequestHandlerInterface
Extended by Nethgui\Controller\Table\AbstractAction implements Nethgui\Adapter\AdapterAggregateInterface
Extended by Nethgui\Controller\Table\Read
Namespace: Nethgui\Controller\Table
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
See: Nethgui\Controller\Table\Modify
See: \Nethgui\Controller\Table
Api
Located at Controller/Table/Read.php
Methods summary
public
# __construct( string $identifier = NULL )

Parameters

$identifier

Overrides

Nethgui\Controller\AbstractController::__construct()
public Nethgui\Controller\Table\Read
# setColumns( array $columns )

Set the column formatting attributes

Set the column formatting attributes

Call before prepareView()

Parameters

$columns

Returns

Nethgui\Controller\Table\Read
public
# prepareView( Nethgui\View\ViewInterface $view )

Add default Cancel and FormAction URLs

Add default Cancel and FormAction URLs

Parameters

$view

Overrides

Nethgui\Controller\Table\AbstractAction::prepareView()
public Nethgui\Renderer\WidgetInterface
# renderTableActions( Nethgui\Renderer\Xhtml $view )

Generate the table actions button list

Generate the table actions button list

Parameters

$view
A parent controller view

Returns

Nethgui\Renderer\WidgetInterface
public
# prepareViewForColumnKey( Nethgui\View\ViewInterface $view, $key, $values, & $rowMetadata )
public Nethgui\View\ViewInterface
# prepareViewForColumnActions( Nethgui\View\ViewInterface $view, string $key, array $values, array & $rowMetadata )

Parameters

$view
$key
The data row key
$values
The data row values
$rowMetadata
$rowMetadata The metadadata row values, like css classes

Returns

Nethgui\View\ViewInterface
public
# renderColumnActions( Nethgui\Renderer\Xhtml $view )
public mixed
# nextPath( )

Get the path to the next module. Relative paths resolving is deferred to implementors.

Get the path to the next module. Relative paths resolving is deferred to implementors.

Executed after process(), the user agent is directed to the designated module.

If boolean FALSE is returned then no action takes place.

Returns

mixed
boolean FALSE, string path (absolute), array request

Api

Overrides

Nethgui\Controller\Table\AbstractAction::nextPath()
Methods inherited from Nethgui\Controller\Table\AbstractAction
getAdapter(), hasAdapter(), saveParameters(), setAdapter()
Methods inherited from Nethgui\Controller\AbstractController
bind(), createValidator(), declareParameter(), getRequest(), getValidator(), onParametersSaved(), process(), validate()
Methods inherited from Nethgui\Module\AbstractModule
asAuthorizationString(), getAttributesProvider(), getAuthorizationAttribute(), getIdentifier(), getLog(), getParent(), getPhpWrapper(), getPlatform(), getPolicyDecisionPoint(), getViewTemplate(), hasPlatform(), initialize(), initializeAttributes(), isInitialized(), setLog(), setParent(), setPhpWrapper(), setPlatform(), setPolicyDecisionPoint(), setViewTemplate()
Constants inherited from Nethgui\Module\ModuleInterface
ACTION_INSTANTIATE
Constants inherited from Nethgui\Controller\RequestHandlerInterface
ACTION_MUTATE, ACTION_QUERY
Properties inherited from Nethgui\Controller\AbstractController
$parameters
Nethgui Framework API documentation generated by ApiGen