AdminBoxStrategy Class Reference

Inheritance diagram for AdminBoxStrategy:

Public Member Functions
	__construct ()
	setStrategy ($strategy, $valuesList=array())
	getStrategy ()
	getLimit ()
	setFieldOrder ($fieldOrder)
	setOrder ($order)
	getOrder ()
	getNumberOfMessagePerPage ()
	setPageToDisplay ($page)
Data Fields
const	OLDER_THAN = "DATEDIFF(send_time,FROM_UNIXTIME(%date%)) < 0"
const	DATED_INTERVAL = "DATEDIFF(send_time,FROM_UNIXTIME(%date1%)) > 0 AND DATEDIFF(send_time,FROM_UNIXTIME(%date2%)) < 0"
const	SENT_BY = "U.username LIKE '%%name%%' OR U.nom LIKE '%%name%%' OR U.prenom LIKE '%%name%%' OR CONCAT(U.nom,' ',U.prenom) LIKE '%%name%%' OR CONCAT(U.prenom,' ',U.nom) LIKE '%%name%%'"
const	PLATFORM_MESSAGE = "R.user_id = 0"
const	FIELD_ORDER_NAME = "U.nom %order%, U.prenom %order%"
const	FIELD_ORDER_USERNAME = "U.username %order%"
const	FIELD_ORDER_DATE = "M.send_time %order%"
const	ORDER_DESC = "DESC"
const	ORDER_ASC = "ASC"
Protected Attributes
	$numberMessagePerPage
	$pageToDisplay = 1
	$order = self::ORDER_DESC
	$orderField = self::FIELD_ORDER_DATE
	$strategy = ""
	$valueList = array()

---

Detailed Description

Definition at line 21 of file adminboxstrategy.lib.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 43 of file adminboxstrategy.lib.php.

---

Member Function Documentation

getLimit

(

)

See also:

SelectorStrategy

Implements SelectorStrategy.

Definition at line 93 of file adminboxstrategy.lib.php.

getNumberOfMessagePerPage

(

)

Definition at line 154 of file adminboxstrategy.lib.php.

getOrder

(

)

See also:

SelectorStrategy

Implements SelectorStrategy.

Definition at line 146 of file adminboxstrategy.lib.php.

getStrategy

(

)

See also:

SelectorStrategy

Implements SelectorStrategy.

Definition at line 78 of file adminboxstrategy.lib.php.

setFieldOrder

(

$

fieldOrder

)

set the field order

Parameters:

string

$fieldOrder accepted value: AdminBoxStrategy::FIELD_ORDER_NAME AdminBoxStrategy::FIELD_ORDER_USERNAME AdminBoxStrategy::FIELD_ORDER_DATE

Definition at line 117 of file adminboxstrategy.lib.php.

setOrder

(

$

order

)

Set the order to apply

Parameters:

string

$order accepted value: AdminBoxStrategy::ORDER_DESC AdminBoxStrategy::ORDER_ASC

Definition at line 134 of file adminboxstrategy.lib.php.

setPageToDisplay

(

$

page

)

set the page to display

Parameters:

int

$page page to display

Definition at line 164 of file adminboxstrategy.lib.php.

setStrategy	(	$	strategy,
		$	valuesList = array()
	)

Set the strategy to apply to the message list

Parameters:

	string	$strategy accepted value: AdminBoxStrategy::OLDER_THAN argument: date AdminBoxStrategy::DATED_INTERVAL argument: date1 date 2 AdminBoxStrategy::SENT_BY argument: name AdminBoxStrategy::PLATFORM_MESSAGE
	array	$valuesList value of the strategy

Definition at line 59 of file adminboxstrategy.lib.php.

---

Field Documentation

$numberMessagePerPage [protected]

Definition at line 35 of file adminboxstrategy.lib.php.

$order = self::ORDER_DESC [protected]

Definition at line 37 of file adminboxstrategy.lib.php.

$orderField = self::FIELD_ORDER_DATE [protected]

Definition at line 38 of file adminboxstrategy.lib.php.

$pageToDisplay = 1 [protected]

Definition at line 36 of file adminboxstrategy.lib.php.

$strategy = "" [protected]

Definition at line 40 of file adminboxstrategy.lib.php.

$valueList = array() [protected]

Definition at line 41 of file adminboxstrategy.lib.php.

const DATED_INTERVAL = "DATEDIFF(send_time,FROM_UNIXTIME(%date1%)) > 0 AND DATEDIFF(send_time,FROM_UNIXTIME(%date2%)) < 0"

Definition at line 24 of file adminboxstrategy.lib.php.

const FIELD_ORDER_DATE = "M.send_time %order%"

Definition at line 30 of file adminboxstrategy.lib.php.

const FIELD_ORDER_NAME = "U.nom %order%, U.prenom %order%"

Definition at line 28 of file adminboxstrategy.lib.php.

const FIELD_ORDER_USERNAME = "U.username %order%"

Definition at line 29 of file adminboxstrategy.lib.php.

const OLDER_THAN = "DATEDIFF(send_time,FROM_UNIXTIME(%date%)) < 0"

Definition at line 23 of file adminboxstrategy.lib.php.

const ORDER_ASC = "ASC"

Definition at line 33 of file adminboxstrategy.lib.php.

const ORDER_DESC = "DESC"

Definition at line 32 of file adminboxstrategy.lib.php.

const PLATFORM_MESSAGE = "R.user_id = 0"

Definition at line 26 of file adminboxstrategy.lib.php.

const SENT_BY = "U.username LIKE '%%name%%' OR U.nom LIKE '%%name%%' OR U.prenom LIKE '%%name%%' OR CONCAT(U.nom,' ',U.prenom) LIKE '%%name%%' OR CONCAT(U.prenom,' ',U.nom) LIKE '%%name%%'"

Definition at line 25 of file adminboxstrategy.lib.php.

---

The documentation for this class was generated from the following file:

• claroline/claroline/messaging/lib/selectorstrategy/adminboxstrategy.lib.php