XenForo Reference Guide for Developer
Back to top  

Model for users.

Models don't share that much, so most implementations will be adding methods onto this class. This class simply provides helper methods for common actions.

package XenForo_Users

 Methods

Constructor.

__construct() 
Inherited

Use create() statically unless you know what you're doing.

inherited_from \XenForo_Model::__construct()

Adds a join to the set of fetch options.

addFetchOptionJoin(array $fetchOptions, integer $join) 
Inherited

Join should be one of the constants.

inherited_from \XenForo_Model::addFetchOptionJoin()

Parameters

$fetchOptions

array

$join

integer

Adds the equivalent of a limit clause using position-based limits.

addPositionLimit(string $table, integer $limit, integer $offset, string $column) : string
Inherited

It no limit value is specified, nothing will be returned.

This must be added within a WHERE clause. If a clause is required, it will begin with "AND", so ensure there is a condition before it.

inherited_from \XenForo_Model::addPositionLimit()

Parameters

$table

string

Name of the table alias to prefix. May be blank for no table reference.

$limit

integer

Number of records to limit to; ignored if <= 0

$offset

integer

Offset from the start of the records. 0+

$column

string

Name of the column that is storing the position

Returns

stringPosition limit clause if needed

Inserts (or updates an existing) user group change set.

addUserGroupChange(integer $userId, string $key, string | array $addGroups) : boolean

Parameters

$userId

integer

$key

string

Unique identifier for change set

$addGroups

stringarray

Comma delimited string or array of user groups to add

Returns

booleanTrue on change success

Ensures that a valid cut-off operator is passed.

assertValidCutOffOperator(string $operator) 
Inherited
inherited_from \XenForo_Model::assertValidCutOffOperator()

Parameters

$operator

string

Bans a user or updates an existing ban.

ban(integer $userId, integer $endDate, $reason, $update, $errorKey, array $viewingUser) : boolean

Parameters

$userId

integer

ID of user to ban

$endDate

integer

Date at which ban will be lifted. Use XenForo_Model_User::PERMANENT_BAN for a permanent ban.

$reason

$update

$errorKey

$viewingUser

Returns

boolean

Determines if the user has permission to bypass users' privacy preferences, including online status and activity feed

canBypassUserPrivacy(string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$errorPhraseKey

string

$viewingUser

array

Returns

boolean

Determines if a user can report the specified content

canReportContent(string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$errorPhraseKey

string

$viewingUser

arraynull

Returns

boolean

Determines if the viewing user can start a conversation with the given user.

canStartConversationWithUser(array $user, string $errorPhraseKey, array $viewingUser) : boolean

Does not check standard conversation permissions.

Parameters

$user

array

$errorPhraseKey

string

$viewingUser

arraynull

Returns

boolean

Determines if the viewing user can start conversations in general.

canStartConversations(string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$errorPhraseKey

string

$viewingUser

arraynull

Returns

boolean

Determines if the viewing user can view IPs logged with posts, profile posts etc.

canViewIps(string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$errorPhraseKey

string

$viewingUser

arraynull

Returns

boolean

Determines if permissions are sufficient to view on the specified user's online status.

canViewUserOnlineStatus(array $user, string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$user

array

User being viewed

$errorPhraseKey

string

Returned by ref. Phrase key of more specific error

$viewingUser

arraynull

Viewing user ref

Returns

boolean

Determines if a user can view the warnings

canViewWarnings(string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$errorPhraseKey

string

$viewingUser

arraynull

Returns

boolean

Determines if permissions are sufficient to warn the given user.

canWarnUser(array $user, string $errorPhraseKey, array $viewingUser) : boolean

Parameters

$user

array

User being viewed

$errorPhraseKey

string

Returned by ref. Phrase key of more specific error

$viewingUser

arraynull

Viewing user ref

Returns

boolean

Checks to see if the input string *might* be an email address - contains '@' after its first character

couldBeEmail(String $email) : boolean

Parameters

$email

String

Returns

boolean

Determines whether or not the specified user may have the spam cleaner applied against them.

couldBeSpammer(array $user, string | array $errorKey) : boolean

Parameters

$user

array

$errorKey

stringarray

Error phrase key - may become an array if the phrase requires parameters

Returns

boolean

Gets the count of total users.

countTotalUsers() : integer

Returns

integer

Gets the count of users that match the specified conditions.

countUsers(array $conditions) : array

Parameters

$conditions

array

Returns

arrayFormat: [user id] => user info

Gets the count of users following the specified user.

countUsersFollowingUserId(integer $userId) : array

Parameters

$userId

integer

Returns

arrayFormat: [user id] => following user info

Factory method to get the named model.

create(string $class) : \XenForo_Model
InheritedStatic

The class must exist or be autoloadable or an exception will be thrown.

inherited_from \XenForo_Model::create()

Parameters

$class

string

Class to load

Returns

\XenForo_Model

Deletes the session activity record for the specified user / IP address

deleteSessionActivity(integer $userId, string $ip) 

Parameters

$userId

integer

$ip

string

Fetches results from the database with each row keyed according to preference.

fetchAllKeyed(string $sql, string $key, mixed $bind, string $nullPrefix) : array
Inherited

The 'key' parameter provides the column name with which to key the result. For example, calling fetchAllKeyed('SELECT item_id, title, date FROM table', 'item_id') would result in an array keyed by item_id: [$itemId] => array('item_id' => $itemId, 'title' => $title, 'date' => $date)

Note that the specified key must exist in the query result, or it will be ignored.

inherited_from \XenForo_Model::fetchAllKeyed()

Parameters

$sql

string

SQL to execute

$key

string

Column with which to key the results array

$bind

mixed

Parameters for the SQL

$nullPrefix

string

If the key is null, prefix the counter with this

Returns

array

Creates a new follower record for $userId following $followUserId(s)

follow(array $followUsers, boolean $dupeCheck, array $user) : string

Parameters

$followUsers

array

Users being followed

$dupeCheck

boolean

Check for and prevent duplicate followers

$user

array

User doing the following

Returns

stringComma-separated list of all users now being followed by $userId

Gets all users.

getAllUsers(array $fetchOptions) : array

Can be restricted to valid users only with the validOnly fetch option.

Parameters

$fetchOptions

array

User fetch options

Returns

arrayFormat: [user id] => user info

Gets a list of SQL conditions in the format for a clause.

getConditionsForClause(array $sqlConditions) : string
Inherited

This always returns a value that can be used in a clause such as WHERE.

inherited_from \XenForo_Model::getConditionsForClause()

Parameters

$sqlConditions

array

Returns

string

Gets the specified field from a content type, if specified for that type.

getContentTypeField(string $contentType, string $fieldName) : string | false
Inherited
inherited_from \XenForo_Model::getContentTypeField()

Parameters

$contentType

string

$fieldName

string

Returns

stringfalse

Gets the value of the specified field for each content type that has that field.

getContentTypesWithField(string $fieldName) : array
Inherited
inherited_from \XenForo_Model::getContentTypesWithField()

Parameters

$fieldName

string

Returns

arrayFormat: [content type] => field value

Gets the date of the earliest user registration

getEarliestRegistrationDate() : integer

Returns

integer

Fetches a single user-following-user record.

getFollowRecord(integer | array $userId, integer | array $followUserId) : array

Parameters

$userId

integerarray
  • the user doing the following

$followUserId

integerarray
  • the user being followed

Returns

array

Gets an array of all users being followed by the specified user

getFollowedUserProfiles($userId, integer $maxResults, string $orderBy) : array

Parameters

$userId

$maxResults

integer

(0 = all)

$orderBy

string

Returns

array

Generates the denormalized, comma-separated version of a user's following

getFollowingDenormalizedValue($userId) : string

Parameters

$userId

Returns

string

Returns a full user record based on an input user ID.

getFullUserById(integer $userId, array $fetchOptions) : array | false

Equivalent to calling getUserById including the FETCH_USER_FULL constanct

Parameters

$userId

integer

$fetchOptions

array

User fetch options

Returns

arrayfalse

Gets the latest (valid) user to join.

getLatestUser() : array | false

Returns

arrayfalse

Fetch the most recently-registered users

getLatestUsers(array $criteria, array $fetchOptions) : array

Parameters

$criteria

array

$fetchOptions

array

Returns

arrayUser records

Gets the specified model object from the cache.

getModelFromCache(string $class) : \XenForo_Model
Inherited

If it does not exist, it will be instantiated.

inherited_from \XenForo_Model::getModelFromCache()

Parameters

$class

string

Name of the class to load

Returns

\XenForo_Model

Fetch the most active users

getMostActiveUsers(array $criteria, array $fetchOptions) : array

Parameters

$criteria

array

$fetchOptions

array

Returns

arrayUser records

Gets the order by clause for an SQL query.

getOrderByClause(array $choices, array $fetchOptions, string $defaultOrderSql) : string
Inherited
inherited_from \XenForo_Model::getOrderByClause()

Parameters

$choices

array

$fetchOptions

array

$defaultOrderSql

string

Returns

stringOrder by clause or empty string

Fetches the logged registration IP addresses for the specified user, if available.

getRegistrationIps(integer $userId) : array

Parameters

$userId

integer

Returns

array[ register: string, account-confirmation: string ]

Returns the number of unread alerts belonging to a user - following fresh recalculation

getUnreadAlertsCount(integer $userId) : integer

Parameters

$userId

integer

Returns

integer

Returns an auth object based on an input userid

getUserAuthenticationObjectByUserId(integer $userId) : \XenForo_Authentication_Abstract | false

Parameters

$userId

integer

Userid

Returns

\XenForo_Authentication_Abstractfalse

Gets the user authentication record by user ID.

getUserAuthenticationRecordByUserId(integer $userId) : array | false

Parameters

$userId

integer

Returns

arrayfalse

Returns a user record based on an input email

getUserByEmail(string $email, array $fetchOptions) : array | false

Parameters

$email

string

$fetchOptions

array

User fetch options

Returns

arrayfalse

Gets the specified user by ID.

getUserById(integer $userId, array $fetchOptions) : array | false

Parameters

$userId

integer

$fetchOptions

array

User fetch options

Returns

arrayfalse

Returns a user record based on an input username

getUserByName(string $username, array $fetchOptions) : array | false

Parameters

$username

string

$fetchOptions

array

User fetch options

Returns

arrayfalse

Returns a user record based on an input username OR email

getUserByNameOrEmail(string $input, array $fetchOptions) : array | false

Parameters

$input

string

$fetchOptions

array

User fetch options

Returns

arrayfalse

Gets the user group change sets for the specified user.

getUserGroupChangesForUser(integer $userId) : array

Parameters

$userId

integer

Returns

array[change key] => comma list of group IDs

Fetches the user_id index from a user record

getUserIdFromUser($user) : integer
Static

Parameters

$user

Returns

integerUser ID

Returns an array containing the user ids found from the complete result given the range specified, along with the total number of users found.

getUserIdsInRange(integer $start, integer $limit) : array

Parameters

$start

integer

Find users with user_id greater than...

$limit

integer

Maximum users to return at once

Returns

array

Gets users that match the specified conditions.

getUsers(array $conditions, array $fetchOptions) : array

Parameters

$conditions

array

$fetchOptions

array

Returns

arrayFormat: [user id] => user info

Get users with specified user IDs.

getUsersByIds(array $userIds, array $fetchOptions) : array

Parameters

$userIds

array

$fetchOptions

array

Returns

arrayFormat: [user id] => user info

Return all users logged from a particular IP address

getUsersByIp(string $ip, array $fetchOptions) : array

Parameters

$ip

string

$fetchOptions

array

Returns

arrayFormat: [user id] => user info

Returns user records based on a list of usernames.

getUsersByNames(array $usernames, array $fetchOptions, array $invalidNames) : array

Parameters

$usernames

array

$fetchOptions

array

User fetch options

$invalidNames

array

Returns a list of usernames that could not be found

Returns

arrayFormat: [user id] => info

Gets the user information for all users following the specified user.

getUsersFollowingUserId(integer $userId, integer $maxResults, string $orderBy) : array

Parameters

$userId

integer

$maxResults

integer

(0 = all)

$orderBy

string

Returns

arrayFormat: [user id] => following user info

Get the visiting user information for a guest.

getVisitingGuestUser() : array

Returns

array

Gets the visiting user's information based on their user ID.

getVisitingUserById(integer $userId) : array

Parameters

$userId

integer

Returns

array

Returns whether or not the specified user is being followed by the follower

isFollowing(integer $userId, array $follower) : boolean

Parameters

$userId

integer

User being followed

$follower

array

User doing the following

Returns

boolean

Determines if a user is a member of a particular user group

isMemberOfUserGroup(array $user, integer | array $userGroupId, boolean $includeSecondaryGroups) : boolean

Parameters

$user

array

$userGroupId

integerarray

either a single user group ID or an array thereof

$includeSecondaryGroups

boolean

Also check secondary groups

Returns

boolean

Returns true if the specified user ID or user name is in the ignored (cache) of the given user.

isUserIgnored(array $user, integer | string $ignoredUser) : array | boolean

Parameters

$user

array

$ignoredUser

integerstring

User ID or user name

Returns

arrayboolean

isUserSuperAdmin() 

isUserSuperAdmin(array $user) 

Parameters

$user

Lifts the ban on the specified user

liftBan(integer $userId) : boolean

Parameters

$userId

integer

Returns

boolean

Applies a limit clause to the provided query if a limit value is specified.

limitQueryResults(string $query, integer $limit, integer $offset) : string
Inherited

If the limit value is 0 or less, no clause is applied.

inherited_from \XenForo_Model::limitQueryResults()

Parameters

$query

string

SQL query to run

$limit

integer

Number of records to limit to; ignored if <= 0

$offset

integer

Offset from the start of the records. 0+

Returns

stringQuery with limit applied if necessary

Logs a user in based on the raw value of the remember cookie.

loginUserByRememberCookie(string $userCookie) : false | integer

Parameters

$userCookie

string

Returns

falseinteger

Logs a user in based on their remember key from a cookie.

loginUserByRememberKeyFromCookie(integer $userId, string $rememberKey, array | false | null $auth) : boolean

Parameters

$userId

integer

$rememberKey

string

$auth

arrayfalsenull

User's auth record (retrieved if null)

Returns

boolean

Determines if the viewing user passes the specified privacy check.

passesPrivacyCheck(string $privacyRequirement, array $user, array $viewingUser) : \unknown_type

This must include the following status for the viewing user.

Parameters

$privacyRequirement

string

The required privacy: everyone, none, members, followed

$user

array

User info, including following status for viewing user

$viewingUser

arraynull

Viewing user ref

Returns

\unknown_type

Prepares the limit-related fetching options that can be applied to various queries.

prepareLimitFetchOptions(array $fetchOptions) : array
Inherited

Includes: limit, offset, page, and perPage.

inherited_from \XenForo_Model::prepareLimitFetchOptions()

Parameters

$fetchOptions

array

Unprepared options

Returns

arrayLimit options; keys: limit, offset

Prepares the remember key for use in a cookie (or for comparison against the cookie).

prepareRememberKeyForCookie(string $rememberKey) : string

Parameters

$rememberKey

string

Key from DB

Returns

string

Prepares state related fetch limits, based on the list of conditions.

prepareStateLimitFromConditions(array $fetchOptions, string $table, string $stateField, string $userField) : string
Inherited

Looks for keys "deleted" and "moderated".

inherited_from \XenForo_Model::prepareStateLimitFromConditions()

Parameters

$fetchOptions

array

$table

string

Name of the table to prefix the state and user fields with

$stateField

string

Name of the field that holds the state

$userField

string

Name of the field that holds the user ID

Returns

stringSQL condition to limit state

Prepares a user record for display.

prepareUser(array $user) : array

Note that this may be called on incomplete guest records.

Parameters

$user

array

User info

Returns

arrayPrepared user info

Prepares the data needed for the simple user card-like output.

prepareUserCard(array $user) : array

Parameters

$user

array

Returns

array

Prepares a batch of user cards.

prepareUserCards(array $users) : array

Parameters

$users

array

Returns

array

Prepares a set of conditions to select users against.

prepareUserConditions(array $conditions, array $fetchOptions) : string

Parameters

$conditions

array

List of conditions. (TODO: make list)

$fetchOptions

array

The fetch options that have been provided. May be edited if criteria requires.

Returns

stringCriteria as SQL for where clause

Prepares join-related fetch options.

prepareUserFetchOptions(array $fetchOptions) : array

Parameters

$fetchOptions

array

Returns

arrayContaining 'selectFields' and 'joinTables' keys.

Construct 'ORDER BY' clause

prepareUserOrderOptions(array $fetchOptions, string $defaultOrderSql) : string

Parameters

$fetchOptions

array

(uses 'order' key)

$defaultOrderSql

string

Default order SQL

Returns

string

Rebuilds the custom field cache for a specific user, using the canonical data.

rebuildCustomFieldCache(integer $userId) 

Parameters

$userId

integer

Rebuilds the user moderation queue cache.

rebuildUserModerationQueueCache() : array

Returns

arrayCache, [total, lastModifiedDate]

Compares an array of user IDs to be followed with the existing value and removes any duplicates to prevent duplicate key errors on insertion

removeDuplicateFollowUserIds(integer $userId, array $newUsers, string $existingUserIds) : array

Parameters

$userId

integer

$newUsers

array

(full user arrays)

$existingUserIds

string

'3,6,42,....'

Returns

array

Removes the specified user group change set.

removeUserGroupChange(integer $userId, string $key) : boolean

Parameters

$userId

integer

$key

string

Change set key

Returns

booleanTrue on success

removeUserGroupChangeLogByKey() 

removeUserGroupChangeLogByKey($key) 

Parameters

$key

Reset an entry or the entire local cache.

resetLocalCacheData($name) 
Inherited

This can be used if you know when some cached data has expired.

inherited_from \XenForo_Model::resetLocalCacheData()

Parameters

$name

Sets whether we're allowed to read values from the cache on a model-level.

setAllowCachedRead(boolean $allowCachedRead) 
Inherited

This may be controllable on an individual level basis, if the implementation allows it.

inherited_from \XenForo_Model::setAllowCachedRead()

Parameters

$allowCachedRead

boolean

Injects a local cache value.

setLocalCacheData(string $name, $value) 
Inherited

This should only be used if you know what you're doing or for testing purposes!

Note that you cannot get the existing data via the public interface. If you think you need the set data, use a new object. It defaults to empty. :)

inherited_from \XenForo_Model::setLocalCacheData()

Parameters

$name

string

$value

Sets the permission info from the specified user ID into an array of user info (likely for a visitor array).

setPermissionsFromUserId(array $userInfo, integer $permUserId) : array

Parameters

$userInfo

array

$permUserId

integer

Returns

arrayUser info with changed permissions

Sets the specified permissions (combination and permissions string) on visitor array.

setPermissionsOnVisitorArray(array $userinfo, $permissionCombinationId) : array

Defaults to setting guest permissions.

Parameters

$userinfo

array

Visitor record

$permissionCombinationId

Returns

arrayVisitor record with permissions

Sets the user remember cookie for the specified user ID.

setUserRememberCookie(integer $userId, array | false | null $auth) : boolean

Parameters

$userId

integer

$auth

arrayfalsenull

User's auth record (retrieved if null)

Returns

boolean

Standardizes a set of node permissions and a user ID to always have appropriate data.

standardizeNodePermissionsAndUserId(integer $nodeId, array | null $permissions, integer | null $userId) 
Inherited

If an invalid permission set or user ID is provided, the current visitor's will be used.

inherited_from \XenForo_Model::standardizeNodePermissionsAndUserId()

Parameters

$nodeId

integer

Node permissions are for

$permissions

arraynull

Permissions for node or null to use current visitor's permissions

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a permission combination and user ID to always have appropriate data.

standardizePermissionCombinationIdAndUserId(integer | null $permissionCombinationId, integer | null $userId) 
Inherited

If null, users current visitor's values.

inherited_from \XenForo_Model::standardizePermissionCombinationIdAndUserId()

Parameters

$permissionCombinationId

integernull

Permission combination ID or null to use current visitor

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a set of permissions and a user ID to always have appropriate data.

standardizePermissionsAndUserId(array | null $permissions, integer | null $userId) 
Inherited

If an invalid permission set or user ID is provided, the current visitor's will be used.

inherited_from \XenForo_Model::standardizePermissionsAndUserId()

Parameters

$permissions

arraynull

Global pPermissions or null to use current visitor's permissions

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a viewing user reference array.

standardizeViewingUserReference(array $viewingUser) 
Inherited

This array must contain all basic user info (preferably all user info) and include global permissions in a "permissions" key. If not an array or missing a user_id, the visitor's values will be used.

inherited_from \XenForo_Model::standardizeViewingUserReference()

Parameters

$viewingUser

arraynull

Standardizes the viewing user reference for the specific node.

standardizeViewingUserReferenceForNode(integer $nodeId, array $viewingUser, array $nodePermissions) 
Inherited
inherited_from \XenForo_Model::standardizeViewingUserReferenceForNode()

Parameters

$nodeId

integer

$viewingUser

arraynull

Viewing user; if null, use visitor

$nodePermissions

arraynull

Permissions for this node; if null, use visitor's

Deletes an existing follower record for $userId following $followUserId

unfollow(integer $followUserId, integer $userId) : string

Parameters

$followUserId

integer

User being followed

$userId

integer

User doing the following

Returns

stringComma-separated list of all users now being followed by $userId

Helper to unserialize permissions in a list of items.

unserializePermissionsInList(array $items, string $serializedKey, string $targetKey) : array
Inherited
inherited_from \XenForo_Model::unserializePermissionsInList()

Parameters

$items

array

List of items

$serializedKey

string

Key where serialized permissions are

$targetKey

string

Key where unserialized permissions will go

Returns

arrayList of items with permissions unserialized

Simple way to update user data fields.

update($user, array | string $field, mixed $value) : \XenForo_DataWriter_User

Parameters

$user

$field

arraystring

Either the name of a single field, or an array of field-name => field-value pairs

$value

mixed

If the previous parameter is a string, use this as the field value

Returns

\XenForo_DataWriter_User

Updates the denormalized, comma-separated version of a user's following.

updateFollowingDenormalizedValue($userId, string $following) : string

Will query for the value if it is not provided

Parameters

$userId

$following

string

Denormalized following value

Returns

string

Updates the session activity of a user.

updateSessionActivity(integer $userId, string $ip, string $controllerName, string $action, string $viewState, array $inputParams, integer | null $viewDate) 

Parameters

$userId

integer

$ip

string

IP of visiting user

$controllerName

string

Last controller class that was invoked

$action

string

Last action that was invoked

$viewState

string

Either "valid" or "error"

$inputParams

array

List of special input params, to include to help get more info on current activity

$viewDate

integernull

The timestamp of the last page view; defaults to now

Logs the given user in (as the visiting user).

validateAuthentication(string $nameOrEmail, string $password, string $error) : integer | false

Exceptions are thrown on errors.

Parameters

$nameOrEmail

string

User name or email address

$password

string

$error

string

Error string (by ref)

Returns

integerfalseUser ID auth'd as; false on failure

Applies a set of user group changes.

_applyUserGroupChanges(integer $userId, array $oldGroupStrings, array $newGroupStrings) : boolean

Parameters

$userId

integer

$oldGroupStrings

array

Array of comma-delimited strings of existing (accounted for) user group change sets

$newGroupStrings

array

Array of comma-delimited strings for new list of user group change sets

Returns

boolean

Helper method to get the cache object.

_getCache(boolean $forceCachedRead) : \Zend_Cache_Core | \Zend_Cache_Frontend | false
Inherited

If cache reads are disabled, this will return false.

inherited_from \XenForo_Model::_getCache()

Parameters

$forceCachedRead

boolean

If true, the global "allow cached read" value is ignored

Returns

\Zend_Cache_Core\Zend_Cache_Frontendfalse

Gets the data registry model.

_getDataRegistryModel() : \XenForo_Model_DataRegistry
Inherited
inherited_from \XenForo_Model::_getDataRegistryModel()

Returns

\XenForo_Model_DataRegistry

Helper method to get the database object.

_getDb() : \Zend_Db_Adapter_Abstract
Inherited
inherited_from \XenForo_Model::_getDb()

Returns

\Zend_Db_Adapter_Abstract

_getFieldModel() 

_getFieldModel() : \XenForo_Model_UserField

Returns

\XenForo_Model_UserField

_getIpModel() 

_getIpModel() : \XenForo_Model_Ip

Returns

\XenForo_Model_Ip

Gets the named entry from the local cache.

_getLocalCacheData(string $name) : mixed
Inherited
inherited_from \XenForo_Model::_getLocalCacheData()

Parameters

$name

string

Returns

mixed

_getUserProfileModel() 

_getUserProfileModel() : \XenForo_Model_UserProfile

Returns

\XenForo_Model_UserProfile

 Properties

 

$defaultAdminGroupId 
 

$defaultGuestGroupId 
 

$defaultModeratorGroupId 
 

$defaultRegisteredGroupId 
 

$guestPermissionCombinationId 
 

$_allowCachedRead : boolean
Inherited

If not, it should be retrieved from the source.

inherited_from \XenForo_Model::$$_allowCachedRead
 

$_cache : \Zend_Cache_Core | \Zend_Cache_Frontend
Inherited
inherited_from \XenForo_Model::$$_cache
 

$_db : \Zend_Db_Adapter_Abstract
Inherited
inherited_from \XenForo_Model::$$_db
 

$_ignoreCache : array
 

$_localCacheData : array
Inherited

This data is generally treated as canonical, even if {$_allowCachedRead} is false.

inherited_from \XenForo_Model::$$_localCacheData
 

$_modelCache : array
Inherited
inherited_from \XenForo_Model::$$_modelCache

 Constants

 

FETCH_LAST_ACTIVITY

FETCH_LAST_ACTIVITY 
 

Quick constant for fetching, profile, option, and privacy data.

FETCH_USER_FULL : integer
 

FETCH_USER_OPTION

FETCH_USER_OPTION 
 

FETCH_USER_PERMISSIONS

FETCH_USER_PERMISSIONS 
 

FETCH_USER_PRIVACY

FETCH_USER_PRIVACY 
   

Special value to use for a permanent ban

PERMANENT_BAN : integer