user
extends expRecord
in package
This is the class expRecord
Tags
Table of Contents
- $attachable_items_to_save : mixed
- $classname : mixed
- $default_sort_direction : mixed
- $default_sort_field : mixed
- $do_not_validate : mixed
- $expeAlerts : mixed
- $get_assoc_for : mixed
- $get_attachable_for : mixed
- $grouping_sql : mixed
- $has_and_belongs_to_many : mixed
- $has_and_belongs_to_self : mixed
- $has_extended_fields : mixed
- $has_many : mixed
- $has_many_self : mixed
- $has_one : mixed
- $identifier : mixed
- $needs_approval : mixed
- $rank_by_field : mixed
- $supports_revisions : mixed
- $tablename : mixed
- $validate : mixed
- $validates : mixed
- $attachable_item_types : mixed
- $classinfo : mixed
- __construct() : mixed
- __get() : null
- Generic magic method
- __isset() : bool
- Generic magic method
- __set() : mixed
- Generic magic method We MUST create/set non-existing properties for Exponent code to work
- __unset() : mixed
- Generic magic method
- afterCreate() : mixed
- after creating item
- afterDelete() : mixed
- is run after deleting item, should delete associated items here if needed
- afterSave() : mixed
- after saving item
- afterUpdate() : mixed
- after updating item
- afterValidation() : mixed
- after validating item
- afterValidationOnCreate() : mixed
- after validating item during creation
- afterValidationOnUpdate() : mixed
- after validating item during update
- associateWith() : mixed
- get objects this item belongs to ??
- attachItem() : bool
- attach to item
- authenticate() : mixed
- beforeCreate() : mixed
- before creating item
- beforeDelete() : mixed
- is run before deleting item
- beforeSave() : mixed
- before saving item
- beforeUpdate() : mixed
- before updating item
- beforeValidation() : mixed
- before validating item
- beforeValidationOnCreate() : mixed
- before validating item during creation
- beforeValidationOnUpdate() : mixed
- before validating item during update
- build() : mixed
- Adds table fields as class properties to current "record" class.
- customerInfo() : mixed
- delete() : bool
- delete item
- displayname() : string
- name of model
- encryptPassword() : string
- Generate password hash
- find() : array<string|int, mixed>|int|object
- find an item or items
- findBy() : array<string|int, mixed>
- find an item by column
- findValue() : array<string|int, mixed>|bool
- find a value(s) by column
- findWhereAttachedTo() : array<string|int, mixed>
- this function finds models that have this attachable item attached
- getAllUsers() : array<string|int, mixed>
- exdoc Gets a list of all user accounts in the system. By giving different combinations of the two boolean arguments. three different lists of users can be returned. Returns a list of users, according to the two parameters passed in.
- getAssociatedObjects() : null
- get item's associated objects
- getAttachableItemTables() : array<string|int, mixed>
- used for import/export
- getEmailById() : string
- simple function to return the user's email
- getGroupMemberships() : mixed
- getPoster() : null|string
- return the item poster
- getRealIpAddr() : mixed
- getTimestamp() : mixed
- return the item timestamp
- getUserAttribution() : string
- simple function to return the user's attribution based on system setting
- getUserByEmail() : user
- exdoc This function pulls a user object from the subsystems storage mechanism, according to the email. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
- getUserById() : user
- exdoc This function pulls a user object from the subsystems storage mechanism according to its ID. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
- getUserByName() : user
- exdoc This function pulls a user object from the subsystems storage mechanism, according to the username. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
- getUserProfile() : mixed
- globalPerm() : bool
- This function determines a group global permission/restriction for this user
- isActingAdmin() : bool
- Is the user an acting admin and NOT a super admin?
- isAdmin() : bool
- Is the user either a super admin or an acting admin?
- isLoggedIn() : bool
- Is the user logged on
- isSearchable() : bool
- is model content searchable?
- isSuperAdmin() : bool
- Is the user a super admin?
- isSystemAdmin() : bool
- Is the user the system (root) admin?
- isTempUser() : mixed
- login() : mixed
- makeSefUrl() : mixed
- make an sef_url for item
- name() : string
- name of model for backwards compat with old modules
- refresh() : bool
- re-construct the item from the database
- rerank() : mixed
- rerank items
- save() : mixed
- save item
- saveAssociatedObjects() : mixed
- save associated objects
- setPassword() : mixed
- update() : mixed
- update item
- updateLastLogin() : mixed
- validate() : bool
- validate item sef_url
- checkForAttachableItems() : bool
- check for what objects may be attached
- getAttachableItems() : mixed
- get attached objects for this item
- getAssociatedObjectsForThisModel() : mixed
- gets associated objects for this model
- getsToolbar() : mixed
- makeManyToManyTablename() : string
- create a many to many table relationship
Properties
$attachable_items_to_save
public
mixed
$attachable_items_to_save
$classname
public
mixed
$classname
= ''
$default_sort_direction
public
mixed
$default_sort_direction
= ''
$default_sort_field
public
mixed
$default_sort_field
= ''
$do_not_validate
public
mixed
$do_not_validate
= array()
$expeAlerts
public
mixed
$expeAlerts
= array()
$get_assoc_for
public
mixed
$get_assoc_for
= array()
$get_attachable_for
public
mixed
$get_attachable_for
= array()
$grouping_sql
public
mixed
$grouping_sql
= ''
$has_and_belongs_to_many
public
mixed
$has_and_belongs_to_many
= array()
$has_and_belongs_to_self
public
mixed
$has_and_belongs_to_self
= array()
$has_extended_fields
public
mixed
$has_extended_fields
= array()
$has_many
public
mixed
$has_many
= array()
$has_many_self
public
mixed
$has_many_self
= array()
$has_one
public
mixed
$has_one
= array()
$identifier
public
mixed
$identifier
= 'id'
$needs_approval
public
mixed
$needs_approval
= \false
$rank_by_field
public
mixed
$rank_by_field
= ''
$supports_revisions
public
mixed
$supports_revisions
= \false
$tablename
public
mixed
$tablename
= ''
$validate
public
mixed
$validate
= array()
$validates
public
mixed
$validates
= array('presence_of' => array('firstname' => array('message' => 'First name is a required field.'), 'lastname' => array('message' => 'Last name is a required field.')), 'is_valid_email' => array('email' => array('message' => 'The email address does not appear to be valid')), 'uniqueness_of' => array('username' => array('message' => 'That username is already taken. Please use another username.')), 'length_of' => array('username' => array('length' => 3)))
$attachable_item_types
protected
mixed
$attachable_item_types
= array()
$classinfo
protected
mixed
$classinfo
= \null
Methods
__construct()
public
__construct([mixed $params = null ][, mixed $get_assoc = false ][, mixed $get_attached = false ]) : mixed
Parameters
- $params : mixed = null
- $get_assoc : mixed = false
- $get_attached : mixed = false
Return values
mixed —__get()
Generic magic method
public
__get( $property) : null
Parameters
Return values
null —__isset()
Generic magic method
public
__isset( $property) : bool
Parameters
Return values
bool —__set()
Generic magic method We MUST create/set non-existing properties for Exponent code to work
public
__set( $property, $value) : mixed
Parameters
Return values
mixed —__unset()
Generic magic method
public
__unset( $property) : mixed
Parameters
Return values
mixed —afterCreate()
after creating item
public
afterCreate() : mixed
Return values
mixed —afterDelete()
is run after deleting item, should delete associated items here if needed
public
afterDelete() : mixed
Return values
mixed —afterSave()
after saving item
public
afterSave() : mixed
Return values
mixed —afterUpdate()
after updating item
public
afterUpdate() : mixed
Return values
mixed —afterValidation()
after validating item
public
afterValidation() : mixed
Return values
mixed —afterValidationOnCreate()
after validating item during creation
public
afterValidationOnCreate() : mixed
Return values
mixed —afterValidationOnUpdate()
after validating item during update
public
afterValidationOnUpdate() : mixed
Return values
mixed —associateWith()
get objects this item belongs to ??
public
associateWith( $datatype, $id) : mixed
Type of associations has_and_belongs_to_many
Parameters
Return values
mixed —attachItem()
attach to item
public
attachItem( $item[, string $subtype = '' ][, bool $replace = true ]) : bool
Parameters
Return values
bool —authenticate()
public
authenticate(mixed $password) : mixed
Parameters
- $password : mixed
Return values
mixed —beforeCreate()
before creating item
public
beforeCreate() : mixed
Return values
mixed —beforeDelete()
is run before deleting item
public
beforeDelete() : mixed
Return values
mixed —beforeSave()
before saving item
public
beforeSave() : mixed
Return values
mixed —beforeUpdate()
before updating item
public
beforeUpdate() : mixed
Return values
mixed —beforeValidation()
before validating item
public
beforeValidation() : mixed
Return values
mixed —beforeValidationOnCreate()
before validating item during creation
public
beforeValidationOnCreate() : mixed
Return values
mixed —beforeValidationOnUpdate()
before validating item during update
public
beforeValidationOnUpdate() : mixed
Return values
mixed —build()
Adds table fields as class properties to current "record" class.
public
build([mixed $params = array() ]) : mixed
Loads Table schema data and creates new class properties based upon the fields in given table.
Additionally, if a record ID is given, that record is pulled and field values are also populated into class properties.
Parameters
- $params : mixed = array()
-
array or Object for table selection
Tags
Return values
mixed —customerInfo()
public
customerInfo() : mixed
Return values
mixed —delete()
delete item
public
delete([string $where = '' ]) : bool
Parameters
- $where : string = ''
Return values
bool —displayname()
name of model
public
static displayname() : string
Return values
string —encryptPassword()
Generate password hash
public
static encryptPassword( $password[, null $salt = null ]) : string
Parameters
Return values
string —find()
find an item or items
public
find([string $range = 'all' ][, null $where = null ][, null $order = null ][, null $limit = null ], int $limitstart[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>|int|object
Parameters
- $range : string = 'all'
-
// all, revisions, first, bytitle, count, bytag, bycat,
- $where : null = null
- $order : null = null
- $limit : null = null
- $limitstart : int
- $get_assoc : bool = true
- $get_attached : bool = true
- $except : array<string|int, mixed> = array()
- $cascade_except : bool = false
Return values
array<string|int, mixed>|int|object —findBy()
find an item by column
public
findBy( $column, $value[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>
Parameters
- $column :
- $value :
- $get_assoc : bool = true
- $get_attached : bool = true
- $except : array<string|int, mixed> = array()
- $cascade_except : bool = false
Return values
array<string|int, mixed> —findValue()
find a value(s) by column
public
findValue([string $range = 'all' ][, string $column = null ][, string $where = null ][, string $order = null ][, bool $distinct = false ]) : array<string|int, mixed>|bool
Parameters
- $range : string = 'all'
- $column : string = null
- $where : string = null
- $order : string = null
- $distinct : bool = false
Return values
array<string|int, mixed>|bool —findWhereAttachedTo()
this function finds models that have this attachable item attached
public
findWhereAttachedTo( $content_type) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getAllUsers()
exdoc Gets a list of all user accounts in the system. By giving different combinations of the two boolean arguments. three different lists of users can be returned. Returns a list of users, according to the two parameters passed in.
public
static getAllUsers([bool|int $allow_admin = 1 ][, bool|int $allow_normal = 1 ]) : array<string|int, mixed>
Parameters
- $allow_admin : bool|int = 1
-
Whether or not to include admin accounts in the returned list.
- $allow_normal : bool|int = 1
-
Whether or not to include normal accounts in the returned list.
Return values
array<string|int, mixed> —getAssociatedObjects()
get item's associated objects
public
getAssociatedObjects([object $obj = null ]) : null
Type of associations has_one has_many has_and_belongs_to_many
Parameters
- $obj : object = null
Return values
null —getAttachableItemTables()
used for import/export
public
getAttachableItemTables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEmailById()
simple function to return the user's email
public
static getEmailById(int $id) : string
Parameters
- $id : int
Tags
Return values
string —getGroupMemberships()
public
getGroupMemberships() : mixed
Return values
mixed —getPoster()
return the item poster
public
getPoster([null $display = null ]) : null|string
Parameters
- $display : null = null
Return values
null|string —getRealIpAddr()
public
getRealIpAddr() : mixed
Return values
mixed —getTimestamp()
return the item timestamp
public
getTimestamp(int $type) : mixed
Parameters
- $type : int
Return values
mixed —getUserAttribution()
simple function to return the user's attribution based on system setting
public
static getUserAttribution(int $id[, string $display = DISPLAY_ATTRIBUTION ]) : string
Parameters
- $id : int
- $display : string = DISPLAY_ATTRIBUTION
Tags
Return values
string —getUserByEmail()
exdoc This function pulls a user object from the subsystems storage mechanism, according to the email. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
public
static getUserByEmail(string $name) : user
Returns a basic user object, and null if no user was found.
This function does NOT perform user caching like the getUserById function does. Multiple calls to retrieve the same user result in multiple calls to the database.
Parameters
- $name : string
-
The username of the user account to retrieve.
Tags
Return values
user —getUserById()
exdoc This function pulls a user object from the subsystems storage mechanism according to its ID. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
public
static getUserById(int $uid) : user
Returns a basic user object, and null if no user was found.
This function uses the exclusive global variable $SYS_USERS_CACHE to cache previously retrieved user accounts, so that subsequent requests for the same user object do not result in another trip to the database engine.
Parameters
- $uid : int
-
The id of the user account to retrieve.
Tags
Return values
user —getUserByName()
exdoc This function pulls a user object from the subsystems storage mechanism, according to the username. For the default implementation, this is equivalent to a $db->selectObject() call, but it may not be the same for other implementations.
public
static getUserByName(string $name) : user
Returns a basic user object, and null if no user was found.
This function does NOT perform user caching like the getUserById function does. Multiple calls to retrieve the same user result in multiple calls to the database.
Parameters
- $name : string
-
The username of the user account to retrieve.
Tags
Return values
user —getUserProfile()
public
getUserProfile() : mixed
Return values
mixed —globalPerm()
This function determines a group global permission/restriction for this user
public
globalPerm( $perm) : bool
Parameters
Return values
bool —isActingAdmin()
Is the user an acting admin and NOT a super admin?
public
isActingAdmin() : bool
Return values
bool —isAdmin()
Is the user either a super admin or an acting admin?
public
isAdmin() : bool
Return values
bool —isLoggedIn()
Is the user logged on
public
isLoggedIn() : bool
Return values
bool —isSearchable()
is model content searchable?
public
static isSearchable() : bool
Return values
bool —isSuperAdmin()
Is the user a super admin?
public
isSuperAdmin() : bool
Return values
bool —isSystemAdmin()
Is the user the system (root) admin?
public
isSystemAdmin() : bool
Return values
bool —isTempUser()
public
isTempUser() : mixed
Return values
mixed —login()
public
static login(mixed $username, mixed $password) : mixed
Parameters
- $username : mixed
- $password : mixed
Return values
mixed —makeSefUrl()
make an sef_url for item
public
makeSefUrl() : mixed
Return values
mixed —name()
name of model for backwards compat with old modules
public
name() : string
Return values
string —refresh()
re-construct the item from the database
public
refresh() : bool
Tags
Return values
bool —rerank()
rerank items
public
rerank( $direction[, string $where = '' ]) : mixed
Parameters
Return values
mixed —save()
save item
public
save([mixed $overrideUsername = false ][, mixed $force_no_revisions = false ]) : mixed
Parameters
- $overrideUsername : mixed = false
- $force_no_revisions : mixed = false
Return values
mixed —saveAssociatedObjects()
save associated objects
public
saveAssociatedObjects() : mixed
Type of associations has_one
Return values
mixed —setPassword()
public
setPassword(mixed $pass1, mixed $pass2) : mixed
Parameters
- $pass1 : mixed
- $pass2 : mixed
Return values
mixed —update()
update item
public
update([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —updateLastLogin()
public
updateLastLogin() : mixed
Return values
mixed —validate()
validate item sef_url
public
validate() : bool
Return values
bool —checkForAttachableItems()
check for what objects may be attached
protected
checkForAttachableItems( $params) : bool
Parameters
Return values
bool —getAttachableItems()
get attached objects for this item
protected
getAttachableItems() : mixed
Return values
mixed —getAssociatedObjectsForThisModel()
gets associated objects for this model
private
getAssociatedObjectsForThisModel([array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : mixed
Type of associations has_extended_fields has_one has_many has_many_self has_and_belongs_to_many has_and_belongs_to_self
Parameters
- $except : array<string|int, mixed> = array()
- $cascade_except : bool = false
Return values
mixed —getsToolbar()
private
getsToolbar() : mixed
Return values
mixed —makeManyToManyTablename()
create a many to many table relationship
private
makeManyToManyTablename( $assoc_table) : string