You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
108 lines
3.2 KiB
108 lines
3.2 KiB
6 years ago
|
#############
|
||
|
|
User Variable
|
||
|
|
#############
|
||
|
|
|
||
|
|
|
||
|
|
***************
|
||
|
|
Class Reference
|
||
|
|
***************
|
||
|
|
|
||
|
|
.. php:class:: UserVariableModel
|
||
|
|
|
||
|
|
.. php:method:: find(int $userId, string $dataKey[, bool $system = null])
|
||
|
|
|
||
|
|
Find User Variable by userId, dataKey & optional system
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param string $dataKey: Key of variable
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: User variable value, or NULL if not exists
|
||
|
|
:rtype: string|null
|
||
|
|
|
||
|
|
.. php:method:: findAll(int $userId[, bool $system = null])
|
||
|
|
|
||
|
|
Find all user variables
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: Array with all user variables
|
||
|
|
:rtype: array
|
||
|
|
|
||
|
|
.. php:method:: save(int $userId, string $dataKey, string $dataValue[, bool $system = null])
|
||
|
|
|
||
|
|
Update/Insert User Variable
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param string $dataKey: Key of variable
|
||
|
|
:param string $dataValue: Value of variable
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: TRUE on success, FALSE on failure
|
||
|
|
:rtype: boolean
|
||
|
|
|
||
|
|
.. php:method:: insert(int $userId, string $dataKey, string $dataValue[, bool $system = null])
|
||
|
|
|
||
|
|
Insert User Variable
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param string $dataKey: Key of variable
|
||
|
|
:param string $dataValue: Value of variable
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: TRUE on success, FALSE on failure
|
||
|
|
:rtype: boolean
|
||
|
|
|
||
|
|
|
||
|
|
.. php:method:: update(int $userId, string $dataKey, string $dataValue[, bool $system = null])
|
||
|
|
|
||
|
|
Update User Variable
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param string $dataKey: Key of variable
|
||
|
|
:param string $dataValue: Value of variable
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: TRUE on success, FALSE on failure
|
||
|
|
:rtype: boolean
|
||
|
|
|
||
|
|
.. php:method:: delete(int $userId, string $dataKey[, bool $system = null])
|
||
|
|
|
||
|
|
Delete User Variable
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:param string $dataKey: Key of variable
|
||
|
|
:param boolean $system: Whether system variable
|
||
|
|
:returns: TRUE on success, FALSE on failure
|
||
|
|
:rtype: boolean
|
||
|
|
|
||
|
|
.. php:method:: deleteAllByUserId(int $userId)
|
||
|
|
|
||
|
|
Delete All User Variables by User Id
|
||
|
|
|
||
|
|
:param integer $userId: User id
|
||
|
|
:returns: TRUE on success, FALSE on failure
|
||
|
|
:rtype: boolean
|
||
|
|
|
||
|
|
.. php:method:: asArray()
|
||
|
|
|
||
|
|
Sets the return type of the results to be as an associative array.
|
||
|
|
|
||
|
|
:returns: UserSessionModel
|
||
|
|
:rtype: object
|
||
|
|
|
||
|
|
.. php:method:: asObject([string $class = 'object'])
|
||
|
|
|
||
|
|
Sets the return type to be of the specified type of object.
|
||
|
|
Defaults to a simple object, but can be any class that has
|
||
|
|
class vars with the same name as the table columns, or at least
|
||
|
|
allows them to be created.
|
||
|
|
|
||
|
|
:param string $class: Class name
|
||
|
|
:returns: UserSessionModel
|
||
|
|
:rtype: object
|
||
|
|
|
||
|
|
.. php:method:: first()
|
||
|
|
|
||
|
|
Returns the first row of the result set. Will take any previous
|
||
|
|
Query Builder calls into account when determing the result set.
|
||
|
|
|
||
|
|
:returns: The resulting row found during the search, or NULL if none found.
|
||
|
|
:rtype: array|object|null
|