Description:
Class User to handle all user related task.
In first implementations, it will only do some little
things, like checking and setting passwords.
Requirements:
Methods
Constructor function for downwards compatibility
Item($sTable, $sPrimaryKey, $iLifetime)
Inherited
inherited_from |
\Item::Item() |
inherited_from |
\cApiUser::Item() |
Parameters
$sTable
$sPrimaryKey
$iLifetime
Calls constructor in base class.
__construct(array $aCfg, $oDb, $sUserId) : \ConUser
Parameters
$aCfg
array
$oDb
$sUserId
Exceptions
Returns
Filters the passed data using the functions defines in the _arrInFilters array.
_inFilter(mixed $mData) : mixed
Inherited
see |
\setFilters |
inherited_from |
\Item::_inFilter() |
inherited_from |
\cApiUser::_inFilter() |
Parameters
$mData
mixed
Data to filter
Returns
mixed
Filtered data
cApiUser()
cApiUser($mId)
Inherited
inherited_from |
\cApiUser::cApiUser() |
Parameters
$mId
Checks a given password against some predefined rules like minimum
character
length, required special character, etc.
checkPasswordMask(string $password) : int
InheritedStatic
..
This behaviour is configurable in global configuration $cfg['password'].
inherited_from |
\cApiUser::checkPasswordMask() |
Parameters
$password
string
The password check
Returns
int
One of defined PASS_* constants (PASS_OK if everything was
ok)
Deletes a custom property.
deleteProperty(string $sType, string $sName) : bool
Inherited
inherited_from |
\Item::deleteProperty() |
inherited_from |
\cApiUser::deleteProperty() |
Parameters
$sType
string
Specifies the type
$sName
string
Specifies the name
Returns
bool
Deletes a custom property by its id.
deletePropertyById(int $idprop) : bool
Inherited
inherited_from |
\Item::deletePropertyById() |
inherited_from |
\cApiUser::deletePropertyById() |
Parameters
$idprop
int
Id of property
Returns
bool
Deletes a user property from the table.
deleteUserProperty(string $type, string $name) : bool
Inherited
inherited_from |
\cApiUser::deleteUserProperty() |
Parameters
$type
string
Type (class, category etc) of property to retrieve
$name
string
Name of property to retrieve
Returns
bool
Encodes a passed password (uses md5 to generate a hash of it).
encodePassword(string $password) : string
Inherited
inherited_from |
\cApiUser::encodePassword() |
Parameters
$password
string
The password to encode
Returns
string
Encoded password
Escape string for using in SQL-Statement.
escape(string $sString) : string
Inherited
inherited_from |
\cItemBaseAbstract::escape() |
inherited_from |
\Item::escape() |
inherited_from |
\cApiUser::escape() |
Parameters
$sString
string
The string to escape
Returns
string
Escaped string
Wrapper for getField (less to type).
get(string $sField) : mixed
Inherited
inherited_from |
\Item::get() |
inherited_from |
\cApiUser::get() |
Parameters
$sField
string
Specifies the field to retrieve
Returns
mixed
Value of the field
Getter method to get user adress data
getAddressData() : array
Inherited
inherited_from |
\cApiUser::getAddressData() |
Returns
array
Address data array like:
$aAddress['street'], $aAddress['city'], $aAddress['country'],
$aAddress['zip']
Returns effective user name (if exists realname , otherwhise username)
getEffectiveName() : string
Inherited
inherited_from |
\cApiUser::getEffectiveName() |
Returns
string
Realname or username of user
Function returns effective perms for user including group rights as perm
string.
getEffectiveUserPerms() : string
Inherited
author |
Timo Trautmann |
inherited_from |
\cApiUser::getEffectiveUserPerms() |
Returns
string
Current users permissions
This static method provides a simple way to get error messages depending
on error code $iErrorCode, which is returned by checkPassword* methods.
getErrorString(int $iErrorCode) : string
InheritedStatic
inherited_from |
\cApiUser::getErrorString() |
Parameters
$iErrorCode
int
Returns
string
Gets the value of a specific field.
getField(string $sField) : mixed
Inherited
inherited_from |
\Item::getField() |
inherited_from |
\cApiUser::getField() |
Parameters
$sField
string
Specifies the field to retrieve
Returns
mixed
Value of the field
Returns group ids where the user is in.
getGroupIDsByUserID(string $userid) : array
Inherited
inherited_from |
\cApiUser::getGroupIDsByUserID() |
Parameters
$userid
string
Optional user id, uses id of loaded user by
default.
Returns
array
Returns group names where the user is in.
getGroupNamesByUserID(string $userid, bool $bAddDescription) : array
Inherited
inherited_from |
\cApiUser::getGroupNamesByUserID() |
Parameters
$userid
string
Optional user id, uses id of loaded user by
default.
$bAddDescription
bool
Flag to add description like "groupname
(description)"
Returns
array
Getter method to get user mail
getMail() : string
Inherited
inherited_from |
\cApiUser::getMail() |
Returns
string
Getter method to get user perm name
getPerms() : string
Inherited
inherited_from |
\cApiUser::getPerms() |
Returns
string
Returns list of user permissions.
getPermsArray() : array
Inherited
inherited_from |
\cApiUser::getPermsArray() |
Returns
array
Returns a custom property.
getProperty(string $sType, string $sName) : mixed
Inherited
inherited_from |
\Item::getProperty() |
inherited_from |
\cApiUser::getProperty() |
Parameters
$sType
string
Specifies the type
$sName
string
Specifies the name
Returns
mixed
Value of the given property or false
Getter method to get user realname
getRealName() : string
Inherited
inherited_from |
\cApiUser::getRealName() |
Returns
string
Realname of user
Getter method to get user tel number
getTelNumber() : string
Inherited
inherited_from |
\cApiUser::getTelNumber() |
Returns
string
getUseTiny()
getUseTiny()
Inherited
inherited_from |
\cApiUser::getUseTiny() |
Getter method to get user wysi
getUseWysi() : int
Inherited
inherited_from |
\cApiUser::getUseWysi() |
Returns
int
Returns user id, currently set.
getUserId() : string
Inherited
inherited_from |
\cApiUser::getUserId() |
Returns
string
Returns user name, currently set
getUserName() : string
Inherited
inherited_from |
\cApiUser::getUserName() |
Returns
string
Retrieves all available properties of the user.
getUserProperties(bool $beDownwardsCompatible) : array
Inherited
Works with a downwards compatible mode.
NOTE: Even if downwards compatible mode is enbabled by default, this mode
is deprecated...
inherited_from |
\cApiUser::getUserProperties() |
Parameters
$beDownwardsCompatible
bool
Flag to return downwards compatible
values
Returns
array
bool a array or false in downwards compatible mode,
otherwhise a array.
Return value in new mode is:
- $arr[iduserprop][name]
- $arr[iduserprop][type]
- $arr[iduserprop][value]
Return value in downwards compatible mode is:
- $arr[pos][name]
- $arr[pos][type]
Returns all user properties by type.
getUserPropertiesByType(string $type, bool $group) : array
Inherited
inherited_from |
\cApiUser::getUserPropertiesByType() |
Parameters
$type
string
Type (class, category etc) of the properties to
retrieve
$group
bool
Flag to retrieve in group properties. If enabled,
group properties
will be merged with user properties where the user poperties will
overwrite group properties
Returns
array
Assoziative properties array as follows:
- $arr[name] = value
Retrieves the effective user property.
getUserProperty(string $type, string $name, bool $group) : string
Inherited
inherited_from |
\cApiUser::getUserProperty() |
Parameters
$type
string
Type (class, category etc) for the property to
retrieve
$name
string
Name of the property to retrieve
$group
bool
Flag to search in groups
Returns
string
bool value of the retrieved property or false
Getter method to get user valid date from-to
getValidDateFrom() : string
Inherited
inherited_from |
\cApiUser::getValidDateFrom() |
Returns
string
Getter method to get user valid date from-to
getValidDateTo() : string
Inherited
inherited_from |
\cApiUser::getValidDateTo() |
Returns
string
Checks if a the item is already loaded.
isLoaded() : bool
Inherited
inherited_from |
\Item::isLoaded() |
inherited_from |
\cApiUser::isLoaded() |
Returns
bool
Loads an item by colum/field from the database.
loadBy(string $sField, mixed $mValue, bool $bSafe) : bool
Inherited
inherited_from |
\Item::loadBy() |
inherited_from |
\cApiUser::loadBy() |
Parameters
$sField
string
Specifies the field
$mValue
mixed
Specifies the value
$bSafe
bool
Use inFilter or not
Exceptions
\cException |
if more than one item has been found matching the given arguments |
Returns
bool
True if the load was successful
Loads an item by colums/fields from the database.
loadByMany(array $aAttributes, bool $bSafe) : bool
Inherited
inherited_from |
\Item::loadByMany() |
inherited_from |
\cApiUser::loadByMany() |
Parameters
$aAttributes
array
associative array with field / value pairs
$bSafe
bool
Use inFilter or not
Exceptions
\cException |
if more than one item could be found matching the given arguments |
Returns
bool
True if the load was successful
Loads an item by ID from the database.
loadByPrimaryKey(string $mValue) : bool
Inherited
inherited_from |
\Item::loadByPrimaryKey() |
inherited_from |
\cApiUser::loadByPrimaryKey() |
Parameters
$mValue
string
Specifies the primary key value
Returns
bool
True if the load was successful
Loads an item by it's recordset.
loadByRecordSet(array $aRecordSet)
Inherited
inherited_from |
\Item::loadByRecordSet() |
inherited_from |
\cApiUser::loadByRecordSet() |
Parameters
$aRecordSet
array
The recordset of the item
Loads a user from the database by its userID.
loadUserByUserID(string $userId) : bool
Inherited
inherited_from |
\cApiUser::loadUserByUserID() |
Parameters
$userId
string
Specifies the userID
Returns
bool
True if the load was successful
Loads a user entry by username.
loadUserByUsername(string $userName) : bool
Inherited
inherited_from |
\cApiUser::loadUserByUsername() |
Parameters
$userName
string
Specifies the username
Returns
bool
True if the load was successful
Registers a new callback.
register(string $event, mixed $callback, mixed $class) : void
InheritedStatic
Example:
cGenericDb::register(cGenericDb::CREATE_SUCCESS, 'itemCreateHandler', 'cApiArticle');
cGenericDb::register(cGenericDb::CREATE_SUCCESS, array('cCallbackHandler', 'executeCreateHandle'), 'cApiArticle');
inherited_from |
\cGenericDb::register() |
inherited_from |
\cItemBaseAbstract::register() |
inherited_from |
\Item::register() |
inherited_from |
\cApiUser::register() |
Parameters
$event
string
Callback event, must be a valid value of a cGenericDb event constant
$callback
mixed
Callback to register
$class
mixed
Class name for registering callback (can be string of array with names of the concrete Item classes)
Exceptions
Wrapper for store() for downwards compatibility
save() : bool
Inherited
inherited_from |
\cApiUser::save() |
Returns
bool
Return value of store()
This method saves the given password $password.
savePassword(string $password) : int
Inherited
The password
has to be checked, before it is set to the database. The resulting
integer value represents the result code.
Use the PASS_* constants to check what happens.
inherited_from |
\cApiUser::savePassword() |
Parameters
$password
string
Returns
int
bool PASS_* or false if saving fails
This function does update without password column to all columns of con_user table.
saveUser() : void
Shortcut to setField.
set(string $sField, string $mValue, bool $bSafe)
Inherited
inherited_from |
\Item::set() |
inherited_from |
\cApiUser::set() |
Parameters
$mValue
string
Value to set
$bSafe
bool
Flag to run defined inFilter on passed value
Setter method to set address data
setAddressData(string $sStreet, string $sCity, string $sZip, string $sCountry)
Inherited
inherited_from |
\cApiUser::setAddressData() |
Parameters
$sStreet
string
$sCity
string
$sZip
string
$sCountry
string
Sets value for city.
setCity(string $sCity)
Inherited
inherited_from |
\cApiUser::setCity() |
Parameters
$sCity
string
Sets value for country.
setCountry(string $sCountry)
Inherited
inherited_from |
\cApiUser::setCountry() |
Parameters
$sCountry
string
User defined field value setter.
setField(string $sField, string $mValue, bool $bSafe)
Inherited
inherited_from |
\cApiUser::setField() |
Parameters
$mValue
string
Value to set
$bSafe
bool
Flag to run defined inFilter on passed value
Define the filter functions used when data is being stored or retrieved
from the database.
setFilters(array $aInFilters, array $aOutFilters) : void
Inherited
Examples:
$obj->setFilters(array('addslashes'), array('stripslashes'));
$obj->setFilters(array('htmlencode', 'addslashes'), array('stripslashes', 'htmlencode'));
inherited_from |
\Item::setFilters() |
inherited_from |
\cApiUser::setFilters() |
Parameters
$aInFilters
array
Array with function names
$aOutFilters
array
Array with function names
Setter method to set user mail address
setMail(string $sMail)
Inherited
inherited_from |
\cApiUser::setMail() |
Parameters
$sMail
string
Checks password which has to be set and return PASS_* values (i.e.
setPassword(string $password) : int
Inherited
inherited_from |
\cApiUser::setPassword() |
Parameters
$password
string
Returns
int
Setter method to set perms
setPerms(array | string $perms)
Inherited
inherited_from |
\cApiUser::setPerms() |
Parameters
$perms
array
string
Sets a custom property.
setProperty(string $sType, string $sName, mixed $mValue) : bool
Inherited
inherited_from |
\Item::setProperty() |
inherited_from |
\cApiUser::setProperty() |
Parameters
$sType
string
Specifies the type
$sName
string
Specifies the name
$mValue
mixed
Specifies the value
Returns
bool
Setter method to set user real name
setRealName(string $sRealName)
Inherited
inherited_from |
\cApiUser::setRealName() |
Parameters
$sRealName
string
Sets value for street.
setStreet(string $sStreet)
Inherited
inherited_from |
\cApiUser::setStreet() |
Parameters
$sStreet
string
Setter method to set user tel number
setTelNumber(string $sTelNumber)
Inherited
inherited_from |
\cApiUser::setTelNumber() |
Parameters
$sTelNumber
string
setUseTiny()
setUseTiny($iUseTiny)
Inherited
inherited_from |
\cApiUser::setUseTiny() |
Parameters
$iUseTiny
Setter method to set wysi
setUseWysi(int $iUseWysi)
Inherited
inherited_from |
\cApiUser::setUseWysi() |
Parameters
$iUseWysi
int
User id settter.
setUserId(string $uid)
Inherited
NOTE: Setting the user id by this method will load the user model.
inherited_from |
\cApiUser::setUserId() |
Parameters
$uid
string
Sets up new user name.
setUserName(string $sUserName)
Inherited
inherited_from |
\cApiUser::setUserName() |
Parameters
$sUserName
string
Stores a property to the database
setUserProperty(string $type, string $name, string $value) : \cApiUserProperty
Inherited
inherited_from |
\cApiUser::setUserProperty() |
Parameters
$type
string
Type (class, category etc) for the property to
retrieve
$name
string
Name of the property to retrieve
$value
string
Value to insert
Returns
Setter method to set valid_from
setValidDateFrom(string $sValidateFrom)
Inherited
inherited_from |
\cApiUser::setValidDateFrom() |
Parameters
$sValidateFrom
string
TODO add type checks
Setter method to set valid_to
setValidDateTo(string $sValidateTo)
Inherited
inherited_from |
\cApiUser::setValidDateTo() |
Parameters
$sValidateTo
string
TODO add type check
Sets value for ZIP.
setZip(string $sZip)
Inherited
inherited_from |
\cApiUser::setZip() |
Parameters
$sZip
string
Stores the loaded and modified item to the database.
store() : bool
Inherited
inherited_from |
\Item::store() |
inherited_from |
\cApiUser::store() |
Returns
bool
Returns current item data as an assoziative array.
toArray() : array | false
Inherited
inherited_from |
\Item::toArray() |
inherited_from |
\cApiUser::toArray() |
Returns
array
false
Returns current item data as an object.
toObject() : \stdClass | false
Inherited
inherited_from |
\Item::toObject() |
inherited_from |
\cApiUser::toObject() |
Returns
Unregisters all callbacks for a specific event in a class.
unregister(string $event, mixed $class) : void
InheritedStatic
Example:
cGenericDb::unregister(cGenericDb::CREATE_SUCCESS, 'cApiArticle');
inherited_from |
\cGenericDb::unregister() |
inherited_from |
\cItemBaseAbstract::unregister() |
inherited_from |
\Item::unregister() |
inherited_from |
\cApiUser::unregister() |
Parameters
$event
string
Callback event, must be a valid value of a cGenericDb event constant
$class
mixed
Class name for unregistering callback (can be string of array with names of the concrete Item classes)
Exceptions
Checks if a user with the id $userId exists
userExists($userId) : bool
InheritedStatic
inherited_from |
\cApiUser::userExists() |
Parameters
$userId
Returns
bool
user exists or not
Checks if a username exists
usernameExists(string $username) : bool
InheritedStatic
inherited_from |
\cApiUser::usernameExists() |
Parameters
Returns
bool
username exists or not
Executes all callbacks for a specific event in a class.
_executeCallbacks(string $event, string $class, array $arguments) : void
Inherited
inherited_from |
\cGenericDb::_executeCallbacks() |
inherited_from |
\cItemBaseAbstract::_executeCallbacks() |
inherited_from |
\Item::_executeCallbacks() |
inherited_from |
\cApiUser::_executeCallbacks() |
Parameters
$event
string
Callback event, must be a valid value of a cGenericDb event constant
$class
string
Class name for executing callback
$arguments
array
Arguments to pass to the callback function
Exceptions
Returns properties instance, instantiates it if not done before.
_getPropertiesCollectionInstance() : \cApiPropertyCollection
Inherited
inherited_from |
\cItemBaseAbstract::_getPropertiesCollectionInstance() |
inherited_from |
\Item::_getPropertiesCollectionInstance() |
inherited_from |
\cApiUser::_getPropertiesCollectionInstance() |
Returns
Returns the second database instance, usable to run additional statements
without losing current query results.
_getSecondDBInstance() : \cDb
Inherited
inherited_from |
\cItemBaseAbstract::_getSecondDBInstance() |
inherited_from |
\Item::_getSecondDBInstance() |
inherited_from |
\cApiUser::_getSecondDBInstance() |
Returns
Loads an item by passed where clause from the database.
_loadByWhereClause(string $sWhere) : bool
Inherited
This function is expensive, since it executes allways a query to the database
to retrieve the primary key, even if the record set is aleady cached.
NOTE: Passed value has to be escaped before. This will not be done by this function.
inherited_from |
\Item::_loadByWhereClause() |
inherited_from |
\cApiUser::_loadByWhereClause() |
Parameters
$sWhere
string
The where clause like 'idart = 123 AND idlang = 1'
Exceptions
\cException |
if more than one item could be found matching the given where clause |
Returns
bool
True if the load was successful
Function which is called whenever an item is loaded.
_onLoad() : void
Inherited
Inherited classes should override this function if desired.
inherited_from |
\Item::_onLoad() |
inherited_from |
\cApiUser::_onLoad() |
Filters the passed data using the functions defines in the _arrOutFilters array.
_outFilter(mixed $mData) : mixed
Inherited
see |
\setFilters |
inherited_from |
\Item::_outFilter() |
inherited_from |
\cApiUser::_outFilter() |
Parameters
$mData
mixed
Data to filter
Returns
mixed
Filtered data
Properties
$primaryKey : string
Inherited
inherited_from |
\cItemBaseAbstract::$$primaryKey |
inherited_from |
\Item::$$primaryKey |
inherited_from |
\cApiUser::$$primaryKey |
$values : array
Inherited
inherited_from |
\Item::$$values |
inherited_from |
\cApiUser::$$values |
$virgin : bool
Inherited
If true, the object
is virgin and no operations on it except load-Functions are allowed.
inherited_from |
\cItemBaseAbstract::$$virgin |
inherited_from |
\Item::$$virgin |
inherited_from |
\cApiUser::$$virgin |
$_arrInFilters : array
Inherited
inherited_from |
\Item::$$_arrInFilters |
inherited_from |
\cApiUser::$$_arrInFilters |
$_arrOutFilters : array
Inherited
inherited_from |
\Item::$$_arrOutFilters |
inherited_from |
\cApiUser::$$_arrOutFilters |
$_className : string
Inherited
inherited_from |
\cItemBaseAbstract::$$_className |
inherited_from |
\Item::$$_className |
inherited_from |
\cApiUser::$$_className |
$_oCache : \cItemCache
Inherited
inherited_from |
\cItemBaseAbstract::$$_oCache |
inherited_from |
\Item::$$_oCache |
inherited_from |
\cApiUser::$$_oCache |
$_settings : array
Inherited
inherited_from |
\cItemBaseAbstract::$$_settings |
inherited_from |
\Item::$$_settings |
inherited_from |
\cApiUser::$$_settings |
$cache : array
Inherited
inherited_from |
\cItemBaseAbstract::$$cache |
inherited_from |
\Item::$$cache |
inherited_from |
\cApiUser::$$cache |
$db : \cDb
Inherited
inherited_from |
\cItemBaseAbstract::$$db |
inherited_from |
\Item::$$db |
inherited_from |
\cApiUser::$$db |
$lasterror : string
Inherited
inherited_from |
\cItemBaseAbstract::$$lasterror |
inherited_from |
\Item::$$lasterror |
inherited_from |
\cApiUser::$$lasterror |
$lifetime : int
Inherited
inherited_from |
\cItemBaseAbstract::$$lifetime |
inherited_from |
\Item::$$lifetime |
inherited_from |
\cApiUser::$$lifetime |
$modifiedValues : array
Inherited
inherited_from |
\Item::$$modifiedValues |
inherited_from |
\cApiUser::$$modifiedValues |
$oldPrimaryKey : string
Inherited
inherited_from |
\Item::$$oldPrimaryKey |
inherited_from |
\cApiUser::$$oldPrimaryKey |
$properties : \cApiPropertyCollection
Inherited
inherited_from |
\cItemBaseAbstract::$$properties |
inherited_from |
\Item::$$properties |
inherited_from |
\cApiUser::$$properties |
$secondDb : \cDb
Inherited
inherited_from |
\cItemBaseAbstract::$$secondDb |
inherited_from |
\Item::$$secondDb |
inherited_from |
\cApiUser::$$secondDb |
$table : string
Inherited
inherited_from |
\cItemBaseAbstract::$$table |
inherited_from |
\Item::$$table |
inherited_from |
\cApiUser::$$table |
$_callbacks : array
Inherited
inherited_from |
\cGenericDb::$$_callbacks |
inherited_from |
\cItemBaseAbstract::$$_callbacks |
inherited_from |
\Item::$$_callbacks |
inherited_from |
\cApiUser::$$_callbacks |
Constants
Callbacks are executed before a item is created.
CREATE_BEFORE
Inherited
Expected parameters for callback: none
inherited_from |
\cGenericDb::CREATE_BEFORE |
inherited_from |
\cItemBaseAbstract::CREATE_BEFORE |
inherited_from |
\Item::CREATE_BEFORE |
inherited_from |
\cApiUser::CREATE_BEFORE |
Callbacks are executed if item could not be created.
CREATE_FAILURE
Inherited
Expected parameters for callback: none
inherited_from |
\cGenericDb::CREATE_FAILURE |
inherited_from |
\cItemBaseAbstract::CREATE_FAILURE |
inherited_from |
\Item::CREATE_FAILURE |
inherited_from |
\cApiUser::CREATE_FAILURE |
Callbacks are executed if item could be created successfully.
CREATE_SUCCESS
Inherited
Expected parameters for callback: ID of created item
inherited_from |
\cGenericDb::CREATE_SUCCESS |
inherited_from |
\cItemBaseAbstract::CREATE_SUCCESS |
inherited_from |
\Item::CREATE_SUCCESS |
inherited_from |
\cApiUser::CREATE_SUCCESS |
Callbacks are executed before deleting an item.
DELETE_BEFORE
Inherited
Expected parameters for callback: ID of them item to delete
inherited_from |
\cGenericDb::DELETE_BEFORE |
inherited_from |
\cItemBaseAbstract::DELETE_BEFORE |
inherited_from |
\Item::DELETE_BEFORE |
inherited_from |
\cApiUser::DELETE_BEFORE |
Callbacks are executed if deletion of an item fails.
DELETE_FAILURE
Inherited
Expected parameters for callback: ID of them item to delete
inherited_from |
\cGenericDb::DELETE_FAILURE |
inherited_from |
\cItemBaseAbstract::DELETE_FAILURE |
inherited_from |
\Item::DELETE_FAILURE |
inherited_from |
\cApiUser::DELETE_FAILURE |
Callbacks are executed if item was deleted successfully.
DELETE_SUCCESS
Inherited
Expected parameters for callback: ID of them item to delete
inherited_from |
\cGenericDb::DELETE_SUCCESS |
inherited_from |
\cItemBaseAbstract::DELETE_SUCCESS |
inherited_from |
\Item::DELETE_SUCCESS |
inherited_from |
\cApiUser::DELETE_SUCCESS |
Exception code, which is used if an password is set to save
that is not valid.
EXCEPTION_PASSWORD_INVALID : int
Inherited
final |
|
inherited_from |
\cApiUser::EXCEPTION_PASSWORD_INVALID |
Exception code, which is used if you try to add an user
that already exists.
EXCEPTION_USERNAME_EXISTS : int
Inherited
final |
|
inherited_from |
\cApiUser::EXCEPTION_USERNAME_EXISTS |
This value will be used if no minimum length
for passwords are set via $cfg['password']['min_length']
MIN_PASS_LENGTH_DEFAULT : int
Inherited
final |
|
inherited_from |
\cApiUser::MIN_PASS_LENGTH_DEFAULT |
Given password is not complex enough
PASS_NOT_COMPLEX : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_COMPLEX |
Password does not contain enough different characters.
PASS_NOT_ENOUGH_DIFFERENT_CHARS : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_ENOUGH_DIFFERENT_CHARS |
Password does not contain enough mixed characters.
PASS_NOT_ENOUGH_MIXED_CHARS : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_ENOUGH_MIXED_CHARS |
Password does not contain enough numbers.
PASS_NOT_ENOUGH_NUMBERS : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_ENOUGH_NUMBERS |
Password does not contain enough symbols.
PASS_NOT_ENOUGH_SYMBOLS : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_ENOUGH_SYMBOLS |
Given password is not strong enough
PASS_NOT_STRONG : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_NOT_STRONG |
Password is ok and stored.
PASS_OK : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_OK |
Given password is to short
PASS_TO_SHORT : int
Inherited
final |
|
inherited_from |
\cApiUser::PASS_TO_SHORT |
Callbacks are executed before store process is executed.
STORE_BEFORE
Inherited
Expected parameters for callback: Item instance
inherited_from |
\cGenericDb::STORE_BEFORE |
inherited_from |
\cItemBaseAbstract::STORE_BEFORE |
inherited_from |
\Item::STORE_BEFORE |
inherited_from |
\cApiUser::STORE_BEFORE |
Callbacks are executed if store process failed.
STORE_FAILURE
Inherited
This is also likely to happen if query would not change anything in database!
Expected parameters for callback: Item instance
inherited_from |
\cGenericDb::STORE_FAILURE |
inherited_from |
\cItemBaseAbstract::STORE_FAILURE |
inherited_from |
\Item::STORE_FAILURE |
inherited_from |
\cApiUser::STORE_FAILURE |
Callbacks are executed if store process saved the values in the database.
STORE_SUCCESS
Inherited
Expected parameters for callback: Item instance
inherited_from |
\cGenericDb::STORE_SUCCESS |
inherited_from |
\cItemBaseAbstract::STORE_SUCCESS |
inherited_from |
\Item::STORE_SUCCESS |
inherited_from |
\cApiUser::STORE_SUCCESS |