• Home
• ListObject

PHP Class ListObject

Mostra file Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property	Type	Description
$m_cacheKey
$m_columns	integer	The number of columns (for generating tables)
$m_constraints	array	The constraints array
$m_defaultIterator	object	The default iterator for the current object.
$m_defaultTTL
$m_limit	integer	The maximum number of objects in the list, 0 for no limit
$m_objects	array	The list of objects.
$m_order	array	The order constraints array
$m_parameters
$m_start	integer	The start element number from which to generate the list.
$m_totalCount	integer	The total number of elements in the list without the limits.

Public Methods

Method	Description
ParseConstraintsString ( string $p_constraintsString ) : array	Parses the constraints string and returns an array of words
__construct ( integer $p_start, string $p_parameters = [] )	constructor For blank lists the start element index ($p_start) is smaller than 0.
__get ( $p_property ) : mix	Overloaded method call to give access to the list properties.
defaultIterator ( ) : object	Returns the default iterator of this list.
defaultName ( ) : string	Generates a unique name for this list object.
getColumn ( integer $p_iterator = null )	Returns the column number for the given iterator
getColumns ( ) : integer	Returns the number of columns.
getConstraintsString ( ) : string	Returns the constraints string.
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.
getName ( ) : string	Returns the list name.
getOrderString ( ) : string	Returns the order string.
getRow ( integer $p_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 $p_id )	Sets the list identifier

Protected Methods

Method	Description
CreateList ( integer $p_start, integer $p_limit, array $p_parameters, integer &$p_count ) : array	Creates the list of objects. Sets the parameter $p_hasNextElements to 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.
ProcessConstraints ( array $p_constraints ) : array	Processes list constraints passed in an array.
ProcessOrder ( array $p_order ) : array	Processes order constraints passed in an array.
ProcessParameters ( array $p_parameters ) : array	Processes the input parameters passed in an array; drops the invalid parameters and parameters with invalid values. Returns an array of valid parameters.
getCacheKey ( )

Private Methods

Method	Description
duplicateObject ( object $p_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