• Home
• Newscoop
• TemplateList
• BaseList

PHP Class Newscoop\TemplateList\BaseList

Show file Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property	Type	Description
$cacheKey	mixed	List cache key
$columns	integer	The number of columns (for generating tables)
$constraints	array	The constraints array.
$critera	Newscoop\Criteria	The Criteria object
$defaultIterator	object	The default iterator for the current object.
$defaultTTL	integer	Default cache time
$firstResult	integer	The start page number from which to generate the list.
$hasNextResults	boolean	True if the generated list has more elements than $this->m_limit
$id	string	The identifier of the list
$maxResults	integer	The maximum number of objects in the list, null or 0 for no limit
$name	string	The name of the list
$objectsList	Newscoop\ListResult	The list of objects.
$operatorsMap
$parameters	array	The clean array of parameters
$totalCount	integer	The total number of elements in the list without the limits.

Public Methods

Method	Description
__construct ( $criteria )
__get ( string $property ) : mixed	Overloaded method call to give access to the list properties.
defaultIterator ( ) : object	Returns the default iterator of this list.
getColumn ( integer $iterator = null )	Returns the column number for the given iterator
getColumns ( ) : integer	Returns the number of columns.
getConstraints ( ) : array	Returns the constraints.
getCurrent ( ) : object	Returns the current element of the default iterator.
getEnd ( ) : integer	Returns the index of the last element of this list in the original list from which this was truncated.
getIndex ( ) : integer	Returns the index of the current element of the default iterator.
getIterator ( ) : object	Returns an iterator for this list.
getLength ( ) : integer	Returns the length of the list.
getLimit ( ) : integer	Returns the maximum number of elements, 0 for limitless.
getList ( $firstResult, $parameters )
getName ( ) : string	Returns the list name.
getRow ( $iterator = null )	Returns the row number for the given iterator
getStart ( ) : integer	Returns the index of the start element of this list in the original list from which this was truncated.
getTotalCount ( ) : unknown	Returns the total number of elements in the list without the limits.
hasNextElements ( ) : boolean	Returns true if this list is limited and elements still exist in the original list (from which this was truncated) after the last element of this list.
hasPreviousElements ( ) : boolean	Returns true if the index of the start element in the original list - from which this was truncated - is greater than 0.
isBlank ( ) : boolean	Return true if the list is blank (see the constructor documentation).
isEmpty ( ) : boolean	Return true if the list is empty.
isLimited ( ) : boolean	Returns true if the list is limited to a certain number of elements.
setId ( string $id )	Sets the list identifier
setTotalCount ( $totalCount ) : unknown	Set list total count.

Protected Methods

Method	Description
convertConstraints ( )	Convert constraints array to Criteria
convertParameters ( integer $firstResult, array $parameters ) : Criteria	Convert parameters array to Criteria
getCacheKey ( )
parseConstraintsString ( string $constraintsString ) : array	Parses the constraints string and returns an array of words
prepareList ( Criteria $criteria, array $parameters ) : ListResult	Get ListResult object with list elements
setCriteria ( Criteria $criteria )	Set Criteria object

Private Methods

Method	Description
defaultName ( ) : string	Generates a unique name for this list object.
duplicateObject ( object $source ) : object	Copies the given object
getNextStart ( ) : integer	Returns the start element index of the next group of items from the list. Returns null if the list had no limit.
getPrevStart ( ) : integer	Returns the start element index of the previous group of items from the list. Returns null if the list had no limit.

Method Details

Property Details