# Class ListAll

Controller used to list a BO, which must be supplied in GET vars

  AlphaController
  ListAll implements AlphaControllerInterface

#### Direct known subclasses

ListDEnums, ListSequences
Package: alpha::controller
Copyright: Copyright (c) 2013, John Collins (founder of Alpha Framework). All rights reserved.

    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>
Version: $Id: ListAll.php 1650 2013-02-22 16:18:53Z alphadevx $
Since: 1.0
Located at controller/ListAll.php

Methods summary
`public` | # `__construct( string $visibility = 'Admin' )` Constructor to set up the object Constructor to set up the object #### Parameters $visibility `string` $visibility #### Since 1.0 #### Overrides `AlphaController::__construct()`
`public` | # `doGET( array $params )` Handle GET requests Handle GET requests #### Parameters $params `array` $params #### Since 1.0 #### Implementation of `AlphaControllerInterface::doGET()`
`public` | # `doPOST( array $params )` Handle POST requests Handle POST requests #### Parameters $params `array` $params #### Since 1.0 #### Implementation of `AlphaControllerInterface::doPOST()`
`public` | # `before_displayPageHead_callback( )` Sets up the title etc. and pagination start point Sets up the title etc. and pagination start point #### Since 1.0
`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 1.0
`protected string` | # `renderPageLinks( )` Method for rendering the pagination links Method for rendering the pagination links #### Returns `string` #### Since 1.0
`protected` | # `displayBodyContent( )` Method to display the main body HTML for this page Method to display the main body HTML for this page #### Since 1.0
`public` | # `after_displayPageHead_callback( )` Use this callback to inject in the admin menu template fragment for admin users of the backend only. Use this callback to inject in the admin menu template fragment for admin users of the backend only. #### Since 1.2

Methods inherited from AlphaController
`abort(), accessError(), checkControllerDefExists(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), commit(), generateSecurityFields(), getBO(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), loadCustomController(), markDirty(), markNew(), setBO(), setDescription(), setKeywords(), setName(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()`

Properties summary
`protected string` | $BOname | `` | # The name of the BO The name of the BO #### Since 1.0
`protected `AlphaView`` | $BOView | `` | # The new default AlphaView object used for rendering the onjects to list The new default AlphaView object used for rendering the onjects to list #### Since 1.0
`protected integer` | $startPoint | `` | # The start number for list pageination The start number for list pageination #### Since 1.0
`protected integer` | $BOCount | `0` | # The count of the BOs of this type in the database The count of the BOs of this type in the database #### Since 1.0
`protected string` | $sort | `` | # The field name to sort the list by (optional, default is OID) The field name to sort the list by (optional, default is OID) #### Since 1.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 1.0
`protected string` | $filterField | `` | # The name of the BO field to filter the list by (optional) The name of the BO field to filter the list by (optional) #### Since 1.0
`protected string` | $filterValue | `` | # The value of the filterField to filter by (optional) The value of the filterField to filter by (optional) #### Since 1.0
`private static `Logger`` | $logger | `null` | # Trace logger Trace logger #### Since 1.0

Properties inherited from AlphaController
`$BO, $description, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $statusMessage, $title, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility`