UserStrategy Class Reference
Public Member Functions | |
| __construct () | |
| getNumberOfUserPerPage () | |
| getStrategy () | |
| setPageToDisplay ($page) | |
| getLimit () | |
| setFieldOrder ($fieldOrder) | |
| setOrder ($order) | |
| getOrder () | |
| setSearch ($name) | |
Data Fields | |
| const | ORDER_BY_NAME = "nom %order%, prenom %order%" |
| const | ORDER_BY_USERNAME = "username %order%" |
| const | ORDER_ASC = 'ASC' |
| const | ORDER_DESC = 'DESC' |
Protected Attributes | |
| $nameSearch = "" | |
| $order = self::ORDER_DESC | |
| $fieldOrder = self::ORDER_BY_NAME | |
| $numberOfUserPerPage | |
| $pageToDisplay = 1 | |
Detailed Description
Definition at line 21 of file userstrategy.lib.php.
Constructor & Destructor Documentation
| __construct | ( | ) |
Definition at line 39 of file userstrategy.lib.php.
Member Function Documentation
| getLimit | ( | ) |
return string the limit clause of the sql request
- Returns:
- string
Implements SelectorStrategy.
Definition at line 78 of file userstrategy.lib.php.
| getNumberOfUserPerPage | ( | ) |
return the number of user per page
- Returns:
- int number of user per page
Definition at line 49 of file userstrategy.lib.php.
| getOrder | ( | ) |
- See also:
- SelectorStrategy
Implements SelectorStrategy.
Definition at line 129 of file userstrategy.lib.php.
| getStrategy | ( | ) |
- See also:
- SelectorStrategy
Implements SelectorStrategy.
Definition at line 57 of file userstrategy.lib.php.
| setFieldOrder | ( | $ | fieldOrder | ) |
Set the filed order. accepter values: UserStrategy::ORDER_BY_NAME or UserStrategy::ORDER_BY_USERNAME
- Parameters:
-
string $fieldOrder
Definition at line 100 of file userstrategy.lib.php.
| setOrder | ( | $ | order | ) |
Set the order of search
- Parameters:
-
string $order: accpeted value UserStrategy::ORDER_DESC and UserStrategy::ORDER_ASC
Definition at line 117 of file userstrategy.lib.php.
| setPageToDisplay | ( | $ | page | ) |
Set the page to display. Begin by 1
- Parameters:
-
int $page page to display
Definition at line 73 of file userstrategy.lib.php.
| setSearch | ( | $ | name | ) |
Set the name to search
- Parameters:
-
string $name name search
Definition at line 141 of file userstrategy.lib.php.
Field Documentation
$fieldOrder = self::ORDER_BY_NAME [protected] |
Definition at line 32 of file userstrategy.lib.php.
$nameSearch = "" [protected] |
Definition at line 29 of file userstrategy.lib.php.
$numberOfUserPerPage [protected] |
Definition at line 34 of file userstrategy.lib.php.
$order = self::ORDER_DESC [protected] |
Definition at line 31 of file userstrategy.lib.php.
$pageToDisplay = 1 [protected] |
Definition at line 35 of file userstrategy.lib.php.
| const ORDER_ASC = 'ASC' |
Definition at line 26 of file userstrategy.lib.php.
| const ORDER_BY_NAME = "nom %order%, prenom %order%" |
Definition at line 23 of file userstrategy.lib.php.
| const ORDER_BY_USERNAME = "username %order%" |
Definition at line 24 of file userstrategy.lib.php.
| const ORDER_DESC = 'DESC' |
Definition at line 27 of file userstrategy.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/messaging/lib/userstrategy.lib.php
