Configuring Storage
Configuring Storage
- public static function pushStorageNamespace($namespace)
- public static function popStorageNamespace()
- public static function getDefaultStorageNamespace()
- public static function getStorageNamespace()
- protected function establishLiveConnection($mode)
- public function getTableName()
- public function getApplicationName()
Availability
Availability
- public function attachAvailability($availability)
- public function getAwayUntil() — Get the timestamp the user is away until, if they are currently away.
- public function getAvailabilityCache() — Get cached availability, if present.
- public function writeAvailabilityCache($availability, $ttl) — Write to the availability cache.
Profile Image Cache
Profile Image Cache
No methods for this task.
Multi-Factor Authentication
Multi-Factor Authentication
- public function updateMultiFactorEnrollment() — Update the flag storing this user's enrollment in multi-factor auth.
- public function getIsEnrolledInMultiFactor() — Check if the user is enrolled in multi-factor authentication.
Managing Handles
Managing Handles
No methods for this task.
Settings
Settings
- public function compareUserSetting($key, $value) — Test if a given setting is set to a particular value.
- public function overrideTimezoneIdentifier($identifier) — Override the user's timezone identifier.
User Cache
User Cache
- public function attachRawCacheData($data)
- protected function requireCacheData($key)
- public function clearCacheData($key)
Other Methods
Other Methods
- public function setForcedStorageNamespace($namespace)
- private function newClusterConnection($application, $database, $mode)
- private function raiseImproperWrite($database)
- private function raiseImpossibleWrite($database)
- private function raiseUnconfigured($database)
- private function raiseUnreachable($database, $proxy)
- protected function getDatabaseName()
- public static function chunkSQL($fragments, $limit) — Break a list of escaped SQL statement fragments (e.g., VALUES lists for INSERT, previously built with @{function:qsprintf}) into chunks which will fit under the MySQL 'max_allowed_packet' limit.
- protected function assertAttached($property)
- protected function assertAttachedKey($value, $key)
- protected function detectEncodingForStorage($string)
- protected function getUTF8StringFromStorage($string, $encoding)
- protected function willReadData(&$data)
- protected function willWriteData(&$data)
- protected function readField($field)
- public function isUserActivated() — Is this a live account which has passed required approvals? Returns true if this is an enabled, verified (if required), approved (if required) account, and false otherwise.
- public function isResponsive() — Is this a user who we can reasonably expect to respond to requests?
- public function canEstablishWebSessions()
- public function canEstablishAPISessions()
- public function canEstablishSSHSessions()
- public function getIsStandardUser() — Returns `true` if this is a standard user who is logged in. Returns `false` for logged out, anonymous, or external users.
- protected function getConfiguration()
- public function generatePHID()
- public function getMonogram()
- public function isLoggedIn()
- public function saveWithoutIndex()
- public function save()
- public function attachSession($session)
- public function getSession()
- public function hasSession()
- public function hasHighSecuritySession()
- private function generateConduitCertificate()
- public function getUserProfile()
- public function attachUserProfile($profile)
- public function loadUserProfile()
- public function loadPrimaryEmailAddress()
- public function loadPrimaryEmail()
- public function getUserSetting($key)
- private function writeUserSettingCache($key, $value)
- public function getTranslation()
- public function getTimezoneIdentifier()
- public static function getGlobalSettingsCacheKey()
- private function loadGlobalSettings()
- public function getGender()
- public function updateNameTokens() — Populate the nametoken table, which used to fetch typeahead results. When a user types "linc", we want to match "Abraham Lincoln" from on-demand typeahead sources. To do this, we need a separate table of name fragments.
- public static function describeValidUsername()
- public static function validateUsername($username)
- public static function getDefaultProfileImageURI()
- public function getProfileImageURI()
- public function getUnreadNotificationCount()
- public function getUnreadMessageCount()
- public function getRecentBadgeAwards()
- public function getFullName()
- public function getTimeZone()
- public function getTimeZoneOffset()
- public function getTimeZoneOffsetInHours()
- public function formatShortDateTime($when, $now)
- public function __toString()
- public static function loadOneWithEmailAddress($address)
- public function getDefaultSpacePHID()
- public function hasConduitClusterToken()
- public function attachConduitClusterToken($token)
- public function getConduitClusterToken()
- public function getDisplayAvailability()
- public function getAvailabilityEventPHID()
- public function isOmnipotent() — Returns true if this user is omnipotent. Omnipotent users bypass all policy checks.
- public static function getOmnipotentUser() — Get an omnipotent user object for use in contexts where there is no acting user, notably daemons.
- public function getCacheFragment() — Get a scalar string identifying this user.
- public function attachBadgePHIDs($phids)
- public function getBadgePHIDs()
- public function getCSRFToken()
- public function validateCSRFToken($token)
- public function getAlternateCSRFString()
- public function attachAlternateCSRFString($string)
- private function newCSRFEngine()
- public function getCapabilities()
- public function getPolicy($capability)
- public function hasAutomaticCapability($capability, $viewer)
- public function describeAutomaticCapability($capability)
- public function getCustomFieldSpecificationForRole($role)
- public function getCustomFieldBaseClass()
- public function getCustomFields()
- public function attachCustomFields($fields)
- public function destroyObjectPermanently($engine)
- public function getSSHPublicKeyManagementURI($viewer)
- public function getSSHKeyDefaultName()
- public function getSSHKeyNotifyPHIDs()
- public function getApplicationTransactionEditor()
- public function getApplicationTransactionTemplate()
- public function newFulltextEngine()
- public function newFerretEngine()
- public function getFieldSpecificationsForConduit()
- public function getFieldValuesForConduit()
- public function getConduitSearchAttachments()
- public function setAllowInlineCacheGeneration($allow_cache_generation)
- public function getCSSValue($variable_key)
- public function newPasswordDigest($envelope, $password)
- public function newPasswordBlocklist($viewer, $engine)
handle
handle
- public function loadHandles($phids) — Get a @{class:PhabricatorHandleList} which benefits from this viewer's internal handle pool.
- public function renderHandle($phid) — Get a @{class:PHUIHandleView} for a single handle.
- public function renderHandleList($phids) — Get a @{class:PHUIHandleListView} for a list of handles.