Class Schema

Representation of a database table schema.

ICanBoogie\ActiveRecord\Schema implements ArrayAccess, IteratorAggregate uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\ActiveRecord
Located at ActiveRecord/Schema.php

Methods summary


				
				 protected 
				
				

				get_columns( void )
				

				: ICanBoogie\ActiveRecord\SchemaColumn[]


				
				 protected 
				
				

				get_primary( void )
				

				: array|string|null

Returns the primary key of the schema.


				
				 protected 
				
				

				get_indexes( void )
				

				: array

Returns the indexes of the schema.


				
				 protected 
				
				

				get_unique_indexes( void )
				

				: array

Returns unique indexes.


				
				 public 
				
				

				__construct( array $options )


				
				 public 
				
				

				offsetExists( string $column_id )
				

				: boolean

Checks if a column exists.


				
				 public 
				
				

				offsetGet( string $column_id )
				

				: ICanBoogie\ActiveRecord\SchemaColumn

Returns a column.


				
				 public 
				
				

				offsetSet( string $column_id, string|array|ICanBoogie\ActiveRecord\SchemaColumn $column_options )

Adds a column to the schema.


				
				 public 
				
				

				offsetUnset( string $column_id )

Removes a column from the schema.


				
				 public 
				
				

				getIterator( void )
				

				: ArrayIterator

Returns columns iterator.


				
				 public 
				
				

				filter( array $values )
				

				: array

Filters values according to the schema columns.


				
				protected  
				

				
$columns				

				: ICanBoogie\ActiveRecord\SchemaColumn[]

[]


				
				public  read-only
				

				
$columns				

				: ICanBoogie\ActiveRecord\SchemaColumn[]

The columns of the schema.


				
				public  read-only
				

				
$indexes				

				: array

The indexes of the schema.


				
				public  read-only
				

				
$unique_indexes				

				: array

The unique indexes of the schema.


				
				public  read-only
				

				
$primary				

				: array|string

The primary key of the schema. The primary key is an array if it uses multiple columns.