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

  • AbstractController
  • CollectionController
  • CompositeController
  • ListComposite
  • NullRequest
  • RequestTest
  • TableController
  • TabsController

Interfaces

  • RequestHandlerInterface
  • RequestInterface
  • ValidationReportInterface
  • Overview
  • Namespace
  • Class
  • Deprecated

Class CollectionController

TODO: add component description here

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\Module\Composite implements Nethgui\Module\ModuleCompositeInterface, Nethgui\Component\DependencyInjectorAggregate
Extended by Nethgui\Controller\CompositeController implements Nethgui\Controller\RequestHandlerInterface
Extended by Nethgui\Controller\CollectionController implements Nethgui\Adapter\AdapterAggregateInterface
Namespace: Nethgui\Controller
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Located at Controller/CollectionController.php
Methods summary
protected Nethgui\Controller\CollectionController
# setAdapter( Nethgui\Adapter\AdapterInterface $adapter )

Set the adapter object that gives access to the database collection

Set the adapter object that gives access to the database collection

Parameters

$adapter

Returns

Nethgui\Controller\CollectionController
public Nethgui\Adapter\AdapterInterface
# getAdapter( )

Returns

Nethgui\Adapter\AdapterInterface

Api

Implementation of

Nethgui\Adapter\AdapterAggregateInterface::getAdapter()
public boolean
# hasAdapter( )

Returns

boolean

Api

Implementation of

Nethgui\Adapter\AdapterAggregateInterface::hasAdapter()
protected Nethgui\Controller\Collection\ActionInterface
# getIndexAction( )

Returns

Nethgui\Controller\Collection\ActionInterface
protected Nethgui\Controller\CollectionController
# setIndexAction( Nethgui\Controller\Collection\ActionInterface $action )

Parameters

$action

Returns

Nethgui\Controller\CollectionController

Throws

LogicException
public
# initialize( )

Propagates initialize() message to children.

Propagates initialize() message to children.

See

Nethgui\Module\Composite::loadChildren()

Api

Overrides

Nethgui\Module\Composite::initialize()
public Composite
# addChild( Nethgui\Module\ModuleInterface $childAction )

Add $childAction to the controller, and propagate the adapter to the child, if it has not been done yet.

Add $childAction to the controller, and propagate the adapter to the child, if it has not been done yet.

Parameters

$childAction

Returns

Composite

Overrides

Nethgui\Module\Composite::addChild()
public Nethgui\Controller\CollectionController
# addElementAction( Nethgui\Controller\Collection\ActionInterface $action )

A row action is executed in a row context (i.e. row updating, deletion...)

A row action is executed in a row context (i.e. row updating, deletion...)

Parameters

$action

Returns

Nethgui\Controller\CollectionController

See

getRowActions()
public array
# getElementActions( )

Actions for a single element of the collection

Actions for a single element of the collection

Returns

array
public Nethgui\Controller\CollectionController
# addCollectionAction( Nethgui\Module\ModuleInterface $a )

A collection-wide action involves the whole collection (i.e. create a new element, print the collection...) or a subset of it.

A collection-wide action involves the whole collection (i.e. create a new element, print the collection...) or a subset of it.

Returns

Nethgui\Controller\CollectionController

See

Nethgui\Controller\CollectionController::getCollectionActions()
public array
# getCollectionActions( )

Actions for the whole collection

Actions for the whole collection

Returns

array
public
# renderIndex( Nethgui\Renderer\Xhtml $renderer )

Overrides

Nethgui\Controller\CompositeController::renderIndex()
Methods inherited from Nethgui\Controller\CompositeController
bind(), establishCurrentActionId(), getAction(), getRequest(), hasAction(), needsAutoFormWrap(), nextPath(), prepareView(), process(), renderCurrentAction(), validate()
Methods inherited from Nethgui\Module\Composite
getChildren(), loadChildren(), loadChildrenDirectory(), setDependencyInjector(), setLog(), setPlatform(), setPolicyDecisionPoint(), sortChildren()
Methods inherited from Nethgui\Module\AbstractModule
__construct(), asAuthorizationString(), getAttributesProvider(), getAuthorizationAttribute(), getIdentifier(), getLog(), getParent(), getPhpWrapper(), getPlatform(), getPolicyDecisionPoint(), getViewTemplate(), hasPlatform(), initializeAttributes(), isInitialized(), setParent(), setPhpWrapper(), setViewTemplate()
Constants inherited from Nethgui\Controller\RequestHandlerInterface
ACTION_MUTATE, ACTION_QUERY
Constants inherited from Nethgui\Module\ModuleInterface
ACTION_INSTANTIATE
Properties inherited from Nethgui\Controller\CompositeController
$currentAction
Properties inherited from Nethgui\Module\Composite
$dependencyInjector
Nethgui Framework API documentation generated by ApiGen