NOT_LOGGED
NOT_LOGGED
The abstract user class
The user class represents an user known by the current website as a permanent entity. This class is commonly inherited by a user class for registered users. But an user can be a Facebook user or a Site user for example.
Require core plugin
getEntityObject(string $objType, string $objID = null) : \Orpheus\EntityDescriptor\PermanentEntity
Get entity instance by type and id
| string | $objType | |
| string | $objID |
getEntityWhereclause(string $prefix = '') : string
Helper method to get whereclause string from an entity
| string | $prefix | The prefix for fields, e.g "table." (with dot) |
Helper method to get whereclause string from an entity. The related entity should have entity_type and entity_id fields.
getField(string $field) : \Orpheus\EntityDescriptor\FieldDescriptor
Get field descriptor from field name
| string | $field |
update(array $input, array<mixed,string> $fields, boolean $noEmptyWarning = true, \Orpheus\Publisher\PermanentObject\&int $errCount, \Orpheus\Publisher\PermanentObject\&int $successCount) : \Orpheus\Publisher\PermanentObject\1
Update this permanent object from input data array
| array | $input | The input data we will check and extract, used by children |
| array<mixed,string> | $fields | The array of fields to check |
| boolean | $noEmptyWarning | True to do not report warning for empty data (instead return 0). Default value is true. |
| \Orpheus\Publisher\PermanentObject\&int | $errCount | Output parameter for the number of occurred errors validating fields. |
| \Orpheus\Publisher\PermanentObject\&int | $successCount | Output parameter for the number of successes updating fields. |
in case of success, else 0.
getUpdateOperation(array $input, array<mixed,string> $fields) : \Orpheus\Publisher\Transaction\UpdateTransactionOperation
Get the update operation
| array | $input | The input data we will check and extract, used by children |
| array<mixed,string> | $fields | The array of fields to check |
extractUpdateQuery(array $input, \Orpheus\Publisher\PermanentObject\PermanentObject $object) : array
Extract an update query from this object
| array | $input | |
| \Orpheus\Publisher\PermanentObject\PermanentObject | $object |
getDeleteOperation() : \Orpheus\Publisher\Transaction\DeleteTransactionOperation
Get the delete operation for this object
onEdit(array $data, \Orpheus\Publisher\PermanentObject\PermanentObject $object)
Run for Object edit
| array | $data | the new data |
| \Orpheus\Publisher\PermanentObject\PermanentObject | $object | the old data |
onValidateInput(array $input, array $fields, \Orpheus\Publisher\PermanentObject\PermanentObject $object)
Callback when validating input
| array | $input | |
| array | $fields | |
| \Orpheus\Publisher\PermanentObject\PermanentObject | $object |
onSaved(array $data, integer|\Orpheus\Publisher\PermanentObject\PermanentObject $object)
Callbakc when object was saved
| array | $data | |
| integer|\Orpheus\Publisher\PermanentObject\PermanentObject | $object |
reload(string $field = null) : boolean
Reload fields from database
| string | $field | The field to reload, default is null (all fields). |
True if done
Update the current object's fields from database. If $field is not set, it reloads only one field else all fields. Also it removes the reloaded fields from the modified ones list.
setValue(string $key, mixed $value) : \Orpheus\Publisher\PermanentObject\PermanentObject
Set the value of a field
| string | $key | Name of the field to set |
| mixed | $value | New value of the field |
Set the field $key with the new $value.
object(\Orpheus\Publisher\PermanentObject\PermanentObject|integer $obj) : \Orpheus\Publisher\PermanentObject\PermanentObject
Get the object whatever we give to it
| \Orpheus\Publisher\PermanentObject\PermanentObject|integer | $obj |
get(array $options = NULL) : \Orpheus\SQLRequest\SQLSelectRequest|static|array<mixed,static>
Get some permanent objects
| array | $options | The options used to get the permanents object |
An array of array containing object's data
load(mixed|array<mixed,mixed> $id, boolean $nullable = true, boolean $usingCache = true) : \Orpheus\EntityDescriptor\User\PermanentObject
Load an user object
| mixed|array<mixed,mixed> | $id | The object ID to load or a valid array of the object's data |
| boolean | $nullable | True to silent errors row and return null |
| boolean | $usingCache | True to cache load and set cache, false to not cache |
The object
It tries to optimize by getting directly the logged user if he has the same ID.
getCacheStats() : \Orpheus\Publisher\PermanentObject\PermanentObject
Get cache stats
create(array $input = array(), array $fields = null, integer $errCount) : integer
Create a new permanent object
| array | $input | The input data we will check, extract and create the new object. |
| array | $fields | The array of fields to check. Default value is null. |
| integer | $errCount | Output parameter to get the number of found errors. Default value is 0 |
The ID of the new permanent object.
getCreateOperation(array $input, array<mixed,string> $fields) : \Orpheus\Publisher\Transaction\CreateTransactionOperation
Get the create operation
| array | $input | The input data we will check and extract, used by children |
| array<mixed,string> | $fields | The array of fields to check |
createAndGet(array $input = array(), array|null $fields = null, integer $errCount) : \Orpheus\Publisher\PermanentObject\PermanentObject
Create a new permanent object
| array | $input | The input data we will check, extract and create the new object. |
| array|null | $fields | The array of fields to check. Default value is null. |
| integer | $errCount | Output parameter to get the number of found errors. Default value is 0 |
The new permanent object
checkUserInput(array $input, array<mixed,string> $fields = null, \Orpheus\Publisher\PermanentObject\PermanentObject $ref = null, integer $errCount) : \Orpheus\Publisher\PermanentObject\The
Check user input
| array | $input | The user input data to check. |
| array<mixed,string> | $fields | The array of fields to check. Default value is null. |
| \Orpheus\Publisher\PermanentObject\PermanentObject | $ref | The referenced object (update only). Default value is null. |
| integer | $errCount | The resulting error count, as pointer. Output parameter. |
valid data.
Check if the class could generate a valid object from $input. The method could modify the user input to fix them but it must return the data. The data are passed through the validator, for different cases:
testUserInput( $input, $fields = null, $ref = null, $errCount)
Test user input
| $input | The new data to process. |
|
| $fields | The array of fields to check. Default value is null. |
|
| $ref | The referenced object (update only). Default value is null. |
|
| $errCount | The resulting error count, as pointer. Output parameter. |
getSQLAdapter() : \Orpheus\SQLAdapter\SQLAdapter
Get the SQL Adapter of this class
_text(\Orpheus\Publisher\PermanentObject\sting $text, array|string $values = array())
Translate text according to the object domain
| \Orpheus\Publisher\PermanentObject\sting | $text | The text to translate |
| array|string | $values | The values array to replace in text. Could be used as second parameter. |
checkPerm(integer|string $right) : boolean
Check permissions
| integer|string | $right | The right to compare, can be the right string to look for or an integer. |
True if this user has enough acess level.
Compare the accesslevel of this user to the incoming right. $right could be an int (accesslevel) or a string (right)
canAlter(\Orpheus\EntityDescriptor\User\AbstractUser $user) : boolean
Check if this user can alter data on the given user
| \Orpheus\EntityDescriptor\User\AbstractUser | $user | The user we want to edit |
True if this user has enough acess level to edit $user or he is altering himself
canDo(string $action, object $object = null) : boolean
Check if this user can affect data on the given user
| string | $action | The action to look for |
| object | $object | The object we want to edit |
True if this user has enough access level to alter $object (or he is altering himself)
userLogin(array $data, string $loginField = 'email') : \Orpheus\SQLRequest\SQLSelectRequest|\Orpheus\EntityDescriptor\User\AbstractUser|array<mixed,\Orpheus\Publisher\PermanentObject\static>
Logs in an user using data
| array | $data | |
| string | $loginField |
httpCreate() : \Orpheus\EntityDescriptor\User\User
Create user from HTTP authentication
object
getLoggedUser() : \Orpheus\EntityDescriptor\User\AbstractUser
Get logged user object
The user of the current client logged in
Get the user objectof the current logged client, or null.
loggedCanDo(string $action, \Orpheus\EntityDescriptor\User\AbstractUser $object = null) : boolean
Check if this user can do a restricted action
| string | $action | The action to look for |
| \Orpheus\EntityDescriptor\User\AbstractUser | $object | The object to edit if editing one or null. Default value is null |
True if this user can do this $action
checkCache() : \Orpheus\Publisher\PermanentObject\PermanentObject
Check if this object is cached and cache it