Documentation

Schema extends Base
in package

AbstractYes
Tags
template

TypeKey

template

TypeStored

template

TypeAccessed

extends

Base<TypeKey, TypeStored, TypeAccessed>

Table of Contents

Properties

$schema  : Query|null

Methods

createIn()  : void
equals()  : bool
fromArray()  : Base<TypeStored, TypeAccessed>
fromYamlFile()  : Base<TypeStored, TypeAccessed>
getSchema()  : Query|null
setUp()  : void
tearDown()  : void
withSchema()  : Schema<TypeStored, TypeAccessed>
__construct()  : mixed

Properties

Methods

createIn()

public createIn(PDO $pdo) : void
Parameters
$pdo : PDO
Tags
throws
SchemaException

if schema not defined

equals()

public abstract equals(Base<TypeStored, TypeAccessed$other) : bool
Parameters
$other : Base<TypeStored, TypeAccessed>
Return values
bool

fromArray()

public abstract static fromArray(array<string, mixed> $array) : Base<TypeStored, TypeAccessed>
Parameters
$array : array<string, mixed>
Return values
Base<TypeStored, TypeAccessed>

fromYamlFile()

public static fromYamlFile(string $pathToFile) : Base<TypeStored, TypeAccessed>
Parameters
$pathToFile : string
Tags
throws
BaseException

if YAML does not parse to an array

Return values
Base<TypeStored, TypeAccessed>

setUp()

public abstract setUp(PDO $pdo) : void
Parameters
$pdo : PDO

tearDown()

public abstract tearDown(PDO $pdo) : void
Parameters
$pdo : PDO

withSchema()

public withSchema(Query $schema) : Schema<TypeStored, TypeAccessed>
Parameters
$schema : Query
Return values
Schema<TypeStored, TypeAccessed>

__construct()

protected abstract __construct(array<string, mixed> $config) : mixed
Parameters
$config : array<string, mixed>

        
On this page

Search results