Core Group: schema

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

| Symbol | Kind | Summary | @return | Service Keys |
| --- | --- | --- | --- | --- |
| Raven\Core\Schema\SchemaAuth::__construct() | method | Wires the schema introspector used for auth table/column/index checks. | void | (none) |
| Raven\Core\Schema\SchemaAuth::ensureAuthSchema() | method | Creates the Delight auth schema if absent, then ensures Raven profile columns. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaAuth::ensureAuthUserPreferenceColumns() | method | Adds Raven-specific profile columns to the auth users table when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaAuth::ensureInviteTokenSchema() | method | Creates the invite-token table and its indexes for the given driver. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBootstrap::ensureSchema() | method | Creates or normalizes the base Raven app schema for one database driver. | void | (none) |
| Raven\Core\Schema\SchemaBuilder::__construct() | method | Wires the introspector used by all ensure methods. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureEventLogTable() | method | Creates the event_log table and its indexes when they do not yet exist. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureGroupRoutingColumns() | method | Backfills slug and route values for all groups, deduplicating slugs and locking system groups to route=0. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensurePageDescriptionColumn() | method | Adds the description column to the pages table when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensurePageDisplayTitleColumn() | method | Adds the display_title boolean column to the pages table when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensurePageScheduleColumns() | method | Adds the published and expires scheduling columns to the pages table when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensurePageSlugScopeUniqueness() | method | Creates driver-appropriate unique indexes enforcing per-channel slug uniqueness on the pages table. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensurePanelPerformanceIndexes() | method | Creates composite lookup indexes on join and redirect tables to speed up panel list queries. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureRedirectLookupScope() | method | Normalizes NULL redirect channel values to 0 and ensures redirect lookup indexes. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureRootChannelScope() | method | Normalizes NULL channel values to 0 in pages and redirects, then rebuilds slug-scope indexes. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureTaxonomyIconColumn() | method | Adds the icon_image column to the categories, tags, and groups tables when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureTaxonomyImageColumns() | method | Adds coverimage and previewimage columns to the categories and tags tables when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaBuilder::ensureTaxonomySetColumns() | method | Adds the set bitfield column and its index to the categories and tags tables when missing. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaComponents::__construct() | method | Accepts optional pre-wired component instances, defaulting to lazy construction on first use. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaComponents::schemaAuth() | method | Returns the auth-schema builder on first use. | SchemaAuth Builder for auth-side schema objects. | (none) |
| Raven\Core\Schema\SchemaComponents::schemaBootstrap() | method | Returns the base app-schema bootstrapper on first use. | SchemaBootstrap Bootstrapper for the base Raven app schema. | (none) |
| Raven\Core\Schema\SchemaComponents::schemaBuilder() | method | Returns the app-schema builder on first use. | SchemaBuilder Builder for app-side schema migrations and backfills. | (none) |
| Raven\Core\Schema\SchemaComponents::schemaExtension() | method | Returns the extension schema runner on first use. | SchemaExtension Runner for extension-owned schema providers. | (none) |
| Raven\Core\Schema\SchemaComponents::schemaInstaller() | method | Returns the seed installer on first use. | SchemaInstaller Installer for stock groups and starter pages. | (none) |
| Raven\Core\Schema\SchemaExtension::__construct() | method | Wires the extension bootstrap resolver used to validate provider contracts. | void | (none) |
| Raven\Core\Schema\SchemaExtension::ensureExtensionSchemas() | method | Runs each enabled extension's schema provider, skipping extensions without storage declarations. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaExtension::string() | method | (No summary.) | (No @return.) | (none) |
| Raven\Core\Schema\SchemaInstaller::__construct() | method | Wires the schema introspector used to keep app seeding independent from lazy auth setup. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaInstaller::ensureGroups() | method | Inserts missing stock groups, normalizes their IDs to canonical positions, and syncs permission masks. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaInstaller::ensurePages() | method | Inserts the starter home page when no users and no root pages exist yet. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaIntrospector::columnExists() | method | Returns true when a column exists in a table, dispatching by driver. | bool True when the column exists in the named table. | (none) |
| Raven\Core\Schema\SchemaIntrospector::indexExists() | method | Returns true when a named index exists, dispatching by driver. | bool True when the index exists, always false for SQLite. | (none) |
| Raven\Core\Schema\SchemaIntrospector::indexExistsMySql() | method | Returns true when a named index exists in a MySQL schema. | bool True when the index exists in the current database. | (none) |
| Raven\Core\Schema\SchemaIntrospector::indexExistsPgSql() | method | Returns true when a named index exists in a PostgreSQL schema. | bool True when the index exists in the current schema. | (none) |
| Raven\Core\Schema\SchemaIntrospector::isAlreadyExistsError() | method | Returns true when a PDOException message indicates a schema object already exists. | bool True when the error message matches a known already-exists pattern. | (none) |
| Raven\Core\Schema\SchemaIntrospector::quotePgIdentifier() | method | Wraps a PostgreSQL identifier in double-quotes, escaping any interior quotes. | string Safely double-quoted identifier for use in raw SQL strings. | (none) |
| Raven\Core\Schema\SchemaIntrospector::sqliteTableExists() | method | Returns true when a table exists in a named SQLite schema (attached DB). | bool True when the table exists in the named schema. | (none) |
| Raven\Core\Schema\SchemaIntrospector::tableExists() | method | Returns true when a table exists, dispatching by driver. | bool True when the table exists in the active schema. | (none) |
| Raven\Core\Schema\SchemaManager::__construct() | method | Wires the pipeline and per-side state stores used by the public ensure methods. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaManager::ensure() | method | Ensures both app and auth schema state in one pass. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaManager::ensureApp() | method | Ensures app-side schema state only. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaManager::ensureAuth() | method | Ensures auth-side schema state only. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaManager::void() | method | (No summary.) | (No @return.) | (none) |
| Raven\Core\Schema\SchemaManager::void() | method | (No summary.) | (No @return.) | (none) |
| Raven\Core\Schema\SchemaPipeline::__construct() | method | Wires the lazy schema-component factory used by app/auth ensure flows. | void | (none) |
| Raven\Core\Schema\SchemaPipeline::ensureApp() | method | Ensures app-side schema, extension schema, and seed rows. | void | (none) |
| Raven\Core\Schema\SchemaPipeline::ensureAuth() | method | Ensures auth-side schema objects only. | void | (none) |
| Raven\Core\Schema\SchemaState::__construct() | method | Configures the state, lock, and marker file paths used by this store instance. | (No @return.) | (none) |
| Raven\Core\Schema\SchemaState::ensureIfChanged() | method | Runs the schema ensure callback only when the local invalidation marker is newer | void | (none) |
| Raven\Core\Schema\SchemaState::invalidate() | method | Marks the schema state dirty so the next bootstrap re-runs ensure. | void | (none) |

