Class Table in namespace com\setasign\SetaFramework\Database\Table in SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Database
  1. Table

com\setasign\SetaFramework\Database\Table

Table Class Table

File: /SetaFramework/src/Database/Table/Table.php

Class hierarchy

Table

Implements

\com\setasign\SetaFramework\Database\TableInterface

Summary

Constants

OPTION_COLUMNS

public const Table::OPTION_COLUMNS = 'columns'

OPTION_MAGIC_COLUMNS

public const Table::OPTION_MAGIC_COLUMNS = 'magicColumns'

OPTION_METADATA_CACHE

public const Table::OPTION_METADATA_CACHE = 'metadataCache'

OPTION_PRIMARY_KEY

public const Table::OPTION_PRIMARY_KEY = 'primaryKey'

OPTION_ROW_CLASS_NAME

public const Table::OPTION_ROW_CLASS_NAME = 'rowClassName'

OPTION_TABLE_NAME

public const Table::OPTION_TABLE_NAME = 'tableName'

Properties

$columns

protected array Table::$columns

Available columns

$db

protected \com\setasign\SetaFramework\Database\Database Table::$db

Database instance

$hiddenColumns

protected array Table::$hiddenColumns = array()

Columns which will not get exposed through the toArray() method of a table row

$magicColumns

protected array Table::$magicColumns

Available magic columns

$metadataCache

protected ?\Psr\SimpleCache\CacheInterface Table::$metadataCache

A cache object for storing table metadata

$primaryKey

protected array<string, string> Table::$primaryKey

Contains the primary key ['columnA' => 'tableA.columnA', 'columnB' => 'tableA.columnB']

$rowClassName

protected string Table::$rowClassName

The row class name

$rowFactory

protected \com\setasign\SetaFramework\Database\RowFactoryInterface Table::$rowFactory

$tableName

protected string Table::$tableName

The table name

Methods

__construct()

public Table::__construct (

\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\SetaFramework\Database\RowFactoryInterface $rowFactory,
?array $options = null

)

The constructor

Available Options:

Option	Type	Description	SampleData
tableName*	array	Contains all tableNames of the tables	['tableA', 'tableB']
rowClassName	string	Classname for the row objects of this table.	Row
columns	array	Contains all columns of the table	['columnA', 'columnB']
primaryKey	array	Contains the primary key; This shouldn't be wrong or incomplete.	['columnA' => 'tableA.columnA', 'columnB' => 'tableA.columnB']
metadataCache	\Psr\SimpleCache\CacheInterface	Cache-object for metadata	-
magicColumns	array	Contains special columns that are read only and can use Expression.	['Name' => new Expression('concat(`firstname`, ' ', `lastname`))]

*required

Parameters

$db : \com\setasign\SetaFramework\Database\Database
$rowFactory : \com\setasign\SetaFramework\Database\RowFactoryInterface
$options : ?array

Exceptions

Throws MissingPrimaryKeyException If a table doesn't have a primary key

__sleep()

public Table::__sleep (

void

): void

createRow()

public Table::createRow (

array $data = array ( )

): Row

Parameters

$data : array

delete()

public Table::delete (

string|callable $where

): void

Delete from the database table

Parameters

$where : string|callable

find()

public Table::find (

int|string|array<string, mixed> $primaryKey,
?Row $row = null

): ?Row

Returns a Table\Row object.

Parameters

$primaryKey : int|string|array<string, mixed>
$row : ?Row: If this is set and the primary key is set, the result data will put into this object.