MessageStrategy Class Reference
Public Member Functions | |
| __construct () | |
| setSearch ($search) | |
| setSearchStrategy ($searchStrategy) | |
| setOrder ($order) | |
| setNumberOfMessagePerPage ($numberOfPage) | |
| setPageToDisplay ($page) | |
| getNumberOfMessagePerPage () | |
| getLimit () | |
| getOrder () | |
Data Fields | |
| const | NO_FILTER = "" |
| const | SEARCH_STRATEGY_EXPRESSION = "expression" |
| const | SEARCH_STRATEGY_WORD = "word" |
| const | ORDER_DESC = "DESC" |
| const | ORDER_ASC = "ASC" |
Protected Attributes | |
| $search = "" | |
| $searchStrategy = self::SEARCH_STRATEGY_WORD | |
| $fieldOrder = self::ORDER_BY_DATE | |
| $order = self::ORDER_DESC | |
| $numberMessagePerPage | |
| $pageToDisplay = 1 | |
Detailed Description
Definition at line 20 of file messagestrategy.lib.php.
Constructor & Destructor Documentation
| __construct | ( | ) |
create a message stratagy
Reimplemented in InBoxStrategy, and TrashBoxStrategy.
Definition at line 43 of file messagestrategy.lib.php.
Member Function Documentation
| getLimit | ( | ) |
return the part of the sql request to the pagination
- Returns:
- string the part of the sql request to limit results
Implements SelectorStrategy.
Definition at line 123 of file messagestrategy.lib.php.
| getNumberOfMessagePerPage | ( | ) |
return the number of message per page
- Returns:
- int number of message per page
Definition at line 113 of file messagestrategy.lib.php.
| getOrder | ( | ) |
return the part of the SQL request to order the result
- Returns:
- string Part of the SQL request to order the result
Implements SelectorStrategy.
Definition at line 144 of file messagestrategy.lib.php.
| setNumberOfMessagePerPage | ( | $ | numberOfPage | ) |
Set the number of message per page (used for the desktop)
- Parameters:
-
int $numberOfPage number of message per page
Definition at line 93 of file messagestrategy.lib.php.
| setOrder | ( | $ | order | ) |
Set the order of search
- Parameters:
-
string $order: accpeted value MessageStrategy::ORDER_DESC and MessageStrategy::ORDER_ASC
Definition at line 79 of file messagestrategy.lib.php.
| setPageToDisplay | ( | $ | page | ) |
set the page to display
- Parameters:
-
int $page page to display
Definition at line 103 of file messagestrategy.lib.php.
| setSearch | ( | $ | search | ) |
set the string to search
- Parameters:
-
string $search string to search
Definition at line 53 of file messagestrategy.lib.php.
| setSearchStrategy | ( | $ | searchStrategy | ) |
set the search strategy MessageStrategy::SEARCH_STRATEGY_EXPRESSION to search the exact expression MessageStrategy::SEARCH_STRATEGY_WORD to search message contain at least 1 word of the string
- Parameters:
-
unknown_type $searchStrategy
Definition at line 65 of file messagestrategy.lib.php.
Field Documentation
$fieldOrder = self::ORDER_BY_DATE [protected] |
Definition at line 33 of file messagestrategy.lib.php.
$numberMessagePerPage [protected] |
Definition at line 36 of file messagestrategy.lib.php.
$order = self::ORDER_DESC [protected] |
Definition at line 34 of file messagestrategy.lib.php.
$pageToDisplay = 1 [protected] |
Definition at line 37 of file messagestrategy.lib.php.
$search = "" [protected] |
Definition at line 30 of file messagestrategy.lib.php.
$searchStrategy = self::SEARCH_STRATEGY_WORD [protected] |
Definition at line 31 of file messagestrategy.lib.php.
| const NO_FILTER = "" |
Definition at line 22 of file messagestrategy.lib.php.
| const ORDER_ASC = "ASC" |
Definition at line 28 of file messagestrategy.lib.php.
| const ORDER_DESC = "DESC" |
Definition at line 27 of file messagestrategy.lib.php.
| const SEARCH_STRATEGY_EXPRESSION = "expression" |
Definition at line 24 of file messagestrategy.lib.php.
| const SEARCH_STRATEGY_WORD = "word" |
Definition at line 25 of file messagestrategy.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/messaging/lib/selectorstrategy/messagestrategy.lib.php