Service-Key Grouping (context['rvn'])

• No $rvn[...] service keys detected for this group.

Parameter Details

Raven\Core\Schema\SchemaAuth::__construct()

• File: private/sys/Schema/SchemaAuth.php
• Service Keys: (none)
• Params:
• SchemaIntrospector $introspector Cross-driver schema inspection helper.

Raven\Core\Schema\SchemaAuth::ensureAuthSchema()

• File: private/sys/Schema/SchemaAuth.php
• Service Keys: (none)
• Params:
• PDO $authDb Auth database connection.
• string $driver PDO driver name (sqlite, mysql, pgsql).
• string $prefix Table name prefix (may be empty).

Raven\Core\Schema\SchemaAuth::ensureAuthUserPreferenceColumns()

• File: private/sys/Schema/SchemaAuth.php
• Service Keys: (none)
• Params:
• PDO $db Auth database connection.
• string $driver PDO driver name (sqlite, mysql, pgsql).
• string $prefix Table name prefix (may be empty).

Raven\Core\Schema\SchemaAuth::ensureInviteTokenSchema()

• File: private/sys/Schema/SchemaAuth.php
• Service Keys: (none)
• Params:
• PDO $authDb Auth database connection.
• string $driver PDO driver name (sqlite, mysql, pgsql).
• string $prefix Table name prefix (may be empty).

Raven\Core\Schema\SchemaBootstrap::ensureSchema()

• File: private/sys/Schema/SchemaBootstrap.php
• Service Keys: (none)
• Params:
• PDO $db App database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaBuilder::__construct()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• SchemaIntrospector $introspector Cross-driver column/index/table inspection helper.

Raven\Core\Schema\SchemaBuilder::ensureEventLogTable()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureGroupRoutingColumns()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensurePageDescriptionColumn()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensurePageDisplayTitleColumn()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensurePageScheduleColumns()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensurePageSlugScopeUniqueness()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensurePanelPerformanceIndexes()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureRedirectLookupScope()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureRootChannelScope()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureTaxonomyIconColumn()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureTaxonomyImageColumns()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaBuilder::ensureTaxonomySetColumns()

• File: private/sys/Schema/SchemaBuilder.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaComponents::__construct()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params:
• SchemaIntrospector|null $schemaIntrospector Optional shared introspector; created on first use if null.
• SchemaBootstrap|null $schemaBootstrap Optional base app schema bootstrapper; created on first use if null.
• SchemaAuth|null $schemaAuth Optional auth schema builder; created on first use if null.
• SchemaBuilder|null $schemaBuilder Optional app schema builder; created on first use if null.
• SchemaInstaller|null $schemaInstaller Optional seed installer; created on first use if null.
• SchemaExtension|null $schemaExtension Optional extension schema runner; created on first use if null.

Raven\Core\Schema\SchemaComponents::schemaAuth()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaComponents::schemaBootstrap()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaComponents::schemaBuilder()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaComponents::schemaExtension()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaComponents::schemaInstaller()

• File: private/sys/Schema/SchemaComponents.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaExtension::__construct()

• File: private/sys/Schema/SchemaExtension.php
• Service Keys: (none)
• Params:
• Bootstrap|null $bootstrapResolver Optional resolver; defaults to the canonical extension bootstrap helper.

Raven\Core\Schema\SchemaExtension::ensureExtensionSchemas()

• File: private/sys/Schema/SchemaExtension.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaExtension::string()

• File: private/sys/Schema/SchemaExtension.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaInstaller::__construct()

• File: private/sys/Schema/SchemaInstaller.php
• Service Keys: (none)
• Params:
• SchemaIntrospector|null $introspector Shared schema inspection helper; defaults to a fresh instance.

Raven\Core\Schema\SchemaInstaller::ensureGroups()

• File: private/sys/Schema/SchemaInstaller.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaInstaller::ensurePages()

• File: private/sys/Schema/SchemaInstaller.php
• Service Keys: (none)
• Params:
• PDO $db Active Raven database connection.
• string $driver Database driver identifier: sqlite, mysql, or pgsql.
• string $prefix Table name prefix from the site configuration.

Raven\Core\Schema\SchemaIntrospector::columnExists()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db Database connection to inspect.
• string $driver PDO driver name: sqlite, mysql, or pgsql.
• string $table Table name, optionally schema-qualified (SQLite only).
• string $column Column name to look up.

Raven\Core\Schema\SchemaIntrospector::indexExists()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db Database connection to inspect.
• string $driver PDO driver name: sqlite, mysql, or pgsql.
• string $table Table the index belongs to.
• string $indexName Index name to look up.

Raven\Core\Schema\SchemaIntrospector::indexExistsMySql()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db MySQL database connection to inspect.
• string $table Table the index belongs to.
• string $indexName Index name to look up.

Raven\Core\Schema\SchemaIntrospector::indexExistsPgSql()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db PostgreSQL database connection to inspect.
• string $table Table the index belongs to.
• string $indexName Index name to look up.

Raven\Core\Schema\SchemaIntrospector::isAlreadyExistsError()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• \PDOException $exception Exception thrown by a DDL statement.

Raven\Core\Schema\SchemaIntrospector::quotePgIdentifier()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• string $identifier Unquoted identifier such as a table or column name.

Raven\Core\Schema\SchemaIntrospector::sqliteTableExists()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db SQLite database connection to inspect.
• string $schema Attached schema name (must be a plain identifier).
• string $table Table name to look up within the schema.

Raven\Core\Schema\SchemaIntrospector::tableExists()

• File: private/sys/Schema/SchemaIntrospector.php
• Service Keys: (none)
• Params:
• PDO $db Database connection to inspect.
• string $driver PDO driver name: sqlite, mysql, or pgsql.
• string $table Table name to look up.

Raven\Core\Schema\SchemaManager::__construct()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params:
• SchemaPipeline|null $pipeline Schema ensure pipeline; defaults to a fresh instance.
• SchemaState|null $appStateStore App-side state store; defaults to standard paths.
• SchemaState|null $authStateStore Auth-side state store; defaults to auth-specific paths.

Raven\Core\Schema\SchemaManager::ensure()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params:
• PDO $rvnDb App database connection.
• PDO $authDb Auth database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaManager::ensureApp()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params:
• PDO $rvnDb App database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaManager::ensureAuth()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params:
• PDO $authDb Auth database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaManager::void()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaManager::void()

• File: private/sys/Schema/SchemaManager.php
• Service Keys: (none)
• Params: (none)

Raven\Core\Schema\SchemaPipeline::__construct()

• File: private/sys/Schema/SchemaPipeline.php
• Service Keys: (none)
• Params:
• SchemaComponents|null $components Optional component factory; defaults to a fresh lazy instance.

Raven\Core\Schema\SchemaPipeline::ensureApp()

• File: private/sys/Schema/SchemaPipeline.php
• Service Keys: (none)
• Params:
• PDO $rvnDb App database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaPipeline::ensureAuth()

• File: private/sys/Schema/SchemaPipeline.php
• Service Keys: (none)
• Params:
• PDO $authDb Auth database connection.
• string $driver Active PDO driver name.
• string $prefix Active Raven table prefix.

Raven\Core\Schema\SchemaState::__construct()

• File: private/sys/Schema/SchemaState.php
• Service Keys: (none)
• Params:
• string $root Project root used to resolve default state and marker paths.
• string|null $stateFile Absolute path to the persisted ensure-state file; defaults to the app-side path.
• string|null $lockFile Absolute path to the concurrency lock file; defaults to the app-side lock.
• string|null $markerFile Absolute path to the invalidation marker file; defaults to the app-side marker.

Raven\Core\Schema\SchemaState::ensureIfChanged()

• File: private/sys/Schema/SchemaState.php
• Service Keys: (none)
• Params:
• string $driver Active database driver name.
• string $prefix Active Raven table prefix.
• callable(): void $ensure Callback that performs the actual schema ensure work.

Raven\Core\Schema\SchemaState::invalidate()

• File: private/sys/Schema/SchemaState.php
• Service Keys: (none)
• Params: (none)