PHP Class UsersList

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Mostra file Open project: sourcefabric/newscoop Class Usage Examples

Protected Methods

Method	Description
CreateList ( integer $p_start, integer $p_limit, array $p_parameters, &$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.

Method Details

CreateList() protected method

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.

protected CreateList ( integer $p_start, integer $p_limit, array $p_parameters, &$p_count ) : array
$p_start	integer
$p_limit	integer
$p_parameters	array
return	array

ProcessConstraints() protected method

Processes list constraints passed in an array.

protected ProcessConstraints ( array $p_constraints ) : array
$p_constraints	array
return	array

ProcessOrder() protected method

Processes order constraints passed in an array.

protected ProcessOrder ( array $p_order ) : array
$p_order	array
return	array

ProcessParameters() protected method

Processes the input parameters passed in an array; drops the invalid parameters and parameters with invalid values. Returns an array of valid parameters.

protected ProcessParameters ( array $p_parameters ) : array
$p_parameters	array
return	array