1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie\ActiveRecord;
/**
* Connection driver interface.
*/
interface Driver
{
/**
* Quotes a string, or an array of strings.
*
* @param string|array $string
*
* @return string|array
*/
public function quote_string($string);
/**
* Quotes an identifier, or an array of identifiers.
*
* @param string|array $identifier
*
* @return string|array
*/
public function quote_identifier($identifier);
/**
* Casts a value into a database compatible representation.
*
* @param mixed $value
* @param string|null $type One of `SchemaColumn::TYPE_*`.
*
* @return mixed
*/
public function cast_value($value, $type = null);
/**
* Renders a column definition.
*
* @param SchemaColumn $column
*
* @return string
*/
public function render_column(SchemaColumn $column);
/**
* Creates a table given a schema.
*
* @param string $unprefixed_table_name
* @param Schema $schema
*
* @return $this
*
* @throws \Exception
*/
public function create_table($unprefixed_table_name, Schema $schema);
/**
* Creates indexes given a schema.
*
* @param string $unprefixed_table_name
* @param Schema $schema
*
* @return $this
*
* @throws \Exception
*/
public function create_indexes($unprefixed_table_name, Schema $schema);
/**
* Creates unique indexes given a schema.
*
* @param string $unprefixed_table_name
* @param Schema $schema
*
* @return $this
*
* @throws \Exception
*/
public function create_unique_indexes($unprefixed_table_name, Schema $schema);
/**
* Checks if a specified table exists in the database.
*
* @param string $unprefixed_name The unprefixed name of the table.
*
* @return bool `true` if the table exists, `false` otherwise.
*/
public function table_exists($unprefixed_name);
/**
* Optimizes the tables of the database.
*/
public function optimize();
}