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 RowAbstractAction

Table action that works on a database record identified by a key

Parameters are decleared in bind(). Clients must provide a parameter schema, before bind() is called. See setSchema().

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\RowAbstractAction

Direct known subclasses

Nethgui\Controller\Table\Modify, Nethgui\Controller\Table\RowPluginAction
Abstract
Namespace: Nethgui\Controller\Table
Author: Davide Principi davide.principi@nethesis.it
Since: 1.0
Api
Located at Controller/Table/RowAbstractAction.php
Methods summary
public string
# getKey( )

Returns

string
The key parameter name

Api

public Nethgui\Controller\Table\RowAbstractAction
# setAdapter( Nethgui\Adapter\AdapterInterface $adapter )

Receive the table adapter and convert it into a RecordAdapter

Receive the table adapter and convert it into a RecordAdapter

Invoked by the parent module (i.e. TableController)

Parameters

$adapter

Returns

Nethgui\Controller\Table\RowAbstractAction

See

Nethgui\Controller\TableController

Api

Overrides

Nethgui\Controller\Table\AbstractAction::setAdapter()
public
# bind( Nethgui\Controller\RequestInterface $request )

Put the request into the object internal state

Parameters

$request

Api

Overrides

Nethgui\Controller\AbstractController::bind()
public Nethgui\Controller\Table\RowAbstractAction
# setSchema( array $parameterSchema )

Set the mapping between the view parameters and the underlying datasource

Set the mapping between the view parameters and the underlying datasource

The array is a list of array of arguments to declareParameter(). A special processing is added to the third parameter, $valueProvider:

  • the KEY binds the parameter to the record key

  • the FIELD const binds the parameter with the corresponding prop. If the parameter name differs from the prop name add a 4th, corresponding to the prop name.

Parameters

$parameterSchema

Returns

Nethgui\Controller\Table\RowAbstractAction
The object itself

Throws

LogicException

Api

public array
# getSchema( )

Get the declared parameter schema

Get the declared parameter schema

Returns

array

See

Nethgui\Controller\Table\RowAbstractAction::setSchema()

Api

public Nethgui\Controller\Table\RowAbstractAction
# setDefaultValue( string $parameterName, string $value )

Set a parameter default value

Set a parameter default value

The given value is assigned to the parameter if the request is a QUERY and the record adapter is missing the identifier (key) value

Parameters

$parameterName
$value

Returns

Nethgui\Controller\Table\RowAbstractAction
protected boolean
# saveParameters( )

Returns

boolean
The adapter save() exit status

Overrides

Nethgui\Controller\Table\AbstractAction::saveParameters()
Methods inherited from Nethgui\Controller\Table\AbstractAction
getAdapter(), hasAdapter(), nextPath(), prepareView()
Methods inherited from Nethgui\Controller\AbstractController
__construct(), 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 summary
integer KEY
# 1325671618
integer FIELD
# 1325671619
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