Library Group: auth

Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.

| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| Raven\Lib\Auth\Login2fa::dedupeKey() | method | Builds a dedupe key for normalized method rows. | string Stable dedupe key. |
| Raven\Lib\Auth\Login2fa::defaultLabelForType() | method | Returns the default human-facing label for one method type. | string Default label. |
| Raven\Lib\Auth\Login2fa::emailPool() | method | Returns the special email-method pool key for shared email-code challenges. | string Email pool key. |
| Raven\Lib\Auth\Login2fa::extractWebauthnCredentialId() | method | Extracts one WebAuthn credential id from a method key. | string Credential id when key is WebAuthn, otherwise empty string. |
| Raven\Lib\Auth\Login2fa::forEmailAddress() | method | Returns one canonical method key for an email address. | string Stable key for challenge method matching. |
| Raven\Lib\Auth\Login2fa::forRecoveryHash() | method | Returns one canonical method key for a stored recovery hash. | string Stable key for challenge method matching. |
| Raven\Lib\Auth\Login2fa::forRecoveryPhrase() | method | Returns one canonical method key for a recovery phrase. | string Stable key for challenge method matching. |
| Raven\Lib\Auth\Login2fa::forTotpSecret() | method | Returns one canonical method key for a TOTP secret. | string Stable key for challenge method matching. |
| Raven\Lib\Auth\Login2fa::forWebauthnCredentialId() | method | Returns one canonical method key for a WebAuthn credential id. | string Stable key for challenge method matching. |
| Raven\Lib\Auth\Login2fa::isEmailPool() | method | Returns whether the provided method key targets the email pool. | bool True when the key targets email pool handling. |
| Raven\Lib\Auth\Login2fa::isKnownType() | method | Returns whether the method type is known by Raven. | bool True when type is known. |
| Raven\Lib\Auth\Login2fa::isRecoveryPool() | method | Returns whether the provided method key targets the recovery pool. | bool True when the key targets recovery pool handling. |
| Raven\Lib\Auth\Login2fa::normalizeLabel() | method | Normalizes one method label with fallback and length constraints. | string Normalized method label. |
| Raven\Lib\Auth\Login2fa::normalizeStatus() | method | Normalizes one method status with type-aware fallback. | string Normalized status. |
| Raven\Lib\Auth\Login2fa::normalizeStored() | method | Normalizes stored/user-preference 2FA methods. | array<int, array<string, mixed>> |
| Raven\Lib\Auth\Login2fa::normalizeType() | method | Normalizes one method type. | string Lower-cased type slug. |
| Raven\Lib\Auth\Login2fa::recoveryPool() | method | Returns the special recovery-method pool key for shared recovery-code challenges. | string Recovery pool key. |
| Raven\Lib\Auth\Login2fa::statusLabel() | method | Returns one human-facing status label. | string Human-facing status label. |
| Raven\Lib\Auth\LoginAttempt::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\LoginAttempt::attempt() | method | Runs one full password-auth login attempt including lock checks and optional panel-access guard. | array{ |
| Raven\Lib\Auth\LoginChallenge::__construct() | method | Prepares the challenge workflow with its configuration and delivery dependencies. | void |
| Raven\Lib\Auth\LoginChallenge::buildViewState() | method | Builds the complete view-state payload for the 2FA challenge page. | array<string, mixed> View state payload, or an error array when the session is expired. |
| Raven\Lib\Auth\LoginChallenge::int() | method | (No summary.) | (No @return.) |
| Raven\Lib\Auth\LoginChallenge::preferredMethodKeyForChallenge() | method | Returns the preferred method key to auto-select when entering the challenge screen. | string\|null Method key to pre-select, or null when the user must choose manually. |
| Raven\Lib\Auth\LoginChallenge::selectMethod() | method | Handles a method-selection submission from the 2FA challenge picker. | array<string, mixed> Result payload with ok, status, and optional message. |
| Raven\Lib\Auth\LoginChallenge::verifyCodeChallenge() | method | Verifies one submitted 2FA code (TOTP, recovery, or email) for the pending session. | array<string, mixed> Result payload with ok, status, and optional message. |
| Raven\Lib\Auth\LoginChallenge::verifyWebauthn() | method | Verifies a WebAuthn assertion response for the pending session. | array<string, mixed> Result payload with ok, status, and http_status. |
| Raven\Lib\Auth\LoginChallenge::webauthnOptions() | method | Generates WebAuthn assertion options for the pending session and selected credential. | array<string, mixed> Result payload with ok, status, http_status, and optional payload. |
| Raven\Lib\Auth\LoginEmail::clearAllEmailChallenges() | method | Clears all pending email-code challenges from the session regardless of method key. | (No @return.) |
| Raven\Lib\Auth\LoginEmail::clearEmailCodeChallenge() | method | Clears one email-code challenge by method key, or clears all when key is empty. | (No @return.) |
| Raven\Lib\Auth\LoginEmail::issueChallenge() | method | Issues one email-code challenge for the pending 2FA session. | array{ |
| Raven\Lib\Auth\LoginEmail::pendingEmailCodeChallenge() | method | Returns a pending email-code challenge for the given user and method key, or null. | array{ |
| Raven\Lib\Auth\LoginEmail::sendCode() | method | Formats and sends the login email-code message to the recipient via Postmaster. | array{ok: bool, message?: string} Delivery result; message is set on failure. |
| Raven\Lib\Auth\LoginEmail::storeEmailCodeChallenge() | method | Stores one email-code challenge entry in the session for the given method key. | (No @return.) |
| Raven\Lib\Auth\LoginEmail::verifySubmittedCode() | method | Verifies one submitted email code against the stored pending 2FA challenge. | bool True when code matches an unexpired challenge, false otherwise. |
| Raven\Lib\Auth\LoginIdentifier::modeFromConfig() | method | Returns the configured login identifier mode for this site. | string Either email or username. |
| Raven\Lib\Auth\LoginIdentifier::normalizeForMode() | method | Normalizes a submitted login identifier according to the active identifier mode. | string\|null Normalized identifier, or null when the value is invalid for the mode. |
| Raven\Lib\Auth\LoginIdentifier::normalizeUsernameOrEmail() | method | Normalizes a raw value as a username when it passes username rules, or as an email otherwise. | string\|null Normalized username or email, or null when neither form is valid. |
| Raven\Lib\Auth\LoginUiState::clearAll() | method | Clears all login UI state for this surface including the post-login redirect. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearEmailInput() | method | Clears the stored email address input. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearPostLoginRedirect() | method | Clears the stored post-login redirect path. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearSelectedMethodKey() | method | Clears the stored selected 2FA method key. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearTwoFactorState() | method | Clears all 2FA challenge UI state for this surface without touching the redirect key. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearWebauthnChallenge() | method | Clears the stored WebAuthn challenge. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::clearWebauthnFailed() | method | Clears the WebAuthn failure flag. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::consumePostLoginRedirect() | method | Reads and clears the post-login redirect path in one operation. | string Stored redirect path, or empty string when none was set. |
| Raven\Lib\Auth\LoginUiState::emailInput() | method | Returns the stored email address input from the email-code challenge form. | string Trimmed email input, or empty string when absent. |
| Raven\Lib\Auth\LoginUiState::forceMethodPicker() | method | Returns true when the method picker should be forced to show on next render. | bool True when the force-picker flag is set. |
| Raven\Lib\Auth\LoginUiState::forPanel() | method | Returns a LoginUiState instance scoped to the panel login surface. | self Panel-scoped login UI state. |
| Raven\Lib\Auth\LoginUiState::forPublic() | method | Returns a LoginUiState instance scoped to the public login surface. | self Public-scoped login UI state. |
| Raven\Lib\Auth\LoginUiState::markWebauthnFailed() | method | Sets the WebAuthn failure flag so the UI can offer fallback options. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::postLoginRedirect() | method | Returns the stored post-login redirect path for this surface. | string Stored redirect path, or empty string when none is set. |
| Raven\Lib\Auth\LoginUiState::selectedMethodKey() | method | Returns the currently selected 2FA method key for this surface. | string Selected method key, or empty string when none is set. |
| Raven\Lib\Auth\LoginUiState::setForceMethodPicker() | method | Sets or clears the force-method-picker flag. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::storeEmailInput() | method | Stores the submitted email address input for the email-code challenge step. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::storePostLoginRedirect() | method | Stores a post-login redirect path in the session. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::storeSelectedMethodKey() | method | Stores the selected 2FA method key in the session. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::storeWebauthnChallenge() | method | Stores a WebAuthn challenge binary string in the session for later verification. | (No @return.) |
| Raven\Lib\Auth\LoginUiState::webauthnChallenge() | method | Returns the stored WebAuthn challenge binary string, or empty string when absent. | string Binary challenge string stored during options generation. |
| Raven\Lib\Auth\LoginUiState::webauthnFailed() | method | Returns true when the WebAuthn attempt for this surface is currently flagged as failed. | bool True when WebAuthn failure flag is set. |
| Raven\Lib\Auth\Membership::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\Membership::assignUserToGroupByName() | method | Adds a user to a named group if the group exists and the membership is not already present. | void |
| Raven\Lib\Auth\Membership::clearCaches() | method | Clears all request-local group membership cache entries. | void |
| Raven\Lib\Auth\Membership::groupsForUser() | method | Returns all group memberships for a user, with request-local caching. | array<int, array{id: int, name: string, slug: string, permissions: int, is_stock: int}> Group rows. |
| Raven\Lib\Auth\Membership::invalidateUser() | method | Removes one user's group membership from the request-local cache. | void |
| Raven\Lib\Auth\Panel\PermissionBase::allStockPanelBits() | method | Returns all individual stock panel route-level permission bits. | array<int, int> Flat list of every stock bit value. |
| Raven\Lib\Auth\Panel\PermissionBase::allStockPanelBitsMask() | method | Returns a combined bitmask covering all stock route-level panel bits. | int Bitmask of every stock route permission bit ORed together. |
| Raven\Lib\Auth\Panel\PermissionBase::canLoginPanel() | method | Checks dashboard-access permission from combined mask. | bool True when the mask includes the PANEL_LOGIN bit. |
| Raven\Lib\Auth\Panel\PermissionBase::canManageConfiguration() | method | Checks system-configuration capability from combined mask. | bool True when MANAGE_CONFIGURATION or any system route bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canManageContent() | method | Checks content-management capability from combined mask. | bool True when MANAGE_CONTENT or any content route bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canManageGroups() | method | Checks group-management capability from combined mask. | bool True when MANAGE_GROUPS or any groups route bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canManageTaxonomy() | method | Checks taxonomy-management capability from combined mask. | bool True when MANAGE_TAXONOMY or any taxonomy route bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canManageUsers() | method | Checks user-management capability from combined mask. | bool True when MANAGE_USERS or any users route bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canViewDisabledSite() | method | Checks disabled-site-view capability from combined mask. | bool True when VIEWDISABLEDSITE bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canViewPrivateSite() | method | Checks private-site-view capability from combined mask. | bool True when VIEWPRIVATESITE bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::canViewPublicSite() | method | Checks public-site-view capability from combined mask. | bool True when VIEWPUBLICSITE bit is set. |
| Raven\Lib\Auth\Panel\PermissionBase::contentPanelBits() | method | Returns content-management panel permission bits. | array<int, int> |
| Raven\Lib\Auth\Panel\PermissionBase::groupsPanelBits() | method | Returns groups-management panel permission bits. | array<int, int> |
| Raven\Lib\Auth\Panel\PermissionBase::hasAnyPanelPermissionBit() | method | Returns true when any bit in the supplied list is present in the mask. | bool True when at least one bit from $bits is set in $mask. |
| Raven\Lib\Auth\Panel\PermissionBase::hasPanelPermissionBit() | method | Returns true when one exact panel permission bit is present in the mask. | bool True when $bit is fully set in $mask. |
| Raven\Lib\Auth\Panel\PermissionBase::maskFromBits() | method | Combines a list of bits into a single bitmask value. | int Combined bitmask. |
| Raven\Lib\Auth\Panel\PermissionBase::normalizeMaskForPanelAccess() | method | Strips route-level panel bits from a mask when PANEL_LOGIN is not present. | int Corrected mask with invalid bit combinations removed. |
| Raven\Lib\Auth\Panel\PermissionBase::stockGroups() | method | Returns required stock groups. | array<int, array{name: string, slug: string, permissions: int, is_stock: int}> |
| Raven\Lib\Auth\Panel\PermissionBase::stockPanelRoutePermission() | method | Returns the stock permission row for one route key, or null when not found. | array{label: string, view: int, create?: int, edit?: int, delete?: int, uninstall?: int}\|null |
| Raven\Lib\Auth\Panel\PermissionBase::stockPanelRoutePermissions() | method | Returns the full stock panel route permission map keyed by route key. | array<string, array{label: string, view: int, create?: int, edit?: int, delete?: int, uninstall?: int}> |
| Raven\Lib\Auth\Panel\PermissionBase::systemPanelBits() | method | Returns system-management panel permission bits. | array<int, int> |
| Raven\Lib\Auth\Panel\PermissionBase::taxonomyPanelBits() | method | Returns taxonomy-management panel permission bits. | array<int, int> |
| Raven\Lib\Auth\Panel\PermissionBase::usersPanelBits() | method | Returns users-management panel permission bits. | array<int, int> |
| Raven\Lib\Auth\Panel\PermissionMask::clearCaches() | method | Clears all request-local user permission-mask cache entries. | void |
| Raven\Lib\Auth\Panel\PermissionMask::invalidateUser() | method | Invalidates one user's cached permission mask. | void |
| Raven\Lib\Auth\Panel\PermissionMask::maskForUser() | method | Returns the combined permission bitmask for a user based on their group memberships. | int Combined permission bitmask. |
| Raven\Lib\Auth\Panel\RolePolicy::isRouteDisabledRoleSlug() | method | Returns true when the role slug implies route-disabled access (guest, validating, or banned). | bool True when the slug should have route access disabled. |
| Raven\Lib\Auth\Panel\RolePolicy::isStockRoleSlug() | method | Returns true when the slug matches one of the reserved stock role slugs. | bool True when the slug is a stock role (admin, user, guest, validating, banned). |
| Raven\Lib\Auth\Panel\RolePolicy::normalizeSlug() | method | Returns a URL-safe lowercase slug from the raw input value. | string Normalized slug (max 160 chars, alphanumeric and hyphens only). |
| Raven\Lib\Auth\Panel\RolePolicy::normalizeStockRoleSettings() | method | Returns enforced route and permissions values for a stock role slug. | array{route: int, permissions: int} |
| Raven\Lib\Auth\Panel\Service::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\Panel\Service::assignUserToGroupByName() | method | Assigns a user to a named group idempotently. | void |
| Raven\Lib\Auth\Panel\Service::canAccessPanel() | method | Returns true when user belongs to a panel-capable group. | bool True when panel login is allowed. |
| Raven\Lib\Auth\Panel\Service::canManageConfiguration() | method | Returns true when user can manage system configuration. | bool True when configuration-management is allowed. |
| Raven\Lib\Auth\Panel\Service::canManageContent() | method | Returns true when user can manage content pages/media. | bool True when content-management is allowed. |
| Raven\Lib\Auth\Panel\Service::canManageGroups() | method | Returns true when user can edit groups. | bool True when groups-management is allowed. |
| Raven\Lib\Auth\Panel\Service::canManageTaxonomy() | method | Returns true when user can manage taxonomy. | bool True when taxonomy-management is allowed. |
| Raven\Lib\Auth\Panel\Service::canManageUsers() | method | Returns true when user can edit users. | bool True when users-management is allowed. |
| Raven\Lib\Auth\Panel\Service::clearCaches() | method | Clears request-local group and permission-mask caches. | void |
| Raven\Lib\Auth\Panel\Service::groupsForUser() | method | Returns one user's group memberships. | array<int, array{id: int, name: string, slug: string, permissions: int, is_stock: int}> Group memberships. |
| Raven\Lib\Auth\Panel\Service::hasAnyPanelPermissionBit() | method | Returns true when user has at least one panel permission bit in list. | bool True when any bit is granted. |
| Raven\Lib\Auth\Panel\Service::hasPanelPermissionBit() | method | Returns true when user has one exact panel permission bit. | bool True when the bit is granted. |
| Raven\Lib\Auth\Panel\Service::invalidateUser() | method | Invalidates request-local group and permission caches for one user. | void |
| Raven\Lib\Auth\Panel\Service::isAdmin() | method | Returns true when user belongs to the canonical admin group id. | bool True when user is an admin. |
| Raven\Lib\Auth\Panel\Service::panelPermissionMask() | method | Returns the combined panel permission bitmask for the current or specified user. | int Combined permission mask, or zero when unresolved. |
| Raven\Lib\Auth\Panel\Service::permissionMaskForUser() | method | Returns one user's combined permission mask from memberships. | int Combined permission mask. |
| Raven\Lib\Auth\Panel\SessionGuard::isGuestLoginEntryRequest() | method | Returns true when the request path is a guest-accessible panel login entry point. | bool True when the request is for the panel root, /login, or /login/2fa. |
| Raven\Lib\Auth\Panel\SessionGuard::panelIdentityFromSession() | method | Normalizes panel identity data from the session cache. | array{display_name: string, username: string, email: string} |
| Raven\Lib\Auth\Panel\SessionGuard::requirePanelLogin() | method | Enforces panel login, panel-access permission, and 2FA verification, then syncs session identity. | void |
| Raven\Lib\Auth\Panel\SessionGuard::string() | method | (No summary.) | (No @return.) |
| Raven\Lib\Auth\Panel\SessionGuard::syncPanelIdentityInSession() | method | Writes or clears the panel identity and capability flags in the session. | void |
| Raven\Lib\Auth\Public\PermissionBase::canViewDisabledSite() | method | Checks disabled-site-view capability from combined mask. | bool True when VIEWDISABLEDSITE bit is set. |
| Raven\Lib\Auth\Public\PermissionBase::canViewPrivateSite() | method | Checks private-site-view capability from combined mask. | bool True when VIEWPRIVATESITE bit is set. |
| Raven\Lib\Auth\Public\PermissionBase::canViewPublicSite() | method | Checks public-site-view capability from combined mask. | bool True when VIEWPUBLICSITE bit is set. |
| Raven\Lib\Auth\Public\PermissionBase::siteVisibilityBits() | method | Returns the public-route permission bits. | array<int, int> Bits used by public-route site visibility checks. |
| Raven\Lib\Auth\Public\PermissionMask::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\Public\PermissionMask::clearCaches() | method | Clears the request-local guest permission-mask cache entry. | void |
| Raven\Lib\Auth\Public\PermissionMask::maskForGuest() | method | Returns the permission mask for the guest group. | int Guest-group permission mask, or zero when missing. |
| Raven\Lib\Auth\Public\Service::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\Public\Service::canViewDisabledSite() | method | Returns true when authenticated user can access frontend while site mode is disabled. | bool True when disabled-site visibility is allowed. |
| Raven\Lib\Auth\Public\Service::canViewPrivateSite() | method | Returns true when authenticated user can access private-site mode routes. | bool True when private-site visibility is allowed. |
| Raven\Lib\Auth\Public\Service::canViewPublicSite() | method | Returns true when current visitor can access public-site mode routes. | bool True when public-site visibility is allowed. |
| Raven\Lib\Auth\Public\Service::clearCaches() | method | Clears request-local guest permission-mask cache. | void |
| Raven\Lib\Auth\Public\Service::permissionMaskForGuest() | method | Returns guest-group permission mask. | int Guest-group permission mask. |
| Raven\Lib\Auth\Public\SessionGuard::enforceSiteAvailability() | method | Enforces site visibility mode against the current auth state and permissions. | bool True when the request may proceed. |
| Raven\Lib\Auth\SessionCookie::resolveCookieDomain() | method | Resolves the session cookie domain from config, validated against the current request host. | string Validated cookie domain, or empty string to let the browser decide. |
| Raven\Lib\Auth\SessionCookie::resolveSessionName() | method | Resolves the session cookie name from config, applying prefix if valid. | string Validated session cookie name with optional prefix applied. |
| Raven\Lib\Auth\SessionCookie::startIfNeeded() | method | Starts a PHP session if one is not already active, applying Raven cookie policy. | void |
| Raven\Lib\Auth\SessionFlash::__construct() | method | (No summary.) | void |
| Raven\Lib\Auth\SessionFlash::pull() | method | Reads and removes a single string flash value. | string\|null Stored value, or null when no entry exists. |
| Raven\Lib\Auth\SessionFlash::pullList() | method | Reads and removes an ordered list of string flash values. | array<int, string>\|null Stored list, or null when no entry exists. |
| Raven\Lib\Auth\SessionFlash::put() | method | Stores a single string flash value under a key. | void |
| Raven\Lib\Auth\SessionFlash::putList() | method | Stores an ordered list of string flash values under a key. | void |
| Raven\Lib\Auth\SessionToken::get() | method | Fetches one token value from session storage. | string\|null Stored token string when present. |
| Raven\Lib\Auth\SessionToken::remove() | method | Removes one token value from session storage. | void |
| Raven\Lib\Auth\SessionToken::set() | method | Persists one token value into session storage. | void |
| Raven\Lib\Auth\ThrottleReturn::__construct() | method | Prepares the orchestrator with its DB-layer dependency. | void |
| Raven\Lib\Auth\ThrottleReturn::clear() | method | Clears one identifier+IP throttle bucket after a successful login. | void |
| Raven\Lib\Auth\ThrottleReturn::isLocked() | method | Returns true when the identifier+IP bucket is currently locked out. | bool True when the bucket remains locked for this request. |
| Raven\Lib\Auth\ThrottleReturn::record() | method | Records one failed login attempt and applies a lockout when the threshold is reached. | void |
| Raven\Lib\Auth\ThrottleUser::__construct() | method | Prepares the login-throttle scribe for bucket writes. | void |
| Raven\Lib\Auth\ThrottleUser::deleteRow() | method | Deletes one throttle bucket row by its hash. | void |
| Raven\Lib\Auth\ThrottleUser::loadRow() | method | Returns one throttle bucket row by its pre-computed hash, or null when absent. | array{firstfailed: int\|string, failurecount: int\|string, locked_until: int\|string}\|null Row on hit, null on miss. |
| Raven\Lib\Auth\ThrottleUser::pruneExpiredRows() | method | Removes stale unlocked throttle buckets outside the retention window. | void |
| Raven\Lib\Auth\ThrottleUser::upsertRow() | method | Inserts or updates one throttle bucket row. | void |

Parameter Details

Raven\Lib\Auth\Login2fa::dedupeKey()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $type Method type.
  • string $label Method label.
  • string $value Type-specific payload value.

Raven\Lib\Auth\Login2fa::defaultLabelForType()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $type Method type value.

Raven\Lib\Auth\Login2fa::emailPool()

  • File: private/lib/Auth/Login2fa.php
  • Params: (none)

Raven\Lib\Auth\Login2fa::extractWebauthnCredentialId()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $methodKey Candidate method key.

Raven\Lib\Auth\Login2fa::forEmailAddress()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $email Email address.

Raven\Lib\Auth\Login2fa::forRecoveryHash()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $recoveryHash Stored recovery hash.

Raven\Lib\Auth\Login2fa::forRecoveryPhrase()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $phrase Recovery phrase.

Raven\Lib\Auth\Login2fa::forTotpSecret()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $secret Raw or normalized TOTP secret.

Raven\Lib\Auth\Login2fa::forWebauthnCredentialId()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $credentialId Base64 credential id.

Raven\Lib\Auth\Login2fa::isEmailPool()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $methodKey Candidate method key.

Raven\Lib\Auth\Login2fa::isKnownType()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $type Candidate type value.

Raven\Lib\Auth\Login2fa::isRecoveryPool()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $methodKey Candidate method key.

Raven\Lib\Auth\Login2fa::normalizeLabel()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $label Candidate label.
  • string $type Method type.
  • int $maxLength Maximum label length.

Raven\Lib\Auth\Login2fa::normalizeStatus()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $status Candidate status.
  • string $type Method type.

Raven\Lib\Auth\Login2fa::normalizeStored()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • array&lt;int, mixed&gt; $methods

Raven\Lib\Auth\Login2fa::normalizeType()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $type Candidate type value.

Raven\Lib\Auth\Login2fa::recoveryPool()

  • File: private/lib/Auth/Login2fa.php
  • Params: (none)

Raven\Lib\Auth\Login2fa::statusLabel()

  • File: private/lib/Auth/Login2fa.php
  • Params:
  • string $status Normalized or raw status value.

Raven\Lib\Auth\LoginAttempt::__construct()

  • File: private/lib/Auth/LoginAttempt.php
  • Params:
  • Config $config Shared configuration service for login-throttle values and auth mode.
  • InputSanitizer $input Shared payload sanitizer for login form fields.
  • LoginIdentifier $identifierResolver Shared helper that resolves login identifier mode and normalization.

Raven\Lib\Auth\LoginAttempt::attempt()

  • File: private/lib/Auth/LoginAttempt.php
  • Params:
  • Gatekeeper $auth Shared authentication service used for credential verification and lock bookkeeping.
  • array&lt;string, mixed&gt; $post Submitted login payload containing identifier/email/username and password fields.
  • string $clientIpAddress Normalized client IP used for throttle tracking.
  • LoginUiState $uiState Login UI state storage used for 2FA method selection and cleanup paths.
  • callable(Gatekeeper, int): array{ok: bool, message?: string}|null $accessGuard Optional post-auth access gate for route families like panel login.

Raven\Lib\Auth\LoginChallenge::__construct()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Config $config Shared configuration service for site name, domain, and mail settings.
  • InputSanitizer $input Shared payload sanitizer for challenge form fields.
  • LoginEmail $loginEmail Shared email challenge session manager and delivery helper.
  • Postmaster $postmaster Shared mail delivery service for email-code dispatch.

Raven\Lib\Auth\LoginChallenge::buildViewState()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Gatekeeper $auth Shared authentication service.
  • LoginUiState $uiState Surface-specific login UI state.

Raven\Lib\Auth\LoginChallenge::int()

  • File: private/lib/Auth/LoginChallenge.php
  • Params: (none)

Raven\Lib\Auth\LoginChallenge::preferredMethodKeyForChallenge()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • array&lt;int, array&lt;string, mixed&gt;&gt; $interactiveMethods Interactive 2FA method rows for the pending session.

Raven\Lib\Auth\LoginChallenge::selectMethod()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Gatekeeper $auth Shared authentication service.
  • LoginUiState $uiState Surface-specific login UI state.
  • array&lt;string, mixed&gt; $post Submitted method-selection payload.

Raven\Lib\Auth\LoginChallenge::verifyCodeChallenge()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Gatekeeper $auth Shared authentication service.
  • LoginUiState $uiState Surface-specific login UI state.
  • array&lt;string, mixed&gt; $post Submitted challenge form payload.

Raven\Lib\Auth\LoginChallenge::verifyWebauthn()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Gatekeeper $auth Shared authentication service.
  • LoginUiState $uiState Surface-specific login UI state.
  • array&lt;string, mixed&gt; $post Submitted WebAuthn assertion payload.
  • array&lt;string, mixed&gt; $server Server context for WebAuthn origin resolution.

Raven\Lib\Auth\LoginChallenge::webauthnOptions()

  • File: private/lib/Auth/LoginChallenge.php
  • Params:
  • Gatekeeper $auth Shared authentication service.
  • LoginUiState $uiState Surface-specific login UI state.
  • array&lt;string, mixed&gt; $server Server context for WebAuthn origin resolution.

Raven\Lib\Auth\LoginEmail::clearAllEmailChallenges()

  • File: private/lib/Auth/LoginEmail.php
  • Params: (none)

Raven\Lib\Auth\LoginEmail::clearEmailCodeChallenge()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • string $methodKey Specific method key to clear; empty string removes all entries.

Raven\Lib\Auth\LoginEmail::issueChallenge()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • int|null $pendingUserId User id from the pending 2FA session (null = no session).
  • array&lt;int, array&lt;string, mixed&gt;&gt; $pendingMethods Active 2FA method rows for this session.
  • string $selectedMethodKey Method key or pool key chosen by the user.
  • int $ttlSeconds Challenge lifetime in seconds (clamped to 60–1800).
  • string $submittedEmail Submitted email address when using an email-pool method key.

Raven\Lib\Auth\LoginEmail::pendingEmailCodeChallenge()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • int $userId Pending 2FA user id.
  • string $methodKey Derived email method key to look up.

Raven\Lib\Auth\LoginEmail::sendCode()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • string $recipientEmail Destination email address.
  • string $code Eight-digit plaintext code to include in the message.
  • string $siteName Site display name for the subject line.
  • Postmaster $postmaster Shared delivery service that owns sender config and transport.
  • int $ttlSeconds Code lifetime in seconds, shown in the message body.

Raven\Lib\Auth\LoginEmail::storeEmailCodeChallenge()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • int $userId Pending 2FA user id.
  • string $methodKey Derived email method key (not a pool key).
  • string $email Target email address for this challenge.
  • string $codeHash bcrypt hash of the generated plaintext code.
  • int $issuedAt Unix timestamp when the challenge was generated.
  • int $expiresAt Unix timestamp when the challenge becomes invalid.

Raven\Lib\Auth\LoginEmail::verifySubmittedCode()

  • File: private/lib/Auth/LoginEmail.php
  • Params:
  • int|null $pendingUserId User id from the pending 2FA session.
  • string $selectedMethodKey Method key (or email-pool key) chosen by the user.
  • string $submittedCode Numeric code string submitted via the login form.
  • string $submittedEmail Email address submitted when using the email pool key.

Raven\Lib\Auth\LoginIdentifier::modeFromConfig()

  • File: private/lib/Auth/LoginIdentifier.php
  • Params:
  • Config $config Shared configuration service.

Raven\Lib\Auth\LoginIdentifier::normalizeForMode()

  • File: private/lib/Auth/LoginIdentifier.php
  • Params:
  • InputSanitizer $input Shared payload sanitizer.
  • string $mode Active identifier mode (\email\ or \username\).
  • string $rawIdentifier Raw value submitted by the user.

Raven\Lib\Auth\LoginIdentifier::normalizeUsernameOrEmail()

  • File: private/lib/Auth/LoginIdentifier.php
  • Params:
  • InputSanitizer $input Shared payload sanitizer.
  • string $rawValue Raw username or email submitted by the user.

Raven\Lib\Auth\LoginUiState::clearAll()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearEmailInput()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearPostLoginRedirect()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearSelectedMethodKey()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearTwoFactorState()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearWebauthnChallenge()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::clearWebauthnFailed()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::consumePostLoginRedirect()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::emailInput()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::forceMethodPicker()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::forPanel()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::forPublic()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::markWebauthnFailed()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::postLoginRedirect()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::selectedMethodKey()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::setForceMethodPicker()

  • File: private/lib/Auth/LoginUiState.php
  • Params:
  • bool $force True to show the picker on next render; false to clear the flag.

Raven\Lib\Auth\LoginUiState::storeEmailInput()

  • File: private/lib/Auth/LoginUiState.php
  • Params:
  • string $value Email address string; clears the key when empty.

Raven\Lib\Auth\LoginUiState::storePostLoginRedirect()

  • File: private/lib/Auth/LoginUiState.php
  • Params:
  • string $value Redirect path to persist; clears the key when empty.

Raven\Lib\Auth\LoginUiState::storeSelectedMethodKey()

  • File: private/lib/Auth/LoginUiState.php
  • Params:
  • string $value Method key to persist; clears the key when empty.

Raven\Lib\Auth\LoginUiState::storeWebauthnChallenge()

  • File: private/lib/Auth/LoginUiState.php
  • Params:
  • string $challenge Binary challenge string from the WebAuthn library.

Raven\Lib\Auth\LoginUiState::webauthnChallenge()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\LoginUiState::webauthnFailed()

  • File: private/lib/Auth/LoginUiState.php
  • Params: (none)

Raven\Lib\Auth\Membership::__construct()

  • File: private/lib/Auth/Membership.php
  • Params:
  • PDO $rvnDb Application database connection.
  • string $driver PDO driver name (&#039;sqlite&#039;, &#039;mysql&#039;, or &#039;pgsql&#039;).
  • string $prefix Table-name prefix for the application schema.

Raven\Lib\Auth\Membership::assignUserToGroupByName()

  • File: private/lib/Auth/Membership.php
  • Params:
  • int $userId User id to assign.
  • string $groupName Display name of the target group.

Raven\Lib\Auth\Membership::clearCaches()

  • File: private/lib/Auth/Membership.php
  • Params: (none)

Raven\Lib\Auth\Membership::groupsForUser()

  • File: private/lib/Auth/Membership.php
  • Params:
  • int $userId User id whose group memberships should be fetched.

Raven\Lib\Auth\Membership::invalidateUser()

  • File: private/lib/Auth/Membership.php
  • Params:
  • int $userId User id whose cached memberships should be discarded.

Raven\Lib\Auth\Panel\PermissionBase::allStockPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::allStockPanelBitsMask()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::canLoginPanel()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canManageConfiguration()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canManageContent()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canManageGroups()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canManageTaxonomy()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canManageUsers()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canViewDisabledSite()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canViewPrivateSite()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::canViewPublicSite()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Panel\PermissionBase::contentPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::groupsPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::hasAnyPanelPermissionBit()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.
  • array&lt;int, int&gt; $bits List of bits to test (any match returns true).

Raven\Lib\Auth\Panel\PermissionBase::hasPanelPermissionBit()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.
  • int $bit The single bit to test.

Raven\Lib\Auth\Panel\PermissionBase::maskFromBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • array&lt;int, int&gt; $bits List of individual bit values to OR together.

Raven\Lib\Auth\Panel\PermissionBase::normalizeMaskForPanelAccess()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • int $mask Raw permission mask to normalize.

Raven\Lib\Auth\Panel\PermissionBase::stockGroups()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::stockPanelRoutePermission()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params:
  • string $routeKey Lowercase panel route key (e.g. &#039;page&#039;, &#039;user&#039;).

Raven\Lib\Auth\Panel\PermissionBase::stockPanelRoutePermissions()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::systemPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::taxonomyPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionBase::usersPanelBits()

  • File: private/lib/Auth/Panel/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionMask::clearCaches()

  • File: private/lib/Auth/Panel/PermissionMask.php
  • Params: (none)

Raven\Lib\Auth\Panel\PermissionMask::invalidateUser()

  • File: private/lib/Auth/Panel/PermissionMask.php
  • Params:
  • int $userId User id whose mask cache should be invalidated.

Raven\Lib\Auth\Panel\PermissionMask::maskForUser()

  • File: private/lib/Auth/Panel/PermissionMask.php
  • Params:
  • int $userId User id to resolve.
  • array&lt;int, array{id: int, name: string, slug: string, permissions: int, is_stock: int}&gt; $groups Group rows for the user.

Raven\Lib\Auth\Panel\RolePolicy::isRouteDisabledRoleSlug()

  • File: private/lib/Auth/Panel/RolePolicy.php
  • Params:
  • string $slug Normalized group slug to check.

Raven\Lib\Auth\Panel\RolePolicy::isStockRoleSlug()

  • File: private/lib/Auth/Panel/RolePolicy.php
  • Params:
  • string $slug Normalized group slug to check.

Raven\Lib\Auth\Panel\RolePolicy::normalizeSlug()

  • File: private/lib/Auth/Panel/RolePolicy.php
  • Params:
  • string $value Raw group name or slug input.

Raven\Lib\Auth\Panel\RolePolicy::normalizeStockRoleSettings()

  • File: private/lib/Auth/Panel/RolePolicy.php
  • Params:
  • string $roleSlug The group slug to evaluate.
  • int $routeEnabled Caller-supplied route value (0 or 1).
  • int $mask Caller-supplied permissions bitmask.

Raven\Lib\Auth\Panel\Service::__construct()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • PermissionMask $permissionMaskService Panel permission-mask cache/computation service.
  • Membership $groupMembership Shared group-membership read/write service.
  • callable(): int|null $userIdResolver Callback returning current authenticated user id.

Raven\Lib\Auth\Panel\Service::assignUserToGroupByName()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int $userId User id.
  • string $groupName Group display name.

Raven\Lib\Auth\Panel\Service::canAccessPanel()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::canManageConfiguration()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::canManageContent()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::canManageGroups()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::canManageTaxonomy()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::canManageUsers()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::clearCaches()

  • File: private/lib/Auth/Panel/Service.php
  • Params: (none)

Raven\Lib\Auth\Panel\Service::groupsForUser()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int $userId User id.

Raven\Lib\Auth\Panel\Service::hasAnyPanelPermissionBit()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • array&lt;int, int&gt; $bits Candidate permission bits.
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::hasPanelPermissionBit()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int $bit Target permission bit.
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::invalidateUser()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int $userId User id.

Raven\Lib\Auth\Panel\Service::isAdmin()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::panelPermissionMask()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int|null $userId Optional user id; defaults to current session user.

Raven\Lib\Auth\Panel\Service::permissionMaskForUser()

  • File: private/lib/Auth/Panel/Service.php
  • Params:
  • int $userId User id.

Raven\Lib\Auth\Panel\SessionGuard::isGuestLoginEntryRequest()

  • File: private/lib/Auth/Panel/SessionGuard.php
  • Params:
  • array&lt;string, mixed&gt; $server $_SERVER superglobal.
  • string $panelPath Configured panel path prefix (e.g. &#039;/panel&#039;).

Raven\Lib\Auth\Panel\SessionGuard::panelIdentityFromSession()

  • File: private/lib/Auth/Panel/SessionGuard.php
  • Params:
  • mixed $raw Raw value of $_SESSION[&#039;rvn-panel-identity&#039;].

Raven\Lib\Auth\Panel\SessionGuard::requirePanelLogin()

  • File: private/lib/Auth/Panel/SessionGuard.php
  • Params:
  • Gatekeeper $auth Shared auth service.
  • bool $isGuestLoginEntryRequest True when the request path is a login/2fa entry page (should redirect rather than 404).
  • string $loginUrl Absolute URL of the panel login page.
  • string $twoFactorUrl Absolute URL of the panel 2FA challenge page.
  • callable(): void $renderPublicNotFound Callback that renders the public 404 and exits.

Raven\Lib\Auth\Panel\SessionGuard::string()

  • File: private/lib/Auth/Panel/SessionGuard.php
  • Params: (none)

Raven\Lib\Auth\Panel\SessionGuard::syncPanelIdentityInSession()

  • File: private/lib/Auth/Panel/SessionGuard.php
  • Params:
  • Gatekeeper $auth Shared auth service.

Raven\Lib\Auth\Public\PermissionBase::canViewDisabledSite()

  • File: private/lib/Auth/Public/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Public\PermissionBase::canViewPrivateSite()

  • File: private/lib/Auth/Public/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Public\PermissionBase::canViewPublicSite()

  • File: private/lib/Auth/Public/PermissionBase.php
  • Params:
  • int $mask Combined permission bitmask for the user.

Raven\Lib\Auth\Public\PermissionBase::siteVisibilityBits()

  • File: private/lib/Auth/Public/PermissionBase.php
  • Params: (none)

Raven\Lib\Auth\Public\PermissionMask::__construct()

  • File: private/lib/Auth/Public/PermissionMask.php
  • Params:
  • PDO $rvnDb Application database connection.
  • string $prefix Table-name prefix for the application schema.

Raven\Lib\Auth\Public\PermissionMask::clearCaches()

  • File: private/lib/Auth/Public/PermissionMask.php
  • Params: (none)

Raven\Lib\Auth\Public\PermissionMask::maskForGuest()

  • File: private/lib/Auth/Public/PermissionMask.php
  • Params: (none)

Raven\Lib\Auth\Public\Service::__construct()

  • File: private/lib/Auth/Public/Service.php
  • Params:
  • PermissionMask $permissionMaskService Guest permission-mask service.
  • PanelService $panelService Panel authorization service for authenticated user masks.
  • callable(): int|null $userIdResolver Callback returning current authenticated user id.
  • callable(): bool $isLoggedInResolver Callback returning current authentication state.

Raven\Lib\Auth\Public\Service::canViewDisabledSite()

  • File: private/lib/Auth/Public/Service.php
  • Params:
  • int|null $userId Optional explicit user id.

Raven\Lib\Auth\Public\Service::canViewPrivateSite()

  • File: private/lib/Auth/Public/Service.php
  • Params:
  • int|null $userId Optional explicit user id.

Raven\Lib\Auth\Public\Service::canViewPublicSite()

  • File: private/lib/Auth/Public/Service.php
  • Params:
  • int|null $userId Optional explicit user id.

Raven\Lib\Auth\Public\Service::clearCaches()

  • File: private/lib/Auth/Public/Service.php
  • Params: (none)

Raven\Lib\Auth\Public\Service::permissionMaskForGuest()

  • File: private/lib/Auth/Public/Service.php
  • Params: (none)

Raven\Lib\Auth\Public\SessionGuard::enforceSiteAvailability()

  • File: private/lib/Auth/Public/SessionGuard.php
  • Params:
  • Gatekeeper $auth Shared auth/session service.
  • string $visibilityMode Raw \site.visibility\ config value.
  • callable(): void $renderDisabled Callback that renders the disabled-site response.
  • callable(): void $renderDenied Callback that renders the denied response.

Raven\Lib\Auth\SessionCookie::resolveCookieDomain()

  • File: private/lib/Auth/SessionCookie.php
  • Params:
  • Config $config Runtime config for session.cookie.domain.
  • array&lt;string, mixed&gt; $server Server environment array (typically $_SERVER).

Raven\Lib\Auth\SessionCookie::resolveSessionName()

  • File: private/lib/Auth/SessionCookie.php
  • Params:
  • Config $config Runtime config for session.cookie.name and session.cookie.prefix.

Raven\Lib\Auth\SessionCookie::startIfNeeded()

  • File: private/lib/Auth/SessionCookie.php
  • Params:
  • Config $config Runtime config for session cookie settings.
  • string $root Absolute project root path; used to resolve the session save directory.
  • array&lt;string, mixed&gt; $server Server environment array (typically $_SERVER).

Raven\Lib\Auth\SessionFlash::__construct()

  • File: private/lib/Auth/SessionFlash.php
  • Params:
  • string $sessionKey Top-level key under which flash data is stored in $_SESSION.

Raven\Lib\Auth\SessionFlash::pull()

  • File: private/lib/Auth/SessionFlash.php
  • Params:
  • string $key Flash message key.

Raven\Lib\Auth\SessionFlash::pullList()

  • File: private/lib/Auth/SessionFlash.php
  • Params:
  • string $key Flash message key.

Raven\Lib\Auth\SessionFlash::put()

  • File: private/lib/Auth/SessionFlash.php
  • Params:
  • string $key Flash message key.
  • string $value Value to store.

Raven\Lib\Auth\SessionFlash::putList()

  • File: private/lib/Auth/SessionFlash.php
  • Params:
  • string $key Flash message key.
  • array&lt;int, string&gt; $values Values to store.

Raven\Lib\Auth\SessionToken::get()

  • File: private/lib/Auth/SessionToken.php
  • Params:
  • string $key Session key for the token value.

Raven\Lib\Auth\SessionToken::remove()

  • File: private/lib/Auth/SessionToken.php
  • Params:
  • string $key Session key for the token value.

Raven\Lib\Auth\SessionToken::set()

  • File: private/lib/Auth/SessionToken.php
  • Params:
  • string $key Session key for the token value.
  • string $value Token string to persist.

Raven\Lib\Auth\ThrottleReturn::__construct()

  • File: private/lib/Auth/ThrottleReturn.php
  • Params:
  • ThrottleUser $throttle DB-layer throttle bucket accessor.

Raven\Lib\Auth\ThrottleReturn::clear()

  • File: private/lib/Auth/ThrottleReturn.php
  • Params:
  • string $username Login identifier submitted by the user.
  • string $ipAddress Client IP address for the bucket key.

Raven\Lib\Auth\ThrottleReturn::isLocked()

  • File: private/lib/Auth/ThrottleReturn.php
  • Params:
  • string $username Login identifier submitted by the user.
  • string $ipAddress Client IP address for the bucket key.
  • int $windowSeconds Active failure-window length in seconds.

Raven\Lib\Auth\ThrottleReturn::record()

  • File: private/lib/Auth/ThrottleReturn.php
  • Params:
  • string $username Login identifier submitted by the user.
  • string $ipAddress Client IP address for the bucket key.
  • int $maxAttempts Failure threshold before lockout starts.
  • int $windowSeconds Active failure-window length in seconds.
  • int $lockSeconds Lockout duration in seconds after the threshold is reached.

Raven\Lib\Auth\ThrottleUser::__construct()

  • File: private/lib/Auth/ThrottleUser.php
  • Params:
  • PDO $rvnDb App-database connection for \auth_failures\ writes.
  • string $driver Active PDO driver name used for conflict syntax.
  • string $prefix Configured table prefix before sanitization.

Raven\Lib\Auth\ThrottleUser::deleteRow()

  • File: private/lib/Auth/ThrottleUser.php
  • Params:
  • string $bucketHash Stable bucket hash derived from identifier + IP.

Raven\Lib\Auth\ThrottleUser::loadRow()

  • File: private/lib/Auth/ThrottleUser.php
  • Params:
  • string $bucketHash SHA-256 bucket key for the identifier+IP pair.

Raven\Lib\Auth\ThrottleUser::pruneExpiredRows()

  • File: private/lib/Auth/ThrottleUser.php
  • Params:
  • int $windowSeconds Active failure-window length in seconds.
  • int $lockSeconds Active lockout duration in seconds.

Raven\Lib\Auth\ThrottleUser::upsertRow()

  • File: private/lib/Auth/ThrottleUser.php
  • Params:
  • string $bucketHash Stable bucket hash derived from identifier + IP.
  • string $normalizedIdentifier Normalized identifier token stored for diagnostics.
  • string $normalizedIp Normalized client IP stored for diagnostics.
  • int $firstFailedAt Unix timestamp of the first failure in the active window.
  • int $lastFailedAt Unix timestamp of the latest failure.
  • int $failureCount Failure count inside the active window.
  • int $lockedUntil Unix timestamp until which the bucket is locked, or \0\.