Class ActiveRecordController

The main active record CRUD controller for the framework.

Alpha\Controller\ActiveRecordController implements Alpha\Controller\ControllerInterface

Direct known subclasses

Alpha\Controller\ArticleController, Alpha\Controller\DEnumController, Alpha\Controller\SequenceController, Alpha\Controller\TagController

Namespace: Alpha\Controller
Copyright:

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 2.0
Located at Controller/ActiveRecordController.php

Methods summary

`public`	# `__construct( string $visibility = 'Admin' )` Constructor to set up the object. Constructor to set up the object. Parameters `$visibility` The name of the rights group that can access this controller. Since 1.0 Overrides `Alpha\Controller\Controller::__construct`
`public Alpha\Util\Http\Response`	# `doGET( Alpha\Util\Http\Request $request )` Handle GET requests. Handle GET requests. Parameters `$request` Returns `Alpha\Util\Http\Response` Throws `Alpha\Exception\ResourceNotFoundException` `Alpha\Exception\IllegalArguementException` Since 2.0 Overrides `Alpha\Controller\Controller::doGET` Implementation of `Alpha\Controller\ControllerInterface::doGET()`
`public Alpha\Util\Http\Response`	# `doPOST( Alpha\Util\Http\Request $request )` Method to handle POST requests. Method to handle POST requests. Parameters `$request` Returns `Alpha\Util\Http\Response` Throws `Alpha\Exception\IllegalArguementException` `Alpha\Exception\SecurityException` Since 2.0 Overrides `Alpha\Controller\Controller::doPOST` Implementation of `Alpha\Controller\ControllerInterface::doPOST()`
`public Alpha\Util\Http\Response`	# `doPUT( Alpha\Util\Http\Request $request )` Method to handle PUT requests. Method to handle PUT requests. Parameters `$request` Returns `Alpha\Util\Http\Response` Throws `Alpha\Exception\IllegalArguementException` `Alpha\Exception\SecurityException` Since 2.0 Overrides `Alpha\Controller\Controller::doPUT` Implementation of `Alpha\Controller\ControllerInterface::doPUT()`
`public Alpha\Util\Http\Response`	# `doDELETE( Alpha\Util\Http\Request $request )` Method to handle DELETE requests. Method to handle DELETE requests. Parameters `$request` Returns `Alpha\Util\Http\Response` Throws `Alpha\Exception\IllegalArguementException` `Alpha\Exception\SecurityException` `Alpha\Exception\ResourceNotAllowedException` Since 2.0 Overrides `Alpha\Controller\Controller::doDELETE` Implementation of `Alpha\Controller\ControllerInterface::doDELETE()`
`public string`	# `after_displayPageHead_callback( )` Sets up the pagination start point and limit. Sets up the pagination start point and limit. Returns string Since 2.0 Overrides `Alpha\Controller\Controller::after_displayPageHead_callback`
`public string`	# `before_displayPageFoot_callback( )` Method to display the page footer with pageination links. Method to display the page footer with pageination links. Returns string Since 2.0
`public integer`	# `getStart( )` Get the pagination start point Get the pagination start point Returns integer Since 3.0
`public integer`	# `getRecordCount( )` Get the pagination record count Get the pagination record count Returns integer Since 3.0
`public integer`	# `getLimit( )` Get the pagination limit Get the pagination limit Returns integer Since 3.0

Methods inherited from Alpha\Controller\Controller

abort(), accessError(), checkControllerDefExists(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), clearUnitOfWorkAttributes(), commit(), doHEAD(), doOPTIONS(), doPATCH(), doTRACE(), generateSecurityFields(), generateURLSlug(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getRecord(), getRequest(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), markDirty(), markNew(), process(), setDescription(), setKeywords(), setName(), setRecord(), setRequest(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()

Properties summary

`protected integer`	`$start` The start number for list pageination. The start number for list pageination. Since 2.0	# `0`
`protected integer`	`$limit` The amount of records to return during pageination. The amount of records to return during pageination. Since 2.0	#
`protected integer`	`$recordCount` The count of the records of this type in the database (used during pagination). The count of the records of this type in the database (used during pagination). Since 2.0	# `0`
`protected string`	`$sort` The field name to sort the list by (optional, default is ID). The field name to sort the list by (optional, default is ID). Since 2.0	#
`protected string`	`$order` The order to sort the list by (optional, should be ASC or DESC, default is ASC). The order to sort the list by (optional, should be ASC or DESC, default is ASC). Since 2.0	#
`protected string`	`$filterField` The name of the Record field to filter the list by (optional). The name of the Record field to filter the list by (optional). Since 2.0	#
`protected string`	`$filterValue` The value of the filterField to filter by (optional). The value of the filterField to filter by (optional). Since 2.0	#

Properties inherited from Alpha\Controller\Controller

$description, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $record, $request, $statusMessage, $title, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility

Namespaces

Classes

Interfaces

Class ActiveRecordController

Direct known subclasses

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Implementation of

Parameters

Returns

Throws

Since

Overrides

Implementation of

Parameters

Returns

Throws

Since

Overrides

Implementation of

Parameters

Returns

Throws

Since

Overrides

Implementation of

Returns

Since

Overrides

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Methods inherited from Alpha\Controller\Controller

Properties summary

Since

Since

Since

Since

Since

Since

Since

Properties inherited from Alpha\Controller\Controller