IP/libs/R.class.php

11188 lines
294 KiB
PHP
Raw Normal View History

<?php
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
/**
* RedBean Logging interface.
* Provides a uniform and convenient logging
* interface throughout RedBeanPHP.
*
* @file RedBean/Logging.php
* @desc Logging interface for RedBeanPHP ORM
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface Logger
{
/**
* A logger (for\PDO or OCI driver) needs to implement the log method.
* The log method will receive logging data. Note that the number of parameters is 0, this means
* all parameters are optional and the number may vary. This way the logger can be used in a very
* flexible way. Sometimes the logger is used to log a simple error message and in other
* situations sql and bindings are passed.
* The log method should be able to accept all kinds of parameters and data by using
* functions like func_num_args/func_get_args.
*
* @return void
*/
public function log();
}
}
namespace RedBeanPHP\Logger {
use RedBeanPHP\Logger as Logger;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\RedException\Security as Security;
/**
* Logger. Provides a basic logging function for RedBeanPHP.
*
* @file RedBean/Logger.php
* @desc Logger
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* Provides a basic logging function for RedBeanPHP.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class RDefault implements Logger
{
/**
* @var integer
*/
protected $mode = 0;
/**
* @var array
*/
protected $logs = array();
/**
* Default logger method logging to STDOUT.
* This is the default/reference implementation of a logger.
* This method will write the message value to STDOUT (screen).
*
* @param $message (optional)
*
* @return void
*/
public function log()
{
if ( func_num_args() < 1 ) return;
foreach ( func_get_args() as $argument ) {
if ( is_array( $argument ) ) {
$log = print_r( $argument, TRUE );
if ( $this->mode === 0 ) {
echo $log;
} else {
$this->logs[] = $log;
}
} else {
if ( $this->mode === 0 ) {
echo $argument;
} else {
$this->logs[] = $argument;
}
}
if ($this->mode === 0) echo "<br>\n";
}
}
/**
* Returns the logs array.
*
* @return array
*/
public function getLogs()
{
return $this->logs;
}
/**
* Empties the logs array.
*
* @return self
*/
public function clear()
{
$this->logs = array();
return $this;
}
/**
* Selects a logging mode.
* Mode 0 means echoing all statements, while mode 1
* means populating the logs array.
*
* @param integer $mode mode
*
* @return self
*/
public function setMode( $mode )
{
if ($mode !== 0 && $mode !== 1) {
throw new RedException( 'Invalid mode selected for logger, use 1 or 0.' );
}
$this->mode = $mode;
return $this;
}
/**
* Searches for all log entries in internal log array
* for $needle and returns those entries.
*
* @param string $needle needle
*
* @return array
*/
public function grep( $needle )
{
$found = array();
foreach( $this->logs as $logEntry ) {
if (strpos( $logEntry, $needle ) !== false) $found[] = $logEntry;
}
return $found;
}
}
}
namespace RedBeanPHP\Logger\RDefault {
use RedBeanPHP\Logger as Logger;
use RedBeanPHP\Logger\RDefault as RDefault;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\RedException\Security as Security;
/**
2014-10-13 09:24:53 +00:00
* Debug logger.
* A special logger for debugging purposes.
*
* @file RedBean/Logger/RDefault/Debug.php
* @desc Debug Logger
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* Provides a debugging logging functions for RedBeanPHP.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class Debug extends RDefault implements Logger
{
/**
* Writes a query for logging with all bindings / params filled
* in.
*
* @param string $newSql the query
* @param array $bindings the bindings to process (key-value pairs)
*
* @return string
*/
private function writeQuery( $newSql, $newBindings )
{
$newStr = $newSql;
foreach( $newBindings as $slot => $value ) {
if ( strpos( $slot, ':' ) === 0 ) {
$newStr = str_replace( $slot, $this->fillInValue( $value ), $newStr );
}
}
return $newStr;
}
/**
* Fills in a value of a binding and truncates the
* resulting string if necessary.
*
* @param mixed $value
*
* @return string
*/
protected function fillInValue( $value )
{
if ( is_null( $value ) ) $value = 'NULL';
$value = strval( $value );
if ( strlen( $value ) > 20 ) {
$value = substr( $value, 0, 20 ).'... ';
}
if ( !is_numeric( $value ) && $value !== 'NULL') {
$value = '\''.$value.'\'';
}
return $value;
}
/**
* Dependending on the current mode of operation,
* this method will either log and output to STDIN or
* just log.
*
* @param string $str string to log or output and log
*
* @return void
*/
protected function output( $str )
{
$this->logs[] = $str;
if ( !$this->mode ) echo $str .'<br />';
}
/**
* Normalizes the slots in an SQL string.
* Replaces question mark slots with :slot1 :slot2 etc.
*
* @param string $sql sql to normalize
*
* @return string
*/
protected function normalizeSlots( $sql )
{
$i = 0;
$newSql = $sql;
while($i < 20 && strpos($newSql, '?') !== FALSE ){
$pos = strpos( $newSql, '?' );
$slot = ':slot'.$i;
$begin = substr( $newSql, 0, $pos );
$end = substr( $newSql, $pos+1 );
$newSql = $begin . $slot . $end;
$i++;
}
return $newSql;
}
/**
* Normalizes the bindings.
* Replaces numeric binding keys with :slot1 :slot2 etc.
*
* @param array $bindings bindings to normalize
*
* @return array
*/
protected function normalizeBindings( $bindings )
{
$i = 0;
$newBindings = array();
foreach( $bindings as $key => $value ) {
if ( is_numeric($key) ) {
$newKey = ':slot'.$i;
$newBindings[$newKey] = $value;
$i++;
} else {
$newBindings[$key] = $value;
}
}
return $newBindings;
}
/**
* Logger method.
*
* Takes a number of arguments tries to create
* a proper debug log based on the available data.
*
* @return void
*/
public function log()
{
if ( func_num_args() < 1 ) return;
$sql = func_get_arg( 0 );
2014-10-13 09:24:53 +00:00
if ( func_num_args() < 2) {
$bindings = array();
} else {
$bindings = func_get_arg( 1 );
}
2014-10-13 09:24:53 +00:00
if ( !is_array( $bindings ) ) {
return $this->output( $sql );
}
2014-10-13 09:24:53 +00:00
$newSql = $this->normalizeSlots( $sql );
$newBindings = $this->normalizeBindings( $bindings );
$newStr = $this->writeQuery( $newSql, $newBindings );
$this->output( $newStr );
}
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
/**
* Interface for database drivers
*
* @file RedBean/Driver.php
* @desc Describes the API for database classes
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* The Driver API conforms to the ADODB pseudo standard
* for database drivers.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface Driver
{
/**
* Runs a query and fetches results as a multi dimensional array.
*
* @param string $sql SQL to be executed
* @param array $bindings list of values to bind to SQL snippet
*
* @return array
*/
public function GetAll( $sql, $bindings = array() );
/**
* Runs a query and fetches results as a column.
*
* @param string $sql SQL Code to execute
* @param array $bindings list of values to bind to SQL snippet
*
* @return array
*/
public function GetCol( $sql, $bindings = array() );
/**
* Runs a query and returns results as a single cell.
*
* @param string $sql SQL to execute
* @param array $bindings list of values to bind to SQL snippet
*
* @return mixed
*/
public function GetCell( $sql, $bindings = array() );
/**
* Runs a query and returns results as an associative array
* indexed by the first column.
*
* @param string $sql SQL to execute
* @param array $bindings list of values to bind to SQL snippet
*
* @return mixed
*/
public function GetAssocRow( $sql, $bindings = array() );
/**
* Runs a query and returns a flat array containing the values of
* one row.
*
* @param string $sql SQL to execute
* @param array $bindings list of values to bind to SQL snippet
*
* @return array
*/
public function GetRow( $sql, $bindings = array() );
/**
* Executes SQL code and allows key-value binding.
* This function allows you to provide an array with values to bind
* to query parameters. For instance you can bind values to question
* marks in the query. Each value in the array corresponds to the
* question mark in the query that matches the position of the value in the
* array. You can also bind values using explicit keys, for instance
* array(":key"=>123) will bind the integer 123 to the key :key in the
* SQL. This method has no return value.
*
* @param string $sql SQL Code to execute
* @param array $bindings list of values to bind to SQL snippet
*
* @return array Affected Rows
*/
public function Execute( $sql, $bindings = array() );
/**
* Returns the latest insert ID if driver does support this
* feature.
*
* @return integer
*/
public function GetInsertID();
/**
* Returns the number of rows affected by the most recent query
* if the currently selected driver driver supports this feature.
*
* @return integer
*/
public function Affected_Rows();
/**
* Toggles debug mode. In debug mode the driver will print all
* SQL to the screen together with some information about the
* results. All SQL code that passes through the driver will be
* passes on to the screen for inspection.
* This method has no return value.
*
* @param boolean $trueFalse turn on/off
*
* @return void
*/
public function setDebugMode( $tf );
/**
* Starts a transaction.
*
* @return void
*/
public function CommitTrans();
/**
* Commits a transaction.
*
* @return void
*/
public function StartTrans();
/**
* Rolls back a transaction.
*
* @return void
*/
public function FailTrans();
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\Driver {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\Driver as Driver;
use RedBeanPHP\Logger as Logger;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\Logger\RDefault as RDefault;
use RedBeanPHP\PDOCompatible as PDOCompatible;
/**
*\PDO Driver
* This Driver implements the RedBean Driver API
*
* @file RedBean/PDO.php
* @desc \PDO Driver
* @author Gabor de Mooij and the RedBeanPHP Community, Desfrenes
* @license BSD/GPLv2
*
* (c) copyright Desfrenes & Gabor de Mooij and the RedBeanPHP community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class RPDO implements Driver
{
2014-10-13 09:24:53 +00:00
/**
* @var integer
*/
protected $max;
/**
* @var string
*/
protected $dsn;
/**
* @var boolean
*/
protected $debug = FALSE;
/**
2014-10-13 09:24:53 +00:00
* @var Logger
*/
protected $logger = NULL;
/**
2014-10-13 09:24:53 +00:00
* @var\PDO
*/
protected $pdo;
/**
* @var integer
*/
protected $affectedRows;
/**
* @var integer
*/
protected $resultArray;
/**
* @var array
*/
protected $connectInfo = array();
/**
* @var boolean
*/
protected $isConnected = FALSE;
/**
* @var bool
*/
protected $flagUseStringOnlyBinding = FALSE;
/**
* @var string
*/
protected $mysqlEncoding = '';
/**
2014-10-13 09:24:53 +00:00
* Binds parameters. This method binds parameters to a\PDOStatement for
* Query Execution. This method binds parameters as NULL, INTEGER or STRING
* and supports both named keys and question mark keys.
*
2014-10-13 09:24:53 +00:00
* @param \PDOStatement $statement \PDO Statement instance
* @param array $bindings values that need to get bound to the statement
*
* @return void
*/
protected function bindParams( $statement, $bindings )
{
foreach ( $bindings as $key => &$value ) {
if ( is_integer( $key ) ) {
if ( is_null( $value ) ) {
2014-10-13 09:24:53 +00:00
$statement->bindValue( $key + 1, NULL,\PDO::PARAM_NULL );
} elseif ( !$this->flagUseStringOnlyBinding && AQueryWriter::canBeTreatedAsInt( $value ) && $value <= $this->max ) {
$statement->bindParam( $key + 1, $value,\PDO::PARAM_INT );
} else {
2014-10-13 09:24:53 +00:00
$statement->bindParam( $key + 1, $value,\PDO::PARAM_STR );
}
} else {
if ( is_null( $value ) ) {
2014-10-13 09:24:53 +00:00
$statement->bindValue( $key, NULL,\PDO::PARAM_NULL );
} elseif ( !$this->flagUseStringOnlyBinding && AQueryWriter::canBeTreatedAsInt( $value ) && $value <= $this->max ) {
$statement->bindParam( $key, $value,\PDO::PARAM_INT );
} else {
2014-10-13 09:24:53 +00:00
$statement->bindParam( $key, $value,\PDO::PARAM_STR );
}
}
}
}
/**
* This method runs the actual SQL query and binds a list of parameters to the query.
* slots. The result of the query will be stored in the protected property
* $rs (always array). The number of rows affected (result of rowcount, if supported by database)
* is stored in protected property $affectedRows. If the debug flag is set
* this function will send debugging output to screen buffer.
*
* @param string $sql the SQL string to be send to database server
* @param array $bindings the values that need to get bound to the query slots
*
* @return void
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*/
protected function runQuery( $sql, $bindings, $options = array() )
{
$this->connect();
if ( $this->debug && $this->logger ) {
$this->logger->log( $sql, $bindings );
}
try {
if ( strpos( 'pgsql', $this->dsn ) === 0 ) {
2014-10-13 09:24:53 +00:00
$statement = $this->pdo->prepare( $sql, array(\PDO::PGSQL_ATTR_DISABLE_NATIVE_PREPARED_STATEMENT => TRUE ) );
} else {
$statement = $this->pdo->prepare( $sql );
}
$this->bindParams( $statement, $bindings );
$statement->execute();
$this->affectedRows = $statement->rowCount();
if ( $statement->columnCount() ) {
2014-10-13 09:24:53 +00:00
$fetchStyle = ( isset( $options['fetchStyle'] ) ) ? $options['fetchStyle'] : NULL;
2014-10-13 09:24:53 +00:00
$this->resultArray = $statement->fetchAll( $fetchStyle );
if ( $this->debug && $this->logger ) {
$this->logger->log( 'resultset: ' . count( $this->resultArray ) . ' rows' );
}
} else {
$this->resultArray = array();
}
2014-10-13 09:24:53 +00:00
} catch (\PDOException $e ) {
//Unfortunately the code field is supposed to be int by default (php)
//So we need a property to convey the SQL State code.
$err = $e->getMessage();
if ( $this->debug && $this->logger ) $this->logger->log( 'An error occurred: ' . $err );
2014-10-13 09:24:53 +00:00
$exception = new SQL( $err, 0 );
$exception->setSQLState( $e->getCode() );
throw $exception;
}
}
/**
2014-10-13 09:24:53 +00:00
* Try to fix MySQL character encoding problems.
* MySQL < 5.5 does not support proper 4 byte unicode but they
* seem to have added it with version 5.5 under a different label: utf8mb4.
* We try to select the best possible charset based on your version data.
*/
protected function setEncoding()
{
2014-10-13 09:24:53 +00:00
$driver = $this->pdo->getAttribute(\PDO::ATTR_DRIVER_NAME );
$version = floatval( $this->pdo->getAttribute(\PDO::ATTR_SERVER_VERSION ) );
2014-10-13 09:24:53 +00:00
if ($driver === 'mysql') {
$encoding = ($version >= 5.5) ? 'utf8mb4' : 'utf8';
2014-10-13 09:24:53 +00:00
$this->pdo->setAttribute(\PDO::MYSQL_ATTR_INIT_COMMAND, 'SET NAMES '.$encoding ); //on every re-connect
$this->pdo->exec(' SET NAMES '. $encoding); //also for current connection
$this->mysqlEncoding = $encoding;
}
}
/**
2014-10-13 09:24:53 +00:00
* Returns the best possible encoding for MySQL based on version data.
*
* @return string
*/
public function getMysqlEncoding()
{
return $this->mysqlEncoding;
}
/**
* Constructor. You may either specify dsn, user and password or
2014-10-13 09:24:53 +00:00
* just give an existing\PDO connection.
* Examples:
2014-10-13 09:24:53 +00:00
* $driver = new RPDO($dsn, $user, $password);
* $driver = new RPDO($existingConnection);
*
2014-10-13 09:24:53 +00:00
* @param string|object $dsn database connection string
* @param string $user optional, usename to sign in
* @param string $pass optional, password for connection login
*
*/
2014-10-13 09:24:53 +00:00
public function __construct( $dsn, $user = NULL, $pass = NULL )
{
2014-10-13 09:24:53 +00:00
if ( is_object( $dsn ) ) {
$this->pdo = $dsn;
$this->isConnected = TRUE;
2014-10-13 09:24:53 +00:00
$this->setEncoding();
$this->pdo->setAttribute(\PDO::ATTR_ERRMODE,\PDO::ERRMODE_EXCEPTION );
$this->pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE,\PDO::FETCH_ASSOC );
// make sure that the dsn at least contains the type
$this->dsn = $this->getDatabaseType();
} else {
$this->dsn = $dsn;
$this->connectInfo = array( 'pass' => $pass, 'user' => $user );
}
2014-10-13 09:24:53 +00:00
//PHP 5.3 PDO SQLite has a bug with large numbers:
if ( strpos( $this->dsn, 'sqlite' ) === 0 && PHP_MAJOR_VERSION === 5 && PHP_MINOR_VERSION === 3) {
$this->max = 2147483647; //otherwise you get -2147483648 ?! demonstrated in build #603 on Travis.
} else {
$this->max = PHP_INT_MAX; //the normal value of course (makes it possible to use large numbers in LIMIT clause)
}
}
/**
* Whether to bind all parameters as strings.
*
* @param boolean $yesNo pass TRUE to bind all parameters as strings.
*
* @return void
*/
public function setUseStringOnlyBinding( $yesNo )
{
$this->flagUseStringOnlyBinding = (boolean) $yesNo;
}
/**
2014-10-13 09:24:53 +00:00
* Establishes a connection to the database using PHP\PDO
* functionality. If a connection has already been established this
* method will simply return directly. This method also turns on
* UTF8 for the database and\PDO-ERRMODE-EXCEPTION as well as
*\PDO-FETCH-ASSOC.
*
* @throws\PDOException
*
* @return void
*/
public function connect()
2014-10-13 09:24:53 +00:00
{
if ( $this->isConnected ) return;
2014-10-13 09:24:53 +00:00
try {
$user = $this->connectInfo['user'];
2014-10-13 09:24:53 +00:00
$pass = $this->connectInfo['pass'];
2014-10-13 09:24:53 +00:00
$this->pdo = new\PDO(
$this->dsn,
2014-10-13 09:24:53 +00:00
$user,
$pass,
array(\PDO::ATTR_ERRMODE =>\PDO::ERRMODE_EXCEPTION,
\PDO::ATTR_DEFAULT_FETCH_MODE =>\PDO::FETCH_ASSOC,
)
);
2014-10-13 09:24:53 +00:00
$this->setEncoding();
$this->pdo->setAttribute(\PDO::ATTR_STRINGIFY_FETCHES, TRUE );
$this->isConnected = TRUE;
2014-10-13 09:24:53 +00:00
} catch (\PDOException $exception ) {
$matches = array();
$dbname = ( preg_match( '/dbname=(\w+)/', $this->dsn, $matches ) ) ? $matches[1] : '?';
2014-10-13 09:24:53 +00:00
throw new\PDOException( 'Could not connect to database (' . $dbname . ').', $exception->getCode() );
}
}
2014-10-13 09:24:53 +00:00
/**
* Directly sets PDO instance into driver.
* This method might improve performance, however since the driver does
* not configure this instance terrible things may happen... only use
* this method if you are an expert on RedBeanPHP, PDO and UTF8 connections and
* you know your database server VERY WELL.
*
* @param PDO $pdo PDO instance
*
* @return void
*/
public function setPDO( \PDO $pdo ) {
$this->pdo = $pdo;
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::GetAll
*/
public function GetAll( $sql, $bindings = array() )
{
$this->runQuery( $sql, $bindings );
return $this->resultArray;
}
2014-10-13 09:24:53 +00:00
/**
* @see Driver::GetAssocRow
*/
public function GetAssocRow( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$this->runQuery( $sql, $bindings, array(
'fetchStyle' => \PDO::FETCH_ASSOC
)
);
2014-10-13 09:24:53 +00:00
return $this->resultArray;
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* @see Driver::GetCol
*/
public function GetCol( $sql, $bindings = array() )
{
$rows = $this->GetAll( $sql, $bindings );
$cols = array();
if ( $rows && is_array( $rows ) && count( $rows ) > 0 ) {
foreach ( $rows as $row ) {
$cols[] = array_shift( $row );
}
}
return $cols;
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::GetCell
*/
public function GetCell( $sql, $bindings = array() )
{
$arr = $this->GetAll( $sql, $bindings );
$row1 = array_shift( $arr );
$col1 = array_shift( $row1 );
return $col1;
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::GetRow
*/
public function GetRow( $sql, $bindings = array() )
{
$arr = $this->GetAll( $sql, $bindings );
return array_shift( $arr );
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::Excecute
*/
public function Execute( $sql, $bindings = array() )
{
$this->runQuery( $sql, $bindings );
return $this->affectedRows;
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::GetInsertID
*/
public function GetInsertID()
{
$this->connect();
return (int) $this->pdo->lastInsertId();
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::Affected_Rows
*/
public function Affected_Rows()
{
$this->connect();
return (int) $this->affectedRows;
}
/**
* Toggles debug mode. In debug mode the driver will print all
* SQL to the screen together with some information about the
* results.
*
* @param boolean $trueFalse turn on/off
2014-10-13 09:24:53 +00:00
* @param Logger $logger logger instance
*
* @return void
*/
public function setDebugMode( $tf, $logger = NULL )
{
$this->connect();
$this->debug = (bool) $tf;
if ( $this->debug and !$logger ) {
2014-10-13 09:24:53 +00:00
$logger = new RDefault();
}
$this->setLogger( $logger );
}
/**
2014-10-13 09:24:53 +00:00
* Injects Logger object.
* Sets the logger instance you wish to use.
*
2014-10-13 09:24:53 +00:00
* @param Logger $logger the logger instance to be used for logging
*/
2014-10-13 09:24:53 +00:00
public function setLogger( Logger $logger )
{
$this->logger = $logger;
}
/**
2014-10-13 09:24:53 +00:00
* Gets Logger object.
* Returns the currently active Logger instance.
*
2014-10-13 09:24:53 +00:00
* @return Logger
*/
public function getLogger()
{
return $this->logger;
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::StartTrans
*/
public function StartTrans()
{
$this->connect();
$this->pdo->beginTransaction();
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::CommitTrans
*/
public function CommitTrans()
{
$this->connect();
$this->pdo->commit();
}
/**
2014-10-13 09:24:53 +00:00
* @see Driver::FailTrans
*/
public function FailTrans()
{
$this->connect();
$this->pdo->rollback();
}
/**
2014-10-13 09:24:53 +00:00
* Returns the name of database driver for\PDO.
* Uses the\PDO attribute DRIVER NAME to obtain the name of the
*\PDO driver.
*
* @return string
*/
public function getDatabaseType()
{
$this->connect();
2014-10-13 09:24:53 +00:00
return $this->pdo->getAttribute(\PDO::ATTR_DRIVER_NAME );
}
/**
* Returns the version number of the database.
*
* @return mixed $version version number of the database
*/
public function getDatabaseVersion()
{
$this->connect();
2014-10-13 09:24:53 +00:00
return $this->pdo->getAttribute(\PDO::ATTR_CLIENT_VERSION );
}
/**
2014-10-13 09:24:53 +00:00
* Returns the underlying PHP\PDO instance.
*
2014-10-13 09:24:53 +00:00
* @return\PDO
*/
public function getPDO()
{
$this->connect();
return $this->pdo;
}
/**
2014-10-13 09:24:53 +00:00
* Closes database connection by destructing\PDO.
*
* @return void
*/
public function close()
{
$this->pdo = NULL;
$this->isConnected = FALSE;
}
/**
2014-10-13 09:24:53 +00:00
* Returns TRUE if the current\PDO instance is connected.
*
* @return boolean
*/
public function isConnected()
{
return $this->isConnected && $this->pdo;
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\OODBBean as OODBBean;
2014-10-13 09:24:53 +00:00
/**
* OODBBean (Object Oriented DataBase Bean)
*
* @file RedBean/OODBBean.php
* @desc The Bean class used for passing information
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class OODBBean implements\IteratorAggregate,\ArrayAccess,\Countable
{
/**
* This is where the real properties of the bean live. They are stored and retrieved
* by the magic getter and setter (__get and __set).
*
* @var array $properties
*/
2014-10-13 09:24:53 +00:00
protected $properties = array();
/**
* Here we keep the meta data of a bean.
*
* @var array
*/
2014-10-13 09:24:53 +00:00
protected $__info = array();
/**
* The BeanHelper allows the bean to access the toolbox objects to implement
* rich functionality, otherwise you would have to do everything with R or
* external objects.
*
2014-10-13 09:24:53 +00:00
* @var BeanHelper
*/
2014-10-13 09:24:53 +00:00
protected $beanHelper = NULL;
/**
* @var null
*/
2014-10-13 09:24:53 +00:00
protected $fetchType = NULL;
/**
* @var string
*/
2014-10-13 09:24:53 +00:00
protected $withSql = '';
/**
* @var array
*/
2014-10-13 09:24:53 +00:00
protected $withParams = array();
/**
* @var string
*/
2014-10-13 09:24:53 +00:00
protected $aliasName = NULL;
/**
* @var string
*/
2014-10-13 09:24:53 +00:00
protected $via = NULL;
/**
* @var boolean
*/
protected $noLoad = FALSE;
/**
* @var boolean
*/
2014-10-13 09:24:53 +00:00
protected $all = FALSE;
2014-10-13 09:24:53 +00:00
/**
* Parses the join in the with-snippet.
* For instance:
*
* $author
* ->withCondition(' @joined.detail.title LIKE ? ')
* ->ownBookList;
*
2014-10-13 09:24:53 +00:00
* will automatically join 'detail' on book to
* access the title field.
*
2014-10-13 09:24:53 +00:00
* @note this feature requires Narrow Field Mode and Join Feature
* to be both activated (default).
*
* @param string $type the source type for the join
*
* @return string $joinSql
*/
2014-10-13 09:24:53 +00:00
private function parseJoin( $type )
{
2014-10-13 09:24:53 +00:00
$joinSql = '';
$joins = array();
if ( strpos($this->withSql, '@joined.' ) !== FALSE ) {
$writer = $this->beanHelper->getToolBox()->getWriter();
$oldParts = $parts = explode( '@joined.', $this->withSql );
array_shift( $parts );
foreach($parts as $part) {
$explosion = explode( '.', $part );
$joinInfo = array_shift( $explosion );
//Dont join more than once..
if ( !isset( $joins[$joinInfo] ) ) {
$joins[ $joinInfo ] = true;
$joinSql .= $writer->writeJoin( $type, $joinInfo, 'LEFT' );
}
}
$this->withSql = implode( '', $oldParts );
$joinSql .= ' WHERE ';
}
2014-10-13 09:24:53 +00:00
return $joinSql;
}
/**
* Internal method.
* Obtains a shared list for a certain type.
*
* @param string $type the name of the list you want to retrieve.
*
* @return array
*/
private function getSharedList( $type, $redbean, $toolbox )
{
2014-10-13 09:24:53 +00:00
$writer = $toolbox->getWriter();
if ( $this->via ) {
$oldName = $writer->getAssocTable( array( $this->__info['type'], $type ) );
if ( $oldName !== $this->via ) {
//set the new renaming rule
$writer->renameAssocTable( $oldName, $this->via );
}
2014-10-13 09:24:53 +00:00
$this->via = NULL;
}
2014-10-13 09:24:53 +00:00
$beans = array();
if ($this->getID()) {
$type = $this->beau( $type );
$assocManager = $redbean->getAssociationManager();
$beans = $assocManager->related( $this, $type, $this->withSql, $this->withParams );
}
$this->withSql = '';
$this->withParams = array();
return $beans;
}
/**
* Internal method.
* Obtains the own list of a certain type.
*
2014-10-13 09:24:53 +00:00
* @param string $type name of the list you want to retrieve
* @param OODB $oodb The RB OODB object database instance
*
* @return array
*/
private function getOwnList( $type, $redbean )
{
$type = $this->beau( $type );
if ( $this->aliasName ) {
$parentField = $this->aliasName;
$myFieldLink = $parentField . '_id';
$this->__info['sys.alias.' . $type] = $this->aliasName;
$this->aliasName = NULL;
} else {
$parentField = $this->__info['type'];
$myFieldLink = $parentField . '_id';
}
$beans = array();
2014-10-13 09:24:53 +00:00
if ( $this->getID() ) {
$firstKey = NULL;
if ( count( $this->withParams ) > 0 ) {
reset( $this->withParams );
$firstKey = key( $this->withParams );
}
2014-10-13 09:24:53 +00:00
$joinSql = $this->parseJoin( $type );
if ( !is_numeric( $firstKey ) || $firstKey === NULL ) {
$bindings = $this->withParams;
$bindings[':slot0'] = $this->getID();
2014-10-13 09:24:53 +00:00
$beans = $redbean->find( $type, array(), " {$joinSql} $myFieldLink = :slot0 " . $this->withSql, $bindings );
} else {
$bindings = array_merge( array( $this->getID() ), $this->withParams );
2014-10-13 09:24:53 +00:00
$beans = $redbean->find( $type, array(), " {$joinSql} $myFieldLink = ? " . $this->withSql, $bindings );
}
}
$this->withSql = '';
$this->withParams = array();
foreach ( $beans as $beanFromList ) {
$beanFromList->__info['sys.parentcache.' . $parentField] = $this;
}
return $beans;
}
/**
2014-10-13 09:24:53 +00:00
* Sets a meta property for all beans. This is a quicker way to set
* the meta properties for a collection of beans because this method
* can directly access the property arrays of the beans.
* This method returns the beans.
*
2014-10-13 09:24:53 +00:00
* @param array $beans beans to set the meta property of
* @param string $property property to set
* @param mixed $value value
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function setMetaAll( $beans, $property, $value )
{
2014-10-13 09:24:53 +00:00
foreach( $beans as $bean ) {
$bean->__info[ $property ] = $value;
}
2014-10-13 09:24:53 +00:00
return $beans;
}
/**
* Initializes a bean. Used by OODB for dispensing beans.
* It is not recommended to use this method to initialize beans. Instead
* use the OODB object to dispense new beans. You can use this method
* if you build your own bean dispensing mechanism.
*
* @param string $type type of the new bean
2014-10-13 09:24:53 +00:00
* @param BeanHelper $beanhelper bean helper to obtain a toolbox and a model
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function initializeForDispense( $type, BeanHelper $beanhelper )
{
$this->beanHelper = $beanhelper;
$this->__info['type'] = $type;
$this->__info['sys.id'] = 'id';
$this->__info['sys.orig'] = array( 'id' => 0 );
$this->__info['tainted'] = TRUE;
2014-10-13 09:24:53 +00:00
$this->__info['changed'] = TRUE;
$this->properties['id'] = 0;
}
/**
* Sets the Bean Helper. Normally the Bean Helper is set by OODB.
* Here you can change the Bean Helper. The Bean Helper is an object
* providing access to a toolbox for the bean necessary to retrieve
* nested beans (bean lists: ownBean, sharedBean) without the need to
* rely on static calls to the facade (or make this class dep. on OODB).
*
2014-10-13 09:24:53 +00:00
* @param BeanHelper $helper
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function setBeanHelper( BeanHelper $helper )
{
$this->beanHelper = $helper;
}
/**
2014-10-13 09:24:53 +00:00
* Returns an\ArrayIterator so you can treat the bean like
* an array with the properties container as its contents.
* This method is meant for PHP and allows you to access beans as if
* they were arrays, i.e. using array notation:
2014-10-13 09:24:53 +00:00
*
* $bean[ $key ] = $value;
2014-10-13 09:24:53 +00:00
*
* Note that not all PHP functions work with the array interface.
*
2014-10-13 09:24:53 +00:00
* @return\ArrayIterator
*/
public function getIterator()
{
2014-10-13 09:24:53 +00:00
return new\ArrayIterator( $this->properties );
}
/**
* Imports all values from an associative array $array. Chainable.
* This method imports the values in the first argument as bean
* propery and value pairs. Use the second parameter to provide a
* selection. If a selection array is passed, only the entries
* having keys mentioned in the selection array will be imported.
* Set the third parameter to TRUE to preserve spaces in selection keys.
*
* @param array $array what you want to import
* @param string|array $selection selection of values
* @param boolean $notrim if TRUE selection keys will NOT be trimmed
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function import( $array, $selection = FALSE, $notrim = FALSE )
{
if ( is_string( $selection ) ) {
$selection = explode( ',', $selection );
}
if ( !$notrim && is_array( $selection ) ) {
foreach ( $selection as $key => $selected ) {
$selection[$key] = trim( $selected );
}
}
foreach ( $array as $key => $value ) {
if ( $key != '__info' ) {
if ( !$selection || ( $selection && in_array( $key, $selection ) ) ) {
2014-10-13 09:24:53 +00:00
if ( is_array($value ) ) {
if ( isset( $value['_type'] ) ) {
$bean = $this->beanHelper->getToolbox()->getRedBean()->dispense( $value['_type'] );
unset( $value['_type'] );
$bean->import($value);
$this->$key = $bean;
} else {
$listBeans = array();
foreach( $value as $listKey => $listItem ) {
$bean = $this->beanHelper->getToolbox()->getRedBean()->dispense( $listItem['_type'] );
unset( $listItem['_type'] );
$bean->import($listItem);
$list = &$this->$key;
$list[ $listKey ] = $bean;
}
}
} else {
$this->$key = $value;
}
}
}
}
return $this;
}
/**
2014-10-13 09:24:53 +00:00
* Fast way to import a row.
* Does not perform any checks.
*
* @param array $row a database row
*
* @return self
*/
public function importRow( $row )
{
2014-10-13 09:24:53 +00:00
$this->properties = $row;
$this->__info['sys.orig'] = $row;
2014-10-13 09:24:53 +00:00
$this->__info['changed'] = FALSE;
return $this;
}
/**
* Imports data from another bean. Chainable.
* Copies the properties from the source bean to the internal
* property list.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $sourceBean the source bean to take properties from
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function importFrom( OODBBean $sourceBean )
{
$this->__info['tainted'] = TRUE;
2014-10-13 09:24:53 +00:00
$this->__info['changed'] = TRUE;
$this->properties = $sourceBean->properties;
return $this;
}
/**
* Injects the properties of another bean but keeps the original ID.
* Just like import() but keeps the original ID.
* Chainable.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $otherBean the bean whose properties you would like to copy
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function inject( OODBBean $otherBean )
{
$myID = $this->properties['id'];
$this->import( $otherBean->export() );
$this->id = $myID;
return $this;
}
/**
* Exports the bean as an array.
* This function exports the contents of a bean to an array and returns
* the resulting array.
*
* @param boolean $meta set to TRUE if you want to export meta data as well
* @param boolean $parents set to TRUE if you want to export parents as well
* @param boolean $onlyMe set to TRUE if you want to export only this bean
* @param array $filters optional whitelist for export
*
* @return array
*/
public function export( $meta = FALSE, $parents = FALSE, $onlyMe = FALSE, $filters = array() )
{
$arr = array();
if ( $parents ) {
foreach ( $this as $key => $value ) {
if ( substr( $key, -3 ) != '_id' ) continue;
$prop = substr( $key, 0, strlen( $key ) - 3 );
$this->$prop;
}
}
$hasFilters = is_array( $filters ) && count( $filters );
foreach ( $this as $key => $value ) {
if ( !$onlyMe && is_array( $value ) ) {
$vn = array();
foreach ( $value as $i => $b ) {
2014-10-13 09:24:53 +00:00
$vn[] = $b->export( $meta, FALSE, FALSE, $filters );
$value = $vn;
}
2014-10-13 09:24:53 +00:00
} elseif ( $value instanceof OODBBean ) {
if ( $hasFilters ) {
if ( !in_array( strtolower( $value->getMeta( 'type' ) ), $filters ) ) continue;
}
$value = $value->export( $meta, $parents, FALSE, $filters );
}
$arr[$key] = $value;
}
if ( $meta ) {
$arr['__info'] = $this->__info;
}
return $arr;
}
/**
* Implements isset() function for use as an array.
*
* @param string $property name of the property you want to check
*
* @return boolean
*/
public function __isset( $property )
{
2014-10-13 09:24:53 +00:00
$property = $this->beau( $property );
if ( strpos( $property, 'xown' ) === 0 && ctype_upper( substr( $property, 4, 1 ) ) ) {
$property = substr($property, 1);
}
return isset( $this->properties[$property] );
}
/**
* Returns the ID of the bean no matter what the ID field is.
*
* @return string|null
*/
public function getID()
{
return ( isset( $this->properties['id'] ) ) ? (string) $this->properties['id'] : NULL;
}
/**
* Unsets a property. This method will load the property first using
* __get.
*
* @param string $property property
*
* @return void
*/
public function __unset( $property )
{
2014-10-13 09:24:53 +00:00
$property = $this->beau( $property );
2014-10-13 09:24:53 +00:00
if ( strpos( $property, 'xown' ) === 0 && ctype_upper( substr( $property, 4, 1 ) ) ) {
$property = substr($property, 1);
}
unset( $this->properties[$property] );
2014-10-13 09:24:53 +00:00
$shadowKey = 'sys.shadow.'.$property;
if ( isset( $this->__info[ $shadowKey ] ) ) unset( $this->__info[$shadowKey] );
//also clear modifiers
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
return;
}
/**
* Adds WHERE clause conditions to ownList retrieval.
* For instance to get the pages that belong to a book you would
* issue the following command: $book->ownPage
* However, to order these pages by number use:
*
* $book->with(' ORDER BY `number` ASC ')->ownPage
*
* the additional SQL snippet will be merged into the final
* query.
*
2014-10-13 09:24:53 +00:00
* @param string $sql SQL to be added to retrieval query.
* @param array $bindings array with parameters to bind to SQL snippet
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function with( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$this->withSql = $sql;
$this->withParams = $bindings;
return $this;
}
/**
* Just like with(). Except that this method prepends the SQL query snippet
* with AND which makes it slightly more comfortable to use a conditional
* SQL snippet. For instance to filter an own-list with pages (belonging to
* a book) on specific chapters you can use:
*
* $book->withCondition(' chapter = 3 ')->ownPage
*
* This will return in the own list only the pages having 'chapter == 3'.
*
2014-10-13 09:24:53 +00:00
* @param string $sql SQL to be added to retrieval query (prefixed by AND)
* @param array $bindings array with parameters to bind to SQL snippet
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function withCondition( $sql, $bindings = array() )
{
$this->withSql = ' AND ' . $sql;
$this->withParams = $bindings;
2014-10-13 09:24:53 +00:00
return $this;
}
/**
* When prefix for a list, this causes the list to reload.
*
* @return self
*/
public function all()
{
$this->all = TRUE;
return $this;
}
2014-10-13 09:24:53 +00:00
/**
* Tells the bean to only access the list but not load
* its contents. Use this if you only want to add something to a list
* and you have no interest in retrieving its contents from the database.
*
* @return self
*/
public function noLoad()
{
$this->noLoad = TRUE;
return $this;
}
/**
* Prepares an own-list to use an alias. This is best explained using
* an example. Imagine a project and a person. The project always involves
* two persons: a teacher and a student. The person beans have been aliased in this
* case, so to the project has a teacher_id pointing to a person, and a student_id
* also pointing to a person. Given a project, we obtain the teacher like this:
*
* $project->fetchAs('person')->teacher;
*
* Now, if we want all projects of a teacher we cant say:
*
* $teacher->ownProject
*
* because the $teacher is a bean of type 'person' and no project has been
* assigned to a person. Instead we use the alias() method like this:
*
* $teacher->alias('teacher')->ownProject
*
* now we get the projects associated with the person bean aliased as
* a teacher.
*
* @param string $aliasName the alias name to use
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function alias( $aliasName )
{
$this->aliasName = $this->beau( $aliasName );
return $this;
}
/**
* Returns properties of bean as an array.
* This method returns the raw internal property list of the
* bean. Only use this method for optimization purposes. Otherwise
* use the export() method to export bean data to arrays.
*
* @return array
*/
public function getProperties()
{
return $this->properties;
}
2014-10-13 09:24:53 +00:00
/**
* Returns properties of bean as an array.
* This method returns the raw internal property list of the
* bean. Only use this method for optimization purposes. Otherwise
* use the export() method to export bean data to arrays.
* This method returns an array with the properties array and
* the type (string).
*
* @return array
*/
public function getPropertiesAndType()
{
return array( $this->properties, $this->__info['type'] );
}
/**
* Turns a camelcase property name into an underscored property name.
* Examples:
* oneACLRoute -> one_acl_route
* camelCase -> camel_case
*
* Also caches the result to improve performance.
*
* @param string $property
*
* @return string
*/
public function beau( $property )
{
static $beautifulColumns = array();
if ( ctype_lower( $property ) ) return $property;
if (
strpos( $property, 'own' ) === 0
2014-10-13 09:24:53 +00:00
|| strpos( $property, 'xown' ) === 0
|| strpos( $property, 'shared' ) === 0
) {
2014-10-13 09:24:53 +00:00
$property = preg_replace( '/List$/', '', $property );
return $property;
}
if ( !isset( $beautifulColumns[$property] ) ) {
2014-10-13 09:24:53 +00:00
$beautifulColumns[$property] = AQueryWriter::camelsSnake( $property );
}
return $beautifulColumns[$property];
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Clears all modifiers.
*
* @return self
*/
2014-10-13 09:24:53 +00:00
public function clearModifiers()
{
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
2014-10-13 09:24:53 +00:00
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
return $this;
}
/**
* Determines whether a list is opened in exclusive mode or not.
* If a list has been opened in exclusive mode this method will return TRUE,
* othwerwise it will return FALSE.
*
* @param string $listName name of the list to check
*
* @return boolean
*/
public function isListInExclusiveMode( $listName )
{
$listName = $this->beau( $listName );
if ( strpos( $listName, 'xown' ) === 0 && ctype_upper( substr( $listName, 4, 1 ) ) ) {
$listName = substr($listName, 1);
}
$listName = lcfirst( substr( $listName, 3 ) );
return ( isset( $this->__info['sys.exclusive-'.$listName] ) && $this->__info['sys.exclusive-'.$listName] );
}
/**
* Magic Getter. Gets the value for a specific property in the bean.
* If the property does not exist this getter will make sure no error
* occurs. This is because RedBean allows you to query (probe) for
* properties. If the property can not be found this method will
* return NULL instead.
*
* @param string $property name of the property you wish to obtain the value of
*
* @return mixed
*/
public function &__get( $property )
{
2014-10-13 09:24:53 +00:00
$isEx = FALSE;
$isOwn = FALSE;
$isShared = FALSE;
2014-10-13 09:24:53 +00:00
if ( !ctype_lower( $property ) ) {
$property = $this->beau( $property );
if ( strpos( $property, 'xown' ) === 0 && ctype_upper( substr( $property, 4, 1 ) ) ) {
$property = substr($property, 1);
$listName = lcfirst( substr( $property, 3 ) );
$isEx = TRUE;
$isOwn = TRUE;
$this->__info['sys.exclusive-'.$listName] = TRUE;
} elseif ( strpos( $property, 'own' ) === 0 && ctype_upper( substr( $property, 3, 1 ) ) ) {
$isOwn = TRUE;
$listName = lcfirst( substr( $property, 3 ) );
} elseif ( strpos( $property, 'shared' ) === 0 && ctype_upper( substr( $property, 6, 1 ) ) ) {
$isShared = TRUE;
}
}
2014-10-13 09:24:53 +00:00
$fieldLink = $property . '_id';
$exists = isset( $this->properties[$property] );
2014-10-13 09:24:53 +00:00
//If not exists and no field link and no list, bail out.
if ( !$exists && !isset($this->$fieldLink) && (!$isOwn && !$isShared )) {
2014-10-13 09:24:53 +00:00
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
2014-10-13 09:24:53 +00:00
$NULL = NULL;
return $NULL;
}
2014-10-13 09:24:53 +00:00
$hasAlias = (!is_null($this->aliasName));
$differentAlias = ($hasAlias && $isOwn && isset($this->__info['sys.alias.'.$listName])) ?
($this->__info['sys.alias.'.$listName] !== $this->aliasName) : FALSE;
$hasSQL = ($this->withSql !== '' || $this->via !== NULL);
$hasAll = (boolean) ($this->all);
//If exists and no list or exits and list not changed, bail out.
if ( $exists && ((!$isOwn && !$isShared ) || (!$hasSQL && !$differentAlias && !$hasAll)) ) {
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
return $this->properties[$property];
}
2014-10-13 09:24:53 +00:00
list( $redbean, , , $toolbox ) = $this->beanHelper->getExtractedToolbox();
2014-10-13 09:24:53 +00:00
if ( isset( $this->$fieldLink ) ) {
$this->__info['tainted'] = TRUE;
if ( isset( $this->__info["sys.parentcache.$property"] ) ) {
$bean = $this->__info["sys.parentcache.$property"];
2014-10-13 09:24:53 +00:00
} else {
if ( $this->fetchType ) {
$type = $this->fetchType;
$this->fetchType = NULL;
} else {
2014-10-13 09:24:53 +00:00
$type = $property;
}
2014-10-13 09:24:53 +00:00
$bean = $redbean->load( $type, $this->properties[$fieldLink] );
}
$this->properties[$property] = $bean;
2014-10-13 09:24:53 +00:00
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
return $this->properties[$property];
2014-10-13 09:24:53 +00:00
}
//Implicit: elseif ( $isOwn || $isShared ) {
if ( $this->noLoad ) {
$beans = array();
} elseif ( $isOwn ) {
$beans = $this->getOwnList( $listName, $redbean );
} else {
$beans = $this->getSharedList( lcfirst( substr( $property, 6 ) ), $redbean, $toolbox );
}
2014-10-13 09:24:53 +00:00
$this->properties[$property] = $beans;
$this->__info["sys.shadow.$property"] = $beans;
$this->__info['tainted'] = TRUE;
2014-10-13 09:24:53 +00:00
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
2014-10-13 09:24:53 +00:00
return $this->properties[$property];
}
/**
* Magic Setter. Sets the value for a specific property.
* This setter acts as a hook for OODB to mark beans as tainted.
* The tainted meta property can be retrieved using getMeta("tainted").
* The tainted meta property indicates whether a bean has been modified and
* can be used in various caching mechanisms.
*
* @param string $property name of the property you wish to assign a value to
* @param mixed $value the value you want to assign
*
* @return void
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
public function __set( $property, $value )
{
2014-10-13 09:24:53 +00:00
$isEx = FALSE;
$isOwn = FALSE;
$isShared = FALSE;
if ( !ctype_lower( $property ) ) {
$property = $this->beau( $property );
if ( strpos( $property, 'xown' ) === 0 && ctype_upper( substr( $property, 4, 1 ) ) ) {
$property = substr($property, 1);
$listName = lcfirst( substr( $property, 3 ) );
$isEx = TRUE;
$isOwn = TRUE;
$this->__info['sys.exclusive-'.$listName] = TRUE;
} elseif ( strpos( $property, 'own' ) === 0 && ctype_upper( substr( $property, 3, 1 ) ) ) {
$isOwn = TRUE;
$listName = lcfirst( substr( $property, 3 ) );
} elseif ( strpos( $property, 'shared' ) === 0 && ctype_upper( substr( $property, 6, 1 ) ) ) {
$isShared = TRUE;
}
}
2014-10-13 09:24:53 +00:00
$hasAlias = (!is_null($this->aliasName));
$differentAlias = ($hasAlias && $isOwn && isset($this->__info['sys.alias.'.$listName])) ?
($this->__info['sys.alias.'.$listName] !== $this->aliasName) : FALSE;
$hasSQL = ($this->withSql !== '' || $this->via !== NULL);
$exists = isset( $this->properties[$property] );
$fieldLink = $property . '_id';
if ( ($isOwn || $isShared) && (!$exists || $hasSQL || $differentAlias) ) {
2014-10-13 09:24:53 +00:00
if ( !$this->noLoad ) {
list( $redbean, , , $toolbox ) = $this->beanHelper->getExtractedToolbox();
if ( $isOwn ) {
$beans = $this->getOwnList( $listName, $redbean );
} else {
$beans = $this->getSharedList( lcfirst( substr( $property, 6 ) ), $redbean, $toolbox );
}
$this->__info["sys.shadow.$property"] = $beans;
}
}
2014-10-13 09:24:53 +00:00
$this->withSql = '';
$this->withParams = array();
$this->aliasName = NULL;
$this->fetchType = NULL;
$this->noLoad = FALSE;
$this->all = FALSE;
$this->via = NULL;
2014-10-13 09:24:53 +00:00
$this->__info['tainted'] = TRUE;
$this->__info['changed'] = TRUE;
2014-10-13 09:24:53 +00:00
if ( array_key_exists( $fieldLink, $this->properties ) && !( $value instanceof OODBBean ) ) {
if ( is_null( $value ) || $value === FALSE ) {
2014-10-13 09:24:53 +00:00
unset( $this->properties[ $property ]);
$this->properties[ $fieldLink ] = NULL;
return;
} else {
2014-10-13 09:24:53 +00:00
throw new RedException( 'Cannot cast to bean.' );
}
}
if ( $value === FALSE ) {
$value = '0';
} elseif ( $value === TRUE ) {
$value = '1';
2014-10-13 09:24:53 +00:00
} elseif ( $value instanceof \DateTime ) {
$value = $value->format( 'Y-m-d H:i:s' );
}
$this->properties[$property] = $value;
}
/**
* Sets a property directly, for internal use only.
*
* @param string $property property
* @param mixed $value value
* @param boolean $updateShadow whether you want to update the shadow
* @param boolean $taint whether you want to mark the bean as tainted
*
* @return void
*/
public function setProperty( $property, $value, $updateShadow = FALSE, $taint = FALSE )
{
$this->properties[$property] = $value;
if ( $updateShadow ) {
$this->__info['sys.shadow.' . $property] = $value;
}
if ( $taint ) {
$this->__info['tainted'] = TRUE;
2014-10-13 09:24:53 +00:00
$this->__info['changed'] = TRUE;
}
}
/**
* Returns the value of a meta property. A meta property
* contains extra information about the bean object that will not
* get stored in the database. Meta information is used to instruct
* RedBean as well as other systems how to deal with the bean.
* For instance: $bean->setMeta("buildcommand.unique", array(
* array("column1", "column2", "column3") ) );
* Will add a UNIQUE constraint for the bean on columns: column1, column2 and
* column 3.
* To access a Meta property we use a dot separated notation.
* If the property cannot be found this getter will return NULL instead.
*
* @param string $path path
* @param mixed $default default value
*
* @return mixed
*/
public function getMeta( $path, $default = NULL )
{
return ( isset( $this->__info[$path] ) ) ? $this->__info[$path] : $default;
}
/**
* Stores a value in the specified Meta information property. $value contains
* the value you want to store in the Meta section of the bean and $path
* specifies the dot separated path to the property. For instance "my.meta.property".
* If "my" and "meta" do not exist they will be created automatically.
*
* @param string $path path
* @param mixed $value value
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function setMeta( $path, $value )
{
$this->__info[$path] = $value;
return $this;
}
/**
* Copies the meta information of the specified bean
* This is a convenience method to enable you to
* exchange meta information easily.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function copyMetaFrom( OODBBean $bean )
{
$this->__info = $bean->__info;
return $this;
}
/**
* Sends the call to the registered model.
*
* @param string $method name of the method
* @param array $args argument list
*
* @return mixed
*/
public function __call( $method, $args )
{
if ( !isset( $this->__info['model'] ) ) {
$model = $this->beanHelper->getModelForBean( $this );
if ( !$model ) {
return NULL;
}
$this->__info['model'] = $model;
}
if ( !method_exists( $this->__info['model'], $method ) ) {
return NULL;
}
return call_user_func_array( array( $this->__info['model'], $method ), $args );
}
/**
* Implementation of __toString Method
* Routes call to Model. If the model implements a __toString() method this
2014-10-13 09:24:53 +00:00
* method will be called and the result will be returned. In case of an
* echo-statement this result will be printed. If the model does not
* implement a __toString method, this method will return a JSON
* representation of the current bean.
*
* @return string
*/
public function __toString()
{
$string = $this->__call( '__toString', array() );
if ( $string === NULL ) {
return json_encode( $this->properties );
} else {
return $string;
}
}
/**
* Implementation of Array Access Interface, you can access bean objects
* like an array.
* Call gets routed to __set.
*
* @param mixed $offset offset string
* @param mixed $value value
*
* @return void
*/
public function offsetSet( $offset, $value )
{
$this->__set( $offset, $value );
}
/**
* Implementation of Array Access Interface, you can access bean objects
* like an array.
*
2014-10-13 09:24:53 +00:00
* Array functions do not reveal x-own-lists and list-alias because
* you dont want duplicate entries in foreach-loops.
* Also offers a slight performance improvement for array access.
*
* @param mixed $offset property
*
* @return boolean
*/
public function offsetExists( $offset )
{
2014-10-13 09:24:53 +00:00
return $this->__isset( $offset );
}
/**
* Implementation of Array Access Interface, you can access bean objects
* like an array.
* Unsets a value from the array/bean.
*
2014-10-13 09:24:53 +00:00
* Array functions do not reveal x-own-lists and list-alias because
* you dont want duplicate entries in foreach-loops.
* Also offers a slight performance improvement for array access.
*
* @param mixed $offset property
*
* @return void
*/
public function offsetUnset( $offset )
{
2014-10-13 09:24:53 +00:00
$this->__unset( $offset );
}
/**
* Implementation of Array Access Interface, you can access bean objects
* like an array.
* Returns value of a property.
*
2014-10-13 09:24:53 +00:00
* Array functions do not reveal x-own-lists and list-alias because
* you dont want duplicate entries in foreach-loops.
* Also offers a slight performance improvement for array access.
*
* @param mixed $offset property
*
* @return mixed
*/
2014-10-13 09:24:53 +00:00
public function &offsetGet( $offset )
{
return $this->__get( $offset );
}
/**
* Chainable method to cast a certain ID to a bean; for instance:
* $person = $club->fetchAs('person')->member;
* This will load a bean of type person using member_id as ID.
*
* @param string $type preferred fetch type
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function fetchAs( $type )
{
$this->fetchType = $type;
return $this;
}
/**
* For polymorphic bean relations.
* Same as fetchAs but uses a column instead of a direct value.
*
* @param string $column
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function poly( $field )
{
return $this->fetchAs( $this->$field );
}
/**
2014-10-13 09:24:53 +00:00
* Traverses a bean property with the specified function.
* Recursively iterates through the property invoking the
* function for each bean along the way passing the bean to it.
*
2014-10-13 09:24:53 +00:00
* Can be used together with with, withCondition, alias and fetchAs.
*
2014-10-13 09:24:53 +00:00
* @param string $property property
* @param closure $function function
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function traverse( $property, $function, $maxDepth = NULL )
{
2014-10-13 09:24:53 +00:00
$this->via = NULL;
if ( strpos( $property, 'shared' ) !== FALSE ) {
throw new RedException( 'Traverse only works with (x)own-lists.' );
}
if ( !is_null( $maxDepth ) ) {
if ( !$maxDepth-- ) return $this;
}
$oldFetchType = $this->fetchType;
$oldAliasName = $this->aliasName;
$oldWith = $this->withSql;
$oldBindings = $this->withParams;
2014-10-13 09:24:53 +00:00
$beans = $this->$property;
2014-10-13 09:24:53 +00:00
if ( $beans === NULL ) return $this;
2014-10-13 09:24:53 +00:00
if ( !is_array( $beans ) ) $beans = array( $beans );
2014-10-13 09:24:53 +00:00
foreach( $beans as $bean ) {
2014-10-13 09:24:53 +00:00
$function( $bean );
$bean->fetchType = $oldFetchType;
$bean->aliasName = $oldAliasName;
$bean->withSql = $oldWith;
$bean->withParams = $oldBindings;
2014-10-13 09:24:53 +00:00
$bean->traverse( $property, $function, $maxDepth );
}
2014-10-13 09:24:53 +00:00
return $this;
}
/**
2014-10-13 09:24:53 +00:00
* Implementation of\Countable interface. Makes it possible to use
* count() function on a bean.
*
* @return integer
*/
public function count()
{
return count( $this->properties );
}
/**
* Checks whether a bean is empty or not.
* A bean is empty if it has no other properties than the id field OR
* if all the other property are empty().
*
* @return boolean
*/
public function isEmpty()
{
$empty = TRUE;
foreach ( $this->properties as $key => $value ) {
if ( $key == 'id' ) {
continue;
}
if ( !empty( $value ) ) {
$empty = FALSE;
}
}
return $empty;
}
/**
* Chainable setter.
*
* @param string $property the property of the bean
* @param mixed $value the value you want to set
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function setAttr( $property, $value )
{
$this->$property = $value;
return $this;
}
/**
* Comfort method.
* Unsets all properties in array.
*
* @param array $properties properties you want to unset.
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function unsetAll( $properties )
{
foreach ( $properties as $prop ) {
if ( isset( $this->properties[$prop] ) ) {
unset( $this->properties[$prop] );
}
}
return $this;
}
/**
* Returns original (old) value of a property.
* You can use this method to see what has changed in a
* bean.
*
* @param string $property name of the property you want the old value of
*
* @return mixed
*/
public function old( $property )
{
$old = $this->getMeta( 'sys.orig', array() );
if ( array_key_exists( $property, $old ) ) {
return $old[$property];
}
return NULL;
}
/**
* Convenience method.
* Returns TRUE if the bean has been changed, or FALSE otherwise.
* Same as $bean->getMeta('tainted');
* Note that a bean becomes tainted as soon as you retrieve a list from
* the bean. This is because the bean lists are arrays and the bean cannot
* determine whether you have made modifications to a list so RedBeanPHP
* will mark the whole bean as tainted.
*
* @return boolean
*/
public function isTainted()
{
return $this->getMeta( 'tainted' );
}
/**
* Returns TRUE if the value of a certain property of the bean has been changed and
* FALSE otherwise.
*
* @param string $property name of the property you want the change-status of
*
* @return boolean
*/
public function hasChanged( $property )
{
return ( array_key_exists( $property, $this->properties ) ) ?
$this->old( $property ) != $this->properties[$property] : FALSE;
}
/**
* Creates a N-M relation by linking an intermediate bean.
* This method can be used to quickly connect beans using indirect
* relations. For instance, given an album and a song you can connect the two
* using a track with a number like this:
*
* Usage:
*
* $album->link('track', array('number'=>1))->song = $song;
*
* or:
*
* $album->link($trackBean)->song = $song;
*
* What this method does is adding the link bean to the own-list, in this case
* ownTrack. If the first argument is a string and the second is an array or
* a JSON string then the linking bean gets dispensed on-the-fly as seen in
* example #1. After preparing the linking bean, the bean is returned thus
* allowing the chained setter: ->song = $song.
*
2014-10-13 09:24:53 +00:00
* @param string|OODBBean $type type of bean to dispense or the full bean
* @param string|array $qualification JSON string or array (optional)
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function link( $typeOrBean, $qualification = array() )
{
if ( is_string( $typeOrBean ) ) {
2014-10-13 09:24:53 +00:00
$typeOrBean = AQueryWriter::camelsSnake( $typeOrBean );
$bean = $this->beanHelper->getToolBox()->getRedBean()->dispense( $typeOrBean );
if ( is_string( $qualification ) ) {
$data = json_decode( $qualification, TRUE );
} else {
$data = $qualification;
}
foreach ( $data as $key => $value ) {
$bean->$key = $value;
}
} else {
$bean = $typeOrBean;
}
$list = 'own' . ucfirst( $bean->getMeta( 'type' ) );
array_push( $this->$list, $bean );
return $bean;
}
/**
* Returns the same bean freshly loaded from the database.
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function fresh()
{
return $this->beanHelper->getToolbox()->getRedBean()->load( $this->getMeta( 'type' ), $this->properties['id'] );
}
/**
* Registers a association renaming globally.
*
* @param string $via type you wish to use for shared lists
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function via( $via )
{
2014-10-13 09:24:53 +00:00
$this->via = AQueryWriter::camelsSnake( $via );
return $this;
}
/**
* Counts all own beans of type $type.
* Also works with alias(), with() and withCondition().
*
* @param string $type the type of bean you want to count
*
* @return integer
*/
public function countOwn( $type )
{
$type = $this->beau( $type );
if ( $this->aliasName ) {
$myFieldLink = $this->aliasName . '_id';
$this->aliasName = NULL;
} else {
$myFieldLink = $this->__info['type'] . '_id';
}
$count = 0;
2014-10-13 09:24:53 +00:00
if ( $this->getID() ) {
$firstKey = NULL;
if ( count( $this->withParams ) > 0 ) {
reset( $this->withParams );
$firstKey = key( $this->withParams );
}
if ( !is_numeric( $firstKey ) || $firstKey === NULL ) {
$bindings = $this->withParams;
$bindings[':slot0'] = $this->getID();
$count = $this->beanHelper->getToolbox()->getWriter()->queryRecordCount( $type, array(), " $myFieldLink = :slot0 " . $this->withSql, $bindings );
} else {
$bindings = array_merge( array( $this->getID() ), $this->withParams );
$count = $this->beanHelper->getToolbox()->getWriter()->queryRecordCount( $type, array(), " $myFieldLink = ? " . $this->withSql, $bindings );
}
}
2014-10-13 09:24:53 +00:00
$this->clearModifiers();
return (int) $count;
}
/**
* Counts all shared beans of type $type.
* Also works with via(), with() and withCondition().
*
* @param string $type type of bean you wish to count
*
* @return integer
*/
public function countShared( $type )
{
$toolbox = $this->beanHelper->getToolbox();
$redbean = $toolbox->getRedBean();
$writer = $toolbox->getWriter();
if ( $this->via ) {
$oldName = $writer->getAssocTable( array( $this->__info['type'], $type ) );
if ( $oldName !== $this->via ) {
//set the new renaming rule
$writer->renameAssocTable( $oldName, $this->via );
$this->via = NULL;
}
}
$type = $this->beau( $type );
$count = 0;
2014-10-13 09:24:53 +00:00
if ( $this->getID() ) {
$count = $redbean->getAssociationManager()->relatedCount( $this, $type, $this->withSql, $this->withParams, TRUE );
}
2014-10-13 09:24:53 +00:00
$this->clearModifiers();
return (integer) $count;
}
2014-10-13 09:24:53 +00:00
/**
* Iterates through the specified own-list and
* fetches all properties (with their type) and
* returns the references.
* Use this method to quickly load indirectly related
* beans in an own-list. Whenever you cannot use a
* shared-list this method offers the same convenience
* by aggregating the parent beans of all children in
* the specified own-list.
*
* Example:
*
* $quest->aggr( 'xownQuestTarget', 'target', 'quest' );
*
* Loads (in batch) and returns references to all
* quest beans residing in the $questTarget->target properties
* of each element in the xownQuestTargetList.
*
* @param string $list the list you wish to process
* @param string $property the property to load
* @param string $type the type of bean residing in this property (optional)
*
* @return array
*/
public function &aggr( $list, $property, $type = NULL )
{
$this->via = NULL;
$ids = $beanIndex = $references = array();
if ( strlen( $list ) < 4 ) throw new RedException('Invalid own-list.');
if ( strpos( $list, 'own') !== 0 ) throw new RedException('Only own-lists can be aggregated.');
if ( !ctype_upper( substr( $list, 3, 1 ) ) ) throw new RedException('Invalid own-list.');
if ( is_null( $type ) ) $type = $property;
foreach( $this->$list as $bean ) {
$field = $property . '_id';
if ( isset( $bean->$field) ) {
$ids[] = $bean->$field;
$beanIndex[$bean->$field] = $bean;
}
}
$beans = $this->beanHelper->getToolBox()->getRedBean()->batch( $type, $ids );
//now preload the beans as well
foreach( $beans as $bean ) {
$beanIndex[$bean->id]->setProperty( $property, $bean );
}
foreach( $beanIndex as $indexedBean ) {
$references[] = $indexedBean->$property;
}
return $references;
}
/**
* Tests whether the database identities of two beans are equal.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean other bean
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function equals(OODBBean $bean)
{
return (bool) (
( (string) $this->properties['id'] === (string) $bean->properties['id'] )
&& ( (string) $this->__info['type'] === (string) $bean->__info['type'] )
);
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\Observer as Observer;
/**
* Observable
* Base class for Observables
*
* @file RedBean/Observable.php
* @description Part of the observer pattern in RedBean
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
abstract class Observable { //bracket must be here - otherwise coverage software does not understand.
/**
* @var array
*/
private $observers = array();
/**
* Implementation of the Observer Pattern.
* Adds an event listener to the observable object.
* First argument should be the name of the event you wish to listen for.
* Second argument should be the object that wants to be notified in case
* the event occurs.
*
* @param string $eventname event identifier
2014-10-13 09:24:53 +00:00
* @param Observer $observer observer instance
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function addEventListener( $eventname, Observer $observer )
{
if ( !isset( $this->observers[$eventname] ) ) {
$this->observers[$eventname] = array();
}
foreach ( $this->observers[$eventname] as $o ) {
if ( $o == $observer ) {
return;
}
}
$this->observers[$eventname][] = $observer;
}
/**
* Notifies listeners.
* Sends the signal $eventname, the event identifier and a message object
* to all observers that have been registered to receive notification for
* this event. Part of the observer pattern implementation in RedBeanPHP.
*
* @param string $eventname event you want signal
* @param mixed $info message object to send along
*
* @return void
*/
public function signal( $eventname, $info )
{
if ( !isset( $this->observers[$eventname] ) ) {
$this->observers[$eventname] = array();
}
foreach ( $this->observers[$eventname] as $observer ) {
$observer->onEvent( $eventname, $info );
}
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
/**
* Observer
* Interface for Observer object. Implementation of the
* observer pattern.
*
* @file RedBean/Observer.php
* @desc Part of the observer pattern in RedBean
* @author Gabor de Mooijand the RedBeanPHP community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface Observer
{
/**
* An observer object needs to be capable of receiving
* notifications. Therefore the observer needs to implement the
* onEvent method with two parameters, the event identifier specifying the
* current event and a message object (in RedBeanPHP this can also be a bean).
*
* @param string $eventname event identifier
* @param mixed $bean a message sent along with the notification
*
* @return void
*/
public function onEvent( $eventname, $bean );
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
/**
* Adapter Interface
*
* @file RedBean/Adapter.php
* @desc Describes the API for a RedBean Database Adapter.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface Adapter
{
/**
* Returns the latest SQL statement
*
* @return string
*/
public function getSQL();
/**
* Executes an SQL Statement using an array of values to bind
* If $noevent is TRUE then this function will not signal its
* observers to notify about the SQL execution; this to prevent
* infinite recursion when using observers.
*
* @param string $sql SQL
* @param array $bindings values
* @param boolean $noevent no event firing
*/
public function exec( $sql, $bindings = array(), $noevent = FALSE );
/**
* Executes an SQL Query and returns a resultset.
* This method returns a multi dimensional resultset similar to getAll
* The values array can be used to bind values to the place holders in the
* SQL query.
*
* @param string $sql SQL
* @param array $bindings values
*
* @return array
*/
public function get( $sql, $bindings = array() );
/**
* Executes an SQL Query and returns a resultset.
* This method returns a single row (one array) resultset.
* The values array can be used to bind values to the place holders in the
* SQL query.
*
* @param string $sql SQL
* @param array $bindings values to bind
*
* @return array
*/
public function getRow( $sql, $bindings = array() );
/**
* Executes an SQL Query and returns a resultset.
* This method returns a single column (one array) resultset.
* The values array can be used to bind values to the place holders in the
* SQL query.
*
* @param string $sql SQL
* @param array $bindings values to bind
*
* @return array
*/
public function getCol( $sql, $bindings = array() );
/**
* Executes an SQL Query and returns a resultset.
* This method returns a single cell, a scalar value as the resultset.
* The values array can be used to bind values to the place holders in the
* SQL query.
*
* @param string $sql SQL
* @param array $bindings values to bind
*
* @return string
*/
public function getCell( $sql, $bindings = array() );
/**
* Executes the SQL query specified in $sql and takes
* the first two columns of the resultset. This function transforms the
* resultset into an associative array. Values from the the first column will
* serve as keys while the values of the second column will be used as values.
* The values array can be used to bind values to the place holders in the
* SQL query.
*
* @param string $sql SQL
* @param array $bindings values to bind
*
* @return array
*/
public function getAssoc( $sql, $bindings = array() );
/**
* Executes the SQL query specified in $sql and indexes
* the row by the first column.
*
* @param string $sql SQL
* @param array $bindings values to bind
*
* @return array
*/
public function getAssocRow( $sql, $bindings = array() );
/**
* Returns the latest insert ID.
*
* @return integer
*/
public function getInsertID();
/**
* Returns the number of rows that have been
* affected by the last update statement.
*
* @return integer
*/
public function getAffectedRows();
/**
* Returns the original database resource. This is useful if you want to
* perform operations on the driver directly instead of working with the
* adapter. RedBean will only access the adapter and never to talk
* directly to the driver though.
*
* @return object
*/
public function getDatabase();
/**
* This method is part of the RedBean Transaction Management
* mechanisms.
* Starts a transaction.
*
* @return void
*/
public function startTransaction();
/**
* This method is part of the RedBean Transaction Management
* mechanisms.
* Commits the transaction.
*
* @return void
*/
public function commit();
/**
* This method is part of the RedBean Transaction Management
* mechanisms.
* Rolls back the transaction.
*
* @return void
*/
public function rollback();
/**
* Closes database connection.
*
* @return void
*/
public function close();
}
2014-10-13 09:24:53 +00:00
}
namespace RedBeanPHP\Adapter {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\Adapter as Adapter;
use RedBeanPHP\Driver as Driver;
2014-10-13 09:24:53 +00:00
/**
* DBAdapter (Database Adapter)
*
* @file RedBean/Adapter/DBAdapter.php
* @desc An adapter class to connect various database systems to RedBean
* @author Gabor de Mooij and the RedBeanPHP Community.
* @license BSD/GPLv2
*
* Database Adapter Class.
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class DBAdapter extends Observable implements Adapter
{
/**
2014-10-13 09:24:53 +00:00
* @var Driver
*/
private $db = NULL;
/**
* @var string
*/
private $sql = '';
/**
* Constructor.
*
* Creates an instance of the RedBean Adapter Class.
* This class provides an interface for RedBean to work
* with ADO compatible DB instances.
*
2014-10-13 09:24:53 +00:00
* @param Driver $database ADO Compatible DB Instance
*/
public function __construct( $database )
{
$this->db = $database;
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getSQL
*/
public function getSQL()
{
return $this->sql;
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::exec
*/
public function exec( $sql, $bindings = array(), $noevent = FALSE )
{
if ( !$noevent ) {
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
}
return $this->db->Execute( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::get
*/
public function get( $sql, $bindings = array() )
{
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
return $this->db->GetAll( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getRow
*/
public function getRow( $sql, $bindings = array() )
{
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
return $this->db->GetRow( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getCol
*/
public function getCol( $sql, $bindings = array() )
{
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
return $this->db->GetCol( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getAssoc
*/
public function getAssoc( $sql, $bindings = array() )
{
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
$rows = $this->db->GetAll( $sql, $bindings );
$assoc = array();
if ( !$rows ) {
return $assoc;
}
foreach ( $rows as $row ) {
if ( empty( $row ) ) continue;
if ( count( $row ) > 1 ) {
$key = array_shift( $row );
$value = array_shift( $row );
} else {
$key = array_shift( $row );
$value = $key;
}
$assoc[$key] = $value;
}
return $assoc;
}
/**
* @see Adapter::getAssocRow
*/
public function getAssocRow($sql, $bindings = array())
{
$this->sql = $sql;
$this->signal( 'sql_exec', $this );
return $this->db->GetAssocRow( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getCell
*/
public function getCell( $sql, $bindings = array(), $noSignal = NULL )
{
$this->sql = $sql;
if ( !$noSignal ) $this->signal( 'sql_exec', $this );
$arr = $this->db->getCol( $sql, $bindings );
if ( $arr && is_array( $arr ) && isset( $arr[0] ) ) {
return ( $arr[0] );
}
return NULL;
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getInsertID
*/
public function getInsertID()
{
return $this->db->getInsertID();
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getAffectedRows
*/
public function getAffectedRows()
{
return $this->db->Affected_Rows();
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::getDatabase
*/
public function getDatabase()
{
return $this->db;
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::startTransaction
*/
public function startTransaction()
{
$this->db->StartTrans();
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::commit
*/
public function commit()
{
$this->db->CommitTrans();
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::rollback
*/
public function rollback()
{
$this->db->FailTrans();
}
/**
2014-10-13 09:24:53 +00:00
* @see Adapter::close.
*/
public function close()
{
$this->db->close();
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
/**
* QueryWriter
* Interface for QueryWriters
*
* @file RedBean/QueryWriter.php
* @desc Describes the API for a QueryWriter
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* Notes:
* - Whenever you see a parameter called $table or $type you should always
* be aware of the fact that this argument contains a Bean Type string, not the
* actual table name. These raw type names are passed to safeTable() to obtain the
* actual name of the database table. Don't let the names confuse you $type/$table
* refers to Bean Type, not physical database table names!
* - This is the interface for FLUID database drivers. Drivers intended to support
* just FROZEN mode should implement the IceWriter instead.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface QueryWriter
{
2014-10-13 09:24:53 +00:00
/**
* SQL filter constants
*/
const C_SQLFILTER_READ = 'r';
const C_SQLFILTER_WRITE = 'w';
/**
* Query Writer constants.
*/
const C_SQLSTATE_NO_SUCH_TABLE = 1;
const C_SQLSTATE_NO_SUCH_COLUMN = 2;
const C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION = 3;
/**
* Define data type regions
*
* 00 - 80: normal data types
* 80 - 99: special data types, only scan/code if requested
* 99 : specified by user, don't change
*/
const C_DATATYPE_RANGE_SPECIAL = 80;
const C_DATATYPE_RANGE_SPECIFIED = 99;
/**
* Define GLUE types for use with glueSQLCondition methods.
* Determines how to prefix a snippet of SQL before appending it
* to other SQL (or integrating it, mixing it otherwise).
2014-10-13 09:24:53 +00:00
*
* WHERE - glue as WHERE condition
* AND - glue as AND condition
*/
const C_GLUE_WHERE = 1;
const C_GLUE_AND = 2;
2014-10-13 09:24:53 +00:00
/**
* Writes an SQL Snippet for a JOIN, returns the
* SQL snippet string.
*
* @param string $type source type
* @param string $targetType target type (type to join)
* @param string $leftRight type of join (possible: 'LEFT', 'RIGHT' or 'INNER').
*
* @return string $joinSQLSnippet
*/
public function writeJoin( $type, $targetType, $joinType );
/**
* Glues an SQL snippet to the beginning of a WHERE clause.
* This ensures users don't have to add WHERE to their query snippets.
*
2014-10-13 09:24:53 +00:00
* The snippet gets prefixed with WHERE or AND
* if it starts with a condition.
2014-10-13 09:24:53 +00:00
*
* If the snippet does NOT start with a condition (or this function thinks so)
* the snippet is returned as-is.
2014-10-13 09:24:53 +00:00
*
* The GLUE type determines the prefix:
2014-10-13 09:24:53 +00:00
*
* - NONE prefixes with WHERE
2014-10-13 09:24:53 +00:00
* - WHERE prefixes with WHERE and replaces AND if snippets starts with AND
* - AND prefixes with AND
2014-10-13 09:24:53 +00:00
*
* This method will never replace WHERE with AND since a snippet should never
* begin with WHERE in the first place. OR is not supported.
2014-10-13 09:24:53 +00:00
*
* Only a limited set of clauses will be recognized as non-conditions.
* For instance beginning a snippet with complex statements like JOIN or UNION
* will not work. This is too complex for use in a snippet.
*
* @param string $sql SQL Snippet
* @param integer $glue the GLUE type - how to glue (C_GLUE_WHERE or C_GLUE_AND)
2014-10-13 09:24:53 +00:00
*
* @return string
*/
public function glueSQLCondition( $sql, $glue = NULL );
2014-10-13 09:24:53 +00:00
/**
* Determines if there is a LIMIT 1 clause in the SQL.
* If not, it will add a LIMIT 1. (used for findOne).
*
* @param string $sql query to scan and adjust
*
* @return string
*/
public function glueLimitOne( $sql );
/**
* Returns the tables that are in the database.
*
* @return array
*/
public function getTables();
/**
* This method will create a table for the bean.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type type of bean you want to create a table for
*
* @return void
*/
public function createTable( $type );
/**
* Returns an array containing all the columns of the specified type.
* The format of the return array looks like this:
* $field => $type where $field is the name of the column and $type
* is a database specific description of the datatype.
*
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type type of bean you want to obtain a column list of
*
* @return array
*/
public function getColumns( $type );
/**
* Returns the Column Type Code (integer) that corresponds
* to the given value type. This method is used to determine the minimum
* column type required to represent the given value.
*
* @param string $value value
*
* @return integer
*/
public function scanType( $value, $alsoScanSpecialForTypes = FALSE );
/**
* This method will add a column to a table.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type name of the table
* @param string $column name of the column
* @param integer $field data type for field
*
* @return void
*/
public function addColumn( $type, $column, $field );
/**
* Returns the Type Code for a Column Description.
* Given an SQL column description this method will return the corresponding
* code for the writer. If the include specials flag is set it will also
* return codes for special columns. Otherwise special columns will be identified
* as specified columns.
*
* @param string $typedescription description
* @param boolean $includeSpecials whether you want to get codes for special columns as well
*
* @return integer
*/
public function code( $typedescription, $includeSpecials = FALSE );
/**
* This method will widen the column to the specified data type.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type type / table that needs to be adjusted
* @param string $column column that needs to be altered
* @param integer $datatype target data type
*
* @return void
*/
public function widenColumn( $type, $column, $datatype );
/**
* Selects records from the database.
* This methods selects the records from the database that match the specified
* type, conditions (optional) and additional SQL snippet (optional).
*
* @param string $type name of the table you want to query
* @param array $conditions criteria ( $column => array( $values ) )
* @param string $addSQL additional SQL snippet
* @param array $bindings bindings for SQL snippet
*
* @return array
*/
public function queryRecord( $type, $conditions = array(), $addSql = NULL, $bindings = array() );
/**
* Returns records through an intermediate type. This method is used to obtain records using a link table and
* allows the SQL snippets to reference columns in the link table for additional filtering or ordering.
*
* @param string $sourceType source type, the reference type you want to use to fetch related items on the other side
* @param string $destType destination type, the target type you want to get beans of
* @param mixed $linkID ID to use for the link table
* @param string $addSql Additional SQL snippet
* @param array $bindings Bindings for SQL snippet
*
* @return array
*/
public function queryRecordRelated( $sourceType, $destType, $linkID, $addSql = '', $bindings = array() );
/**
* Returns the row that links $sourceType $sourcID to $destType $destID in an N-M relation.
*
* @param string $sourceType source type, the first part of the link you're looking for
* @param string $destType destination type, the second part of the link you're looking for
* @param string $sourceID ID for the source
* @param string $destID ID for the destination
*
* @return array|null
*/
public function queryRecordLink( $sourceType, $destType, $sourceID, $destID );
/**
* Counts the number of records in the database that match the
* conditions and additional SQL.
*
* @param string $type name of the table you want to query
* @param array $conditions criteria ( $column => array( $values ) )
* @param string $addSQL additional SQL snippet
* @param array $bindings bindings for SQL snippet
*
* @return integer
*/
public function queryRecordCount( $type, $conditions = array(), $addSql = NULL, $bindings = array() );
/**
* Returns the number of records linked through $linkType and satisfying the SQL in $addSQL/$bindings.
*
* @param string $sourceType source type
* @param string $targetType the thing you want to count
* @param mixed $linkID the of the source type
* @param string $addSQL additional SQL snippet
* @param array $bindings bindings for SQL snippet
*
* @return integer
*/
public function queryRecordCountRelated( $sourceType, $targetType, $linkID, $addSQL = '', $bindings = array() );
2014-10-13 09:24:53 +00:00
/**
* Returns all rows of specified type that have been tagged with one of the
* strings in the specified tag list array.
*
* Note that the additional SQL snippet can only be used for pagination,
* the SQL snippet will be appended to the end of the query.
*
* @param string $type the bean type you want to query
* @param array $tagList an array of strings, each string containing a tag title
* @param boolean $all if TRUE only return records that have been associated with ALL the tags in the list
* @param string $addSql addition SQL snippet, for pagination
* @param array $bindings parameter bindings for additional SQL snippet
*
* @return array
*/
public function queryTagged( $type, $tagList, $all = FALSE, $addSql = '', $bindings = array() );
/**
* This method should update (or insert a record), it takes
* a table name, a list of update values ( $field => $value ) and an
* primary key ID (optional). If no primary key ID is provided, an
* INSERT will take place.
* Returns the new ID.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type name of the table to update
* @param array $updatevalues list of update values
* @param integer $id optional primary key ID value
*
* @return integer
*/
public function updateRecord( $type, $updatevalues, $id = NULL );
/**
* Deletes records from the database.
* @note $addSql is always prefixed with ' WHERE ' or ' AND .'
*
* @param string $type name of the table you want to query
* @param array $conditions criteria ( $column => array( $values ) )
* @param string $sql additional SQL
* @param array $bindings bindings
*
* @return void
*/
public function deleteRecord( $type, $conditions = array(), $addSql = '', $bindings = array() );
/**
* Deletes all links between $sourceType and $destType in an N-M relation.
*
* @param string $sourceType source type
* @param string $destType destination type
* @param string $sourceID source ID
*
* @return void
*/
public function deleteRelations( $sourceType, $destType, $sourceID );
/**
* This method will add a UNIQUE constraint index to a table on columns $columns.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type type
* @param array $columnsPartOfIndex columns to include in index
*
* @return void
*/
public function addUniqueIndex( $type, $columns );
/**
* This method will check whether the SQL state is in the list of specified states
* and returns TRUE if it does appear in this list or FALSE if it
* does not. The purpose of this method is to translate the database specific state to
* a one of the constants defined in this class and then check whether it is in the list
* of standard states provided.
*
* @param string $state sql state
* @param array $list list
*
* @return boolean
*/
public function sqlStateIn( $state, $list );
/**
* This method will remove all beans of a certain type.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type bean type
*
* @return void
*/
public function wipe( $type );
/**
* Given two types this method will add a foreign key constraint.
*
* @param string $sourceType source type
* @param string $destType destination type
*
* @return void
*/
public function addConstraintForTypes( $sourceType, $destType );
/**
* This method will add a foreign key from type and field to
* target type and target field.
* The foreign key is created without an action. On delete/update
* no action will be triggered. The FK is only used to allow database
* tools to generate pretty diagrams and to make it easy to add actions
* later on.
* This methods accepts a type and infers the corresponding table name.
*
*
2014-10-13 09:24:53 +00:00
* @param string $type type that will have a foreign key field
* @param string $targetType points to this type
* @param string $field field that contains the foreign key value
* @param string $targetField field where the fk points to
* @param string $isDep whether target is dependent and should cascade on update/delete
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function addFK( $type, $targetType, $field, $targetField, $isDep = false );
/**
* This method will add an index to a type and field with name
* $name.
* This methods accepts a type and infers the corresponding table name.
*
* @param string $type type to add index to
* @param string $name name of the new index
* @param string $column field to index
*
* @return void
*/
public function addIndex( $type, $name, $column );
/**
* Checks and filters a database structure element like a table of column
* for safe use in a query. A database structure has to conform to the
* RedBeanPHP DB security policy which basically means only alphanumeric
* symbols are allowed. This security policy is more strict than conventional
* SQL policies and does therefore not require database specific escaping rules.
*
* @param string $databaseStructure name of the column/table to check
* @param boolean $noQuotes TRUE to NOT put backticks or quotes around the string
*
* @return string
*/
public function esc( $databaseStructure, $dontQuote = FALSE );
/**
* Removes all tables and views from the database.
*
* @return void
*/
public function wipeAll();
/**
* Renames an association. For instance if you would like to refer to
* album_song as: track you can specify this by calling this method like:
*
* renameAssociation('album_song','track')
*
* This allows:
*
* $album->sharedSong
*
* to add/retrieve beans from track instead of album_song.
* Also works for exportAll().
*
* This method also accepts a single associative array as
* its first argument.
*
* @param string|array $from
* @param string $to (optional)
*
* @return void
*/
public function renameAssocTable( $from, $to = NULL );
/**
* Returns the format for link tables.
* Given an array containing two type names this method returns the
* name of the link table to be used to store and retrieve
* association records.
*
* @param array $types two types array($type1, $type2)
*
* @return string
*/
public function getAssocTable( $types );
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\QueryWriter {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\OODBBean as OODBBean;
/**
* RedBean Abstract Query Writer
*
* @file RedBean/QueryWriter/AQueryWriter.php
* @desc Query Writer (abstract class)
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* Represents an abstract Database to RedBean
* To write a driver for a different database for RedBean
* Contains a number of functions all implementors can
* inherit or override.
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
abstract class AQueryWriter { //bracket must be here - otherwise coverage software does not understand.
/**
* @var DBAdapter
*/
protected $adapter;
/**
* @var string
*/
protected $defaultValue = 'NULL';
/**
* @var string
*/
protected $quoteCharacter = '';
/**
* @var boolean
*/
2014-10-13 09:24:53 +00:00
protected $flagUseCache = TRUE;
/**
* @var array
*/
protected $cache = array();
/**
* @var array
*/
2014-10-13 09:24:53 +00:00
public static $renames = array();
/**
* @var array
*/
private static $sqlFilters = array();
/**
* @var boolean
*/
private static $flagSQLFilterSafeMode = false;
/**
* @var boolean
*/
private static $flagNarrowFieldMode = true;
/**
* @var array
*/
public $typeno_sqltype = array();
2014-10-13 09:24:53 +00:00
/**
* Clears renames.
*
* @return void
*/
public static function clearRenames()
{
self::$renames = array();
}
/**
* Toggles 'Narrow Field Mode'.
* In Narrow Field mode the queryRecord method will
* narrow its selection field to
*
* SELECT {table}.*
*
* instead of
*
* SELECT *
*
* This is a better way of querying because it allows
* more flexibility (for instance joins). However if you need
* the wide selector for backward compatibility; use this method
* to turn OFF Narrow Field Mode by passing FALSE.
*
* @param boolean $narrowField TRUE = Narrow Field FALSE = Wide Field
*
* @return void
*/
public static function setNarrowFieldMode( $narrowField )
{
self::$flagNarrowFieldMode = (boolean) $narrowField;
}
/**
* Sets SQL filters.
* This is a lowlevel method to set the SQL filter array.
* The format of this array is:
*
* array(
* '<MODE, i.e. 'r' for read, 'w' for write>' => array(
* '<TABLE NAME>' => array(
* '<COLUMN NAME>' => '<SQL>'
* )
* )
* )
*
* Example:
*
* array(
* QueryWriter::C_SQLFILTER_READ => array(
* 'book' => array(
* 'title' => ' LOWER(book.title) '
* )
* )
*
* Note that you can use constants instead of magical chars
* as keys for the uppermost array.
* This is a lowlevel method. For a more friendly method
* please take a look at the facade: R::bindFunc().
*
* @param array
*/
public static function setSQLFilters( $sqlFilters, $safeMode = false )
{
self::$flagSQLFilterSafeMode = (boolean) $safeMode;
self::$sqlFilters = $sqlFilters;
}
/**
* Returns current SQL Filters.
* This method returns the raw SQL filter array.
* This is a lowlevel method. For a more friendly method
* please take a look at the facade: R::bindFunc().
*
* @return array
*/
public static function getSQLFilters()
{
return self::$sqlFilters;
}
/**
* Returns an SQL Filter snippet for reading.
*
* @param string $type type of bean
*
* @return string
*/
protected function getSQLFilterSnippet( $type )
{
$existingCols = array();
if (self::$flagSQLFilterSafeMode) {
$existingCols = $this->getColumns( $type );
}
$sqlFilters = array();
if ( isset( self::$sqlFilters[QueryWriter::C_SQLFILTER_READ][$type] ) ) {
foreach( self::$sqlFilters[QueryWriter::C_SQLFILTER_READ][$type] as $property => $sqlFilter ) {
if ( !self::$flagSQLFilterSafeMode || isset( $existingCols[$property] ) ) {
$sqlFilters[] = $sqlFilter.' AS '.$property.' ';
}
}
}
$sqlFilterStr = ( count($sqlFilters) ) ? ( ','.implode( ',', $sqlFilters ) ) : '';
return $sqlFilterStr;
}
/**
* Generates a list of parameters (slots) for an SQL snippet.
* This method calculates the correct number of slots to insert in the
* SQL snippet and determines the correct type of slot. If the bindings
* array contains named parameters this method will return named ones and
* update the keys in the value list accordingly (that's why we use the &).
*
* If you pass an offset the bindings will be re-added to the value list.
* Some databases cant handle duplicate parameter names in queries.
*
* @param array &$valueList list of values to generate slots for (gets modified if needed)
* @param array $otherBindings list of additional bindings
* @param integer $offset start counter at...
*
* @return string
*/
protected function getParametersForInClause( &$valueList, $otherBindings, $offset = 0 )
{
if ( is_array( $otherBindings ) && count( $otherBindings ) > 0 ) {
reset( $otherBindings );
$key = key( $otherBindings );
if ( !is_numeric($key) ) {
$filler = array();
$newList = (!$offset) ? array() : $valueList;
$counter = $offset;
foreach( $valueList as $value ) {
$slot = ':slot' . ( $counter++ );
$filler[] = $slot;
$newList[$slot] = $value;
}
// Change the keys!
$valueList = $newList;
return implode( ',', $filler );
}
}
return implode( ',', array_fill( 0, count( $valueList ), '?' ) );
}
/**
* Returns a cache key for the cache values passed.
* This method returns a fingerprint string to be used as a key to store
* data in the writer cache.
*
* @param array $keyValues key-value to generate key for
*
* @return string
*/
private function getCacheKey( $keyValues )
{
return json_encode( $keyValues );
}
/**
* Returns the values associated with the provided cache tag and key.
*
* @param string $cacheTag cache tag to use for lookup
* @param string $key key to use for lookup
*
* @return mixed
*/
private function getCached( $cacheTag, $key )
{
$sql = $this->adapter->getSQL();
2014-10-13 09:24:53 +00:00
if ($this->updateCache()) {
if ( isset( $this->cache[$cacheTag][$key] ) ) {
return $this->cache[$cacheTag][$key];
}
}
return NULL;
}
2014-10-13 09:24:53 +00:00
/**
* Checks if the previous query had a keep-cache tag.
* If so, the cache will persist, otherwise the cache will be flushed.
*
* Returns TRUE if the cache will remain and FALSE if a flush has
* been performed.
*
* @return boolean
*/
private function updateCache()
{
$sql = $this->adapter->getSQL();
if ( strpos( $sql, '-- keep-cache' ) !== strlen( $sql ) - 13 ) {
// If SQL has been taken place outside of this method then something else then
// a select query might have happened! (or instruct to keep cache)
$this->cache = array();
return FALSE;
}
return TRUE;
}
/**
* Stores data from the writer in the cache under a specific key and cache tag.
* A cache tag is used to make sure the cache remains consistent. In most cases the cache tag
* will be the bean type, this makes sure queries associated with a certain reference type will
* never contain conflicting data.
* You can only store one item under a cache tag. Why not use the cache tag as a key? Well
* we need to make sure the cache contents fits the key (and key is based on the cache values).
* Otherwise it would be possible to store two different result sets under the same key (the cache tag).
*
* @param string $cacheTag cache tag (secondary key)
* @param string $key key
* @param array $values content to be stored
*
* @return void
*/
private function putResultInCache( $cacheTag, $key, $values )
{
$this->cache[$cacheTag] = array(
$key => $values
);
}
/**
* Creates an SQL snippet from a list of conditions of format:
*
* array(
* key => array(
* value1, value2, value3 ....
* )
* )
*
* @param array $conditions list of conditions
* @param array $bindings parameter bindings for SQL snippet
* @param string $addSql SQL snippet
*
* @return string
*/
private function makeSQLFromConditions( $conditions, &$bindings, $addSql = '' )
{
reset( $bindings );
$firstKey = key( $bindings );
$paramTypeIsNum = ( is_numeric( $firstKey ) );
$counter = 0;
$sqlConditions = array();
foreach ( $conditions as $column => $values ) {
if ( !count( $values ) ) continue;
$sql = $this->esc( $column );
$sql .= ' IN ( ';
if ( !is_array( $values ) ) $values = array( $values );
// If it's safe to skip bindings, do so...
if ( ctype_digit( implode( '', $values ) ) ) {
$sql .= implode( ',', $values ) . ' ) ';
// only numeric, cant do much harm
$sqlConditions[] = $sql;
} else {
if ( $paramTypeIsNum ) {
$sql .= implode( ',', array_fill( 0, count( $values ), '?' ) ) . ' ) ';
array_unshift($sqlConditions, $sql);
foreach ( $values as $k => $v ) {
$values[$k] = strval( $v );
array_unshift( $bindings, $v );
}
} else {
$slots = array();
foreach( $values as $k => $v ) {
$slot = ':slot'.$counter++;
$slots[] = $slot;
$bindings[$slot] = strval( $v );
}
$sql .= implode( ',', $slots ).' ) ';
$sqlConditions[] = $sql;
}
}
}
$sql = '';
if ( is_array( $sqlConditions ) && count( $sqlConditions ) > 0 ) {
$sql = implode( ' AND ', $sqlConditions );
$sql = " WHERE ( $sql ) ";
if ( $addSql ) $sql .= $addSql;
} elseif ( $addSql ) {
$sql = $addSql;
}
return $sql;
}
/**
* Returns the table names and column names for a relational query.
*
* @param string $sourceType type of the source bean
* @param string $destType type of the bean you want to obtain using the relation
* @param boolean $noQuote TRUE if you want to omit quotes
*
* @return array
*/
private function getRelationalTablesAndColumns( $sourceType, $destType, $noQuote = FALSE )
{
$linkTable = $this->esc( $this->getAssocTable( array( $sourceType, $destType ) ), $noQuote );
$sourceCol = $this->esc( $sourceType . '_id', $noQuote );
if ( $sourceType === $destType ) {
$destCol = $this->esc( $destType . '2_id', $noQuote );
} else {
$destCol = $this->esc( $destType . '_id', $noQuote );
}
$sourceTable = $this->esc( $sourceType, $noQuote );
$destTable = $this->esc( $destType, $noQuote );
return array( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol );
}
2014-10-13 09:24:53 +00:00
/**
* Adds a data type to the list of data types.
* Use this method to add a new column type definition to the writer.
* Used for UUID support.
*
* @param integer $dataTypeID magic number constant assigned to this data type
* @param string $SQLDefinition SQL column definition (i.e. INT(11))
*
* @return self
*/
protected function addDataType( $dataTypeID, $SQLDefinition )
{
$this->typeno_sqltype[ $dataTypeID ] = $SQLDefinition;
$this->sqltype_typeno[ $SQLDefinition ] = $dataTypeID;
return $this;
}
/**
* Returns the sql that should follow an insert statement.
*
* @param string $table name
*
* @return string
*/
protected function getInsertSuffix( $table )
{
return '';
}
/**
* Checks whether a value starts with zeros. In this case
* the value should probably be stored using a text datatype instead of a
* numerical type in order to preserve the zeros.
*
* @param string $value value to be checked.
*
* @return boolean
*/
protected function startsWithZeros( $value )
{
$value = strval( $value );
if ( strlen( $value ) > 1 && strpos( $value, '0' ) === 0 && strpos( $value, '0.' ) !== 0 ) {
return TRUE;
} else {
return FALSE;
}
}
/**
* Inserts a record into the database using a series of insert columns
* and corresponding insertvalues. Returns the insert id.
*
* @param string $table table to perform query on
* @param array $insertcolumns columns to be inserted
* @param array $insertvalues values to be inserted
*
* @return integer
*/
protected function insertRecord( $type, $insertcolumns, $insertvalues )
{
$default = $this->defaultValue;
$suffix = $this->getInsertSuffix( $type );
$table = $this->esc( $type );
if ( count( $insertvalues ) > 0 && is_array( $insertvalues[0] ) && count( $insertvalues[0] ) > 0 ) {
2014-10-13 09:24:53 +00:00
$insertSlots = array();
foreach ( $insertcolumns as $k => $v ) {
$insertcolumns[$k] = $this->esc( $v );
2014-10-13 09:24:53 +00:00
if (isset(self::$sqlFilters['w'][$type][$v])) {
$insertSlots[] = self::$sqlFilters['w'][$type][$v];
} else {
$insertSlots[] = '?';
}
}
$insertSQL = "INSERT INTO $table ( id, " . implode( ',', $insertcolumns ) . " ) VALUES
2014-10-13 09:24:53 +00:00
( $default, " . implode( ',', $insertSlots ) . " ) $suffix";
$ids = array();
foreach ( $insertvalues as $i => $insertvalue ) {
$ids[] = $this->adapter->getCell( $insertSQL, $insertvalue, $i );
}
$result = count( $ids ) === 1 ? array_pop( $ids ) : $ids;
} else {
$result = $this->adapter->getCell( "INSERT INTO $table (id) VALUES($default) $suffix" );
}
if ( $suffix ) return $result;
$last_id = $this->adapter->getInsertID();
return $last_id;
}
/**
* Checks table name or column name.
*
* @param string $table table string
*
* @return string
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
protected function check( $struct )
{
if ( !preg_match( '/^[a-zA-Z0-9_]+$/', $struct ) ) {
2014-10-13 09:24:53 +00:00
throw new RedException( 'Identifier does not conform to RedBeanPHP security policies.' );
}
return $struct;
}
/**
* Checks whether a number can be treated like an int.
*
* @param string $value string representation of a certain value
*
* @return boolean
*/
public static function canBeTreatedAsInt( $value )
{
return (bool) ( ctype_digit( strval( $value ) ) && strval( $value ) === strval( intval( $value ) ) );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getAssocTableFormat
*/
public static function getAssocTableFormat( $types )
{
sort( $types );
$assoc = implode( '_', $types );
return ( isset( self::$renames[$assoc] ) ) ? self::$renames[$assoc] : $assoc;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::renameAssociation
*/
public static function renameAssociation( $from, $to = NULL )
{
if ( is_array( $from ) ) {
foreach ( $from as $key => $value ) self::$renames[$key] = $value;
return;
}
self::$renames[$from] = $to;
}
2014-10-13 09:24:53 +00:00
/**
* Globally available service method for RedBeanPHP.
* Converts a camel cased string to a snake cased string.
*
* @param string $camel a camelCased string
*
* @return string
*/
public static function camelsSnake( $camel )
{
return strtolower( preg_replace( '/(?<=[a-z])([A-Z])|([A-Z])(?=[a-z])/', '_$1$2', $camel ) );
}
/**
* Checks whether the specified type (i.e. table) already exists in the database.
* Not part of the Object Database interface!
*
* @param string $table table name
*
* @return boolean
*/
public function tableExists( $table )
{
$tables = $this->getTables();
return in_array( $table, $tables );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::glueSQLCondition
*/
public function glueSQLCondition( $sql, $glue = NULL )
{
static $snippetCache = array();
if ( trim( $sql ) === '' ) {
return $sql;
}
$key = $glue . '|' . $sql;
if ( isset( $snippetCache[$key] ) ) {
return $snippetCache[$key];
}
$lsql = ltrim( $sql );
2014-10-13 09:24:53 +00:00
if ( preg_match( '/^(INNER|LEFT|RIGHT|JOIN|AND|OR|WHERE|ORDER|GROUP|HAVING|LIMIT|OFFSET)\s+/i', $lsql ) ) {
if ( $glue === QueryWriter::C_GLUE_WHERE && stripos( $lsql, 'AND' ) === 0 ) {
$snippetCache[$key] = ' WHERE ' . substr( $lsql, 3 );
} else {
$snippetCache[$key] = $sql;
}
} else {
2014-10-13 09:24:53 +00:00
$snippetCache[$key] = ( ( $glue === QueryWriter::C_GLUE_AND ) ? ' AND ' : ' WHERE ') . $sql;
}
return $snippetCache[$key];
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::glueLimitOne
*/
public function glueLimitOne( $sql = '')
{
return ( strpos( $sql, 'LIMIT' ) === FALSE ) ? ( $sql . ' LIMIT 1 ' ) : $sql;
}
/**
* @see QueryWriter::esc
*/
public function esc( $dbStructure, $dontQuote = FALSE )
{
$this->check( $dbStructure );
return ( $dontQuote ) ? $dbStructure : $this->quoteCharacter . $dbStructure . $this->quoteCharacter;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addColumn
*/
public function addColumn( $type, $column, $field )
{
$table = $type;
$type = $field;
$table = $this->esc( $table );
$column = $this->esc( $column );
$type = ( isset( $this->typeno_sqltype[$type] ) ) ? $this->typeno_sqltype[$type] : '';
$this->adapter->exec( "ALTER TABLE $table ADD $column $type " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::updateRecord
*/
public function updateRecord( $type, $updatevalues, $id = NULL )
{
$table = $type;
if ( !$id ) {
$insertcolumns = $insertvalues = array();
foreach ( $updatevalues as $pair ) {
$insertcolumns[] = $pair['property'];
$insertvalues[] = $pair['value'];
}
2014-04-10 19:43:46 +00:00
//Otherwise psql returns string while MySQL/SQLite return numeric causing problems with additions (array_diff)
return (string) $this->insertRecord( $table, $insertcolumns, array( $insertvalues ) );
}
if ( $id && !count( $updatevalues ) ) {
return $id;
}
$table = $this->esc( $table );
$sql = "UPDATE $table SET ";
$p = $v = array();
foreach ( $updatevalues as $uv ) {
2014-10-13 09:24:53 +00:00
if ( isset( self::$sqlFilters['w'][$type][$uv['property']] ) ) {
$p[] = " {$this->esc( $uv["property"] )} = ". self::$sqlFilters['w'][$type][$uv['property']];
} else {
$p[] = " {$this->esc( $uv["property"] )} = ? ";
}
$v[] = $uv['value'];
}
$sql .= implode( ',', $p ) . ' WHERE id = ? ';
$v[] = $id;
$this->adapter->exec( $sql, $v );
return $id;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::writeJoin
*/
public function writeJoin( $type, $targetType, $leftRight = 'LEFT' )
{
if ( $leftRight !== 'LEFT' && $leftRight !== 'RIGHT' && $leftRight !== 'INNER' )
throw new RedException( 'Invalid JOIN.' );
$table = $this->esc( $type );
$targetTable = $this->esc( $targetType );
$field = $this->esc( $targetType, TRUE );
return " {$leftRight} JOIN {$targetTable} ON {$targetTable}.id = {$table}.{$field}_id ";
}
/**
* @see QueryWriter::queryRecord
*/
public function queryRecord( $type, $conditions = array(), $addSql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$addSql = $this->glueSQLCondition( $addSql, ( count($conditions) > 0) ? QueryWriter::C_GLUE_AND : NULL );
$key = NULL;
if ( $this->flagUseCache ) {
$key = $this->getCacheKey( array( $conditions, $addSql, $bindings, 'select' ) );
if ( $cached = $this->getCached( $type, $key ) ) {
return $cached;
}
}
$table = $this->esc( $type );
2014-10-13 09:24:53 +00:00
$sqlFilterStr = '';
if ( count( self::$sqlFilters ) ) {
$sqlFilterStr = $this->getSQLFilterSnippet( $type );
}
$sql = $this->makeSQLFromConditions( $conditions, $bindings, $addSql );
2014-10-13 09:24:53 +00:00
$fieldSelection = ( self::$flagNarrowFieldMode ) ? "{$table}.*" : '*';
$sql = "SELECT {$fieldSelection} {$sqlFilterStr} FROM {$table} {$sql} -- keep-cache";
$rows = $this->adapter->get( $sql, $bindings );
2014-10-13 09:24:53 +00:00
if ( $this->flagUseCache && $key ) {
$this->putResultInCache( $type, $key, $rows );
}
return $rows;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::queryRecordRelated
*/
public function queryRecordRelated( $sourceType, $destType, $linkIDs, $addSql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$addSql = $this->glueSQLCondition( $addSql, QueryWriter::C_GLUE_WHERE );
list( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol ) = $this->getRelationalTablesAndColumns( $sourceType, $destType );
$key = $this->getCacheKey( array( $sourceType, $destType, implode( ',', $linkIDs ), $addSql, $bindings ) );
if ( $this->flagUseCache && $cached = $this->getCached( $destType, $key ) ) {
return $cached;
}
$inClause = $this->getParametersForInClause( $linkIDs, $bindings );
2014-10-13 09:24:53 +00:00
$sqlFilterStr = '';
if ( count( self::$sqlFilters ) ) {
$sqlFilterStr = $this->getSQLFilterSnippet( $destType );
}
if ( $sourceType === $destType ) {
$inClause2 = $this->getParametersForInClause( $linkIDs, $bindings, count( $bindings ) ); //for some databases
$sql = "
SELECT
2014-10-13 09:24:53 +00:00
{$destTable}.* {$sqlFilterStr} ,
COALESCE(
NULLIF({$linkTable}.{$sourceCol}, {$destTable}.id),
NULLIF({$linkTable}.{$destCol}, {$destTable}.id)) AS linked_by
FROM {$linkTable}
INNER JOIN {$destTable} ON
( {$destTable}.id = {$linkTable}.{$destCol} AND {$linkTable}.{$sourceCol} IN ($inClause) ) OR
( {$destTable}.id = {$linkTable}.{$sourceCol} AND {$linkTable}.{$destCol} IN ($inClause2) )
{$addSql}
-- keep-cache";
$linkIDs = array_merge( $linkIDs, $linkIDs );
} else {
$sql = "
SELECT
2014-10-13 09:24:53 +00:00
{$destTable}.* {$sqlFilterStr},
{$linkTable}.{$sourceCol} AS linked_by
FROM {$linkTable}
INNER JOIN {$destTable} ON
( {$destTable}.id = {$linkTable}.{$destCol} AND {$linkTable}.{$sourceCol} IN ($inClause) )
{$addSql}
-- keep-cache";
}
$bindings = array_merge( $linkIDs, $bindings );
$rows = $this->adapter->get( $sql, $bindings );
$this->putResultInCache( $destType, $key, $rows );
return $rows;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::queryRecordLink
*/
public function queryRecordLink( $sourceType, $destType, $sourceID, $destID )
{
list( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol ) = $this->getRelationalTablesAndColumns( $sourceType, $destType );
$key = $this->getCacheKey( array( $sourceType, $destType, $sourceID, $destID ) );
if ( $this->flagUseCache && $cached = $this->getCached( $linkTable, $key ) ) {
return $cached;
}
2014-10-13 09:24:53 +00:00
$sqlFilterStr = '';
if ( count( self::$sqlFilters ) ) {
$sqlFilterStr = $this->getSQLFilterSnippet( $destType );
}
if ( $sourceTable === $destTable ) {
2014-10-13 09:24:53 +00:00
$sql = "SELECT {$linkTable}.* {$sqlFilterStr} FROM {$linkTable}
WHERE ( {$sourceCol} = ? AND {$destCol} = ? ) OR
( {$destCol} = ? AND {$sourceCol} = ? ) -- keep-cache";
$row = $this->adapter->getRow( $sql, array( $sourceID, $destID, $sourceID, $destID ) );
} else {
2014-10-13 09:24:53 +00:00
$sql = "SELECT {$linkTable}.* {$sqlFilterStr} FROM {$linkTable}
WHERE {$sourceCol} = ? AND {$destCol} = ? -- keep-cache";
$row = $this->adapter->getRow( $sql, array( $sourceID, $destID ) );
}
$this->putResultInCache( $linkTable, $key, $row );
return $row;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::queryTagged
*/
public function queryTagged( $type, $tagList, $all = FALSE, $addSql = '', $bindings = array() )
{
$assocType = $this->getAssocTable( array( $type, 'tag' ) );
$assocTable = $this->esc( $assocType );
$assocField = $type . '_id';
$table = $this->esc( $type );
$slots = implode( ',', array_fill( 0, count( $tagList ), '?' ) );
$score = ( $all ) ? count( $tagList ) : 1;
$sql = "
SELECT {$table}.*, count({$table}.id) FROM {$table}
INNER JOIN {$assocTable} ON {$assocField} = {$table}.id
INNER JOIN tag ON {$assocTable}.tag_id = tag.id
WHERE tag.title IN ({$slots})
GROUP BY {$table}.id
HAVING count({$table}.id) >= ?
{$addSql}
";
$bindings = array_merge( $tagList, array( $score ), $bindings );
$rows = $this->adapter->get( $sql, $bindings );
return $rows;
}
/**
* @see QueryWriter::queryRecordCount
*/
public function queryRecordCount( $type, $conditions = array(), $addSql = NULL, $bindings = array() )
{
$addSql = $this->glueSQLCondition( $addSql );
$table = $this->esc( $type );
2014-10-13 09:24:53 +00:00
$this->updateCache(); //check if cache chain has been broken
$sql = $this->makeSQLFromConditions( $conditions, $bindings, $addSql );
2014-10-13 09:24:53 +00:00
$sql = "SELECT COUNT(*) FROM {$table} {$sql} -- keep-cache";
return (int) $this->adapter->getCell( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::queryRecordCountRelated
*/
public function queryRecordCountRelated( $sourceType, $destType, $linkID, $addSql = '', $bindings = array() )
{
list( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol ) = $this->getRelationalTablesAndColumns( $sourceType, $destType );
2014-10-13 09:24:53 +00:00
$this->updateCache(); //check if cache chain has been broken
if ( $sourceType === $destType ) {
$sql = "
SELECT COUNT(*) FROM {$linkTable}
INNER JOIN {$destTable} ON
( {$destTable}.id = {$linkTable}.{$destCol} AND {$linkTable}.{$sourceCol} = ? ) OR
( {$destTable}.id = {$linkTable}.{$sourceCol} AND {$linkTable}.{$destCol} = ? )
2014-10-13 09:24:53 +00:00
{$addSql}
-- keep-cache";
$bindings = array_merge( array( $linkID, $linkID ), $bindings );
} else {
$sql = "
SELECT COUNT(*) FROM {$linkTable}
INNER JOIN {$destTable} ON
( {$destTable}.id = {$linkTable}.{$destCol} AND {$linkTable}.{$sourceCol} = ? )
2014-10-13 09:24:53 +00:00
{$addSql}
-- keep-cache";
$bindings = array_merge( array( $linkID ), $bindings );
}
return (int) $this->adapter->getCell( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::deleteRecord
*/
public function deleteRecord( $type, $conditions = array(), $addSql = NULL, $bindings = array() )
{
$addSql = $this->glueSQLCondition( $addSql );
$table = $this->esc( $type );
$sql = $this->makeSQLFromConditions( $conditions, $bindings, $addSql );
$sql = "DELETE FROM {$table} {$sql}";
$this->adapter->exec( $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::deleteRelations
*/
public function deleteRelations( $sourceType, $destType, $sourceID )
{
list( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol ) = $this->getRelationalTablesAndColumns( $sourceType, $destType );
if ( $sourceTable === $destTable ) {
$sql = "DELETE FROM {$linkTable}
WHERE ( {$sourceCol} = ? ) OR
( {$destCol} = ? )
";
$this->adapter->exec( $sql, array( $sourceID, $sourceID ) );
} else {
$sql = "DELETE FROM {$linkTable}
WHERE {$sourceCol} = ? ";
$this->adapter->exec( $sql, array( $sourceID ) );
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::widenColumn
*/
public function widenColumn( $type, $column, $datatype )
{
if ( !isset($this->typeno_sqltype[$datatype]) ) return;
$table = $type;
$type = $datatype;
$table = $this->esc( $table );
$column = $this->esc( $column );
$newtype = $this->typeno_sqltype[$type];
$this->adapter->exec( "ALTER TABLE $table CHANGE $column $column $newtype " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::wipe
*/
public function wipe( $type )
{
$table = $this->esc( $type );
$this->adapter->exec( "TRUNCATE $table " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::renameAssocTable
*/
public function renameAssocTable( $from, $to = NULL )
{
self::renameAssociation( $from, $to );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getAssocTable
*/
public function getAssocTable( $types )
{
return self::getAssocTableFormat( $types );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addConstraintForTypes
*/
public function addConstraintForTypes( $sourceType, $destType )
{
list( $sourceTable, $destTable, $linkTable, $sourceCol, $destCol ) = $this->getRelationalTablesAndColumns( $sourceType, $destType, TRUE );
2014-10-13 09:24:53 +00:00
return $this->constrain( $linkTable, $sourceTable, $destTable, $sourceCol, $destCol );
}
/**
* Turns caching on or off. Default: off.
* If caching is turned on retrieval queries fired after eachother will
* use a result row cache.
*
* @param boolean
*/
public function setUseCache( $yesNo )
{
$this->flushCache();
$this->flagUseCache = (bool) $yesNo;
}
/**
* Flushes the Query Writer Cache.
*
* @return void
*/
public function flushCache()
{
$this->cache = array();
}
/**
* @deprecated Use esc() instead.
*
* @param string $column column to be escaped
* @param boolean $noQuotes omit quotes
*
* @return string
*/
public function safeColumn( $column, $noQuotes = FALSE )
{
return $this->esc( $column, $noQuotes );
}
/**
* @deprecated Use esc() instead.
*
* @param string $table table to be escaped
* @param boolean $noQuotes omit quotes
*
* @return string
*/
public function safeTable( $table, $noQuotes = FALSE )
{
return $this->esc( $table, $noQuotes );
}
2014-10-13 09:24:53 +00:00
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\QueryWriter {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\Adapter as Adapter;
/**
* RedBean MySQLWriter
*
* @file RedBean/QueryWriter/MySQL.php
* @desc Represents a MySQL Database to RedBean
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class MySQL extends AQueryWriter implements QueryWriter
{
/**
* Data types
*/
const C_DATATYPE_BOOL = 0;
const C_DATATYPE_UINT32 = 2;
const C_DATATYPE_DOUBLE = 3;
const C_DATATYPE_TEXT8 = 4;
const C_DATATYPE_TEXT16 = 5;
const C_DATATYPE_TEXT32 = 6;
const C_DATATYPE_SPECIAL_DATE = 80;
const C_DATATYPE_SPECIAL_DATETIME = 81;
const C_DATATYPE_SPECIAL_POINT = 90;
2014-10-13 09:24:53 +00:00
const C_DATATYPE_SPECIAL_LINESTRING = 91;
const C_DATATYPE_SPECIAL_POLYGON = 92;
const C_DATATYPE_SPECIFIED = 99;
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
protected $adapter;
/**
* @var string
*/
protected $quoteCharacter = '`';
/**
* Add the constraints for a specific database driver: MySQL.
*
* @param string $table table table to add constrains to
* @param string $table1 table1 first reference table
* @param string $table2 table2 second reference table
* @param string $property1 property1 first column
* @param string $property2 property2 second column
*
* @return boolean $succes whether the constraint has been applied
*/
protected function constrain( $table, $table1, $table2, $property1, $property2 )
{
try {
$db = $this->adapter->getCell( 'SELECT database()' );
$fks = $this->adapter->getCell(
"SELECT count(*)
FROM information_schema.KEY_COLUMN_USAGE
WHERE TABLE_SCHEMA = ? AND TABLE_NAME = ? AND
CONSTRAINT_NAME <>'PRIMARY' AND REFERENCED_TABLE_NAME IS NOT NULL",
array( $db, $table )
);
// already foreign keys added in this association table
if ( $fks > 0 ) {
return FALSE;
}
$columns = $this->getColumns( $table );
2014-10-13 09:24:53 +00:00
$idType = $this->getTypeForID();
if ( $this->code( $columns[$property1] ) !== $idType ) {
$this->widenColumn( $table, $property1, $idType );
}
2014-10-13 09:24:53 +00:00
if ( $this->code( $columns[$property2] ) !== $idType ) {
$this->widenColumn( $table, $property2, $idType );
}
$sql = "
ALTER TABLE " . $this->esc( $table ) . "
2014-10-13 09:24:53 +00:00
ADD FOREIGN KEY($property1) references `$table1`(id) ON DELETE CASCADE ON UPDATE CASCADE;
";
$this->adapter->exec( $sql );
$sql = "
ALTER TABLE " . $this->esc( $table ) . "
2014-10-13 09:24:53 +00:00
ADD FOREIGN KEY($property2) references `$table2`(id) ON DELETE CASCADE ON UPDATE CASCADE
";
$this->adapter->exec( $sql );
return TRUE;
2014-10-13 09:24:53 +00:00
} catch ( \Exception $e ) {
return FALSE;
}
}
/**
* Constructor
*
2014-10-13 09:24:53 +00:00
* @param Adapter $adapter Database Adapter
*/
2014-10-13 09:24:53 +00:00
public function __construct( Adapter $adapter )
{
$this->typeno_sqltype = array(
2014-10-13 09:24:53 +00:00
MySQL::C_DATATYPE_BOOL => ' TINYINT(1) UNSIGNED ',
MySQL::C_DATATYPE_UINT32 => ' INT(11) UNSIGNED ',
MySQL::C_DATATYPE_DOUBLE => ' DOUBLE ',
MySQL::C_DATATYPE_TEXT8 => ' VARCHAR(255) ',
MySQL::C_DATATYPE_TEXT16 => ' TEXT ',
MySQL::C_DATATYPE_TEXT32 => ' LONGTEXT ',
MySQL::C_DATATYPE_SPECIAL_DATE => ' DATE ',
MySQL::C_DATATYPE_SPECIAL_DATETIME => ' DATETIME ',
MySQL::C_DATATYPE_SPECIAL_POINT => ' POINT ',
MySQL::C_DATATYPE_SPECIAL_LINESTRING => ' LINESTRING ',
MySQL::C_DATATYPE_SPECIAL_POLYGON => ' POLYGON ',
);
$this->sqltype_typeno = array();
foreach ( $this->typeno_sqltype as $k => $v ) {
$this->sqltype_typeno[trim( strtolower( $v ) )] = $k;
}
$this->adapter = $adapter;
$this->encoding = $this->adapter->getDatabase()->getMysqlEncoding();
}
/**
* This method returns the datatype to be used for primary key IDS and
* foreign keys. Returns one if the data type constants.
*
* @return integer $const data type to be used for IDS.
*/
public function getTypeForID()
{
return self::C_DATATYPE_UINT32;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getTables
*/
public function getTables()
{
return $this->adapter->getCol( 'show tables' );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::createTable
*/
public function createTable( $table )
{
$table = $this->esc( $table );
$encoding = $this->adapter->getDatabase()->getMysqlEncoding();
$sql = "CREATE TABLE $table (id INT( 11 ) UNSIGNED NOT NULL AUTO_INCREMENT, PRIMARY KEY ( id )) ENGINE = InnoDB DEFAULT CHARSET={$encoding} COLLATE={$encoding}_unicode_ci ";
$this->adapter->exec( $sql );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getColumns
*/
public function getColumns( $table )
{
$columnsRaw = $this->adapter->get( "DESCRIBE " . $this->esc( $table ) );
$columns = array();
foreach ( $columnsRaw as $r ) {
$columns[$r['Field']] = $r['Type'];
}
return $columns;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::scanType
*/
public function scanType( $value, $flagSpecial = FALSE )
{
$this->svalue = $value;
2014-10-13 09:24:53 +00:00
if ( is_null( $value ) ) return MySQL::C_DATATYPE_BOOL;
if ( $flagSpecial ) {
if ( preg_match( '/^\d{4}\-\d\d-\d\d$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_SPECIAL_DATE;
}
if ( preg_match( '/^\d{4}\-\d\d-\d\d\s\d\d:\d\d:\d\d$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_SPECIAL_DATETIME;
}
2014-10-13 09:24:53 +00:00
if ( preg_match( '/^POINT\(/', $value ) ) {
return MySQL::C_DATATYPE_SPECIAL_POINT;
}
if ( preg_match( '/^LINESTRING\(/', $value ) ) {
return MySQL::C_DATATYPE_SPECIAL_LINESTRING;
}
if ( preg_match( '/^POLYGON\(/', $value ) ) {
return MySQL::C_DATATYPE_SPECIAL_POLYGON;
}
}
2014-10-13 09:24:53 +00:00
//setter turns TRUE FALSE into 0 and 1 because database has no real bools (TRUE and FALSE only for test?).
if ( $value === FALSE || $value === TRUE || $value === '0' || $value === '1' ) {
return MySQL::C_DATATYPE_BOOL;
}
if ( !$this->startsWithZeros( $value ) ) {
if ( is_numeric( $value ) && ( floor( $value ) == $value ) && $value >= 0 && $value <= 4294967295 ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_UINT32;
}
if ( is_numeric( $value ) ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_DOUBLE;
}
}
if ( mb_strlen( $value, 'UTF-8' ) <= 255 ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_TEXT8;
}
if ( mb_strlen( $value, 'UTF-8' ) <= 65535 ) {
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_TEXT16;
}
2014-10-13 09:24:53 +00:00
return MySQL::C_DATATYPE_TEXT32;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::code
*/
public function code( $typedescription, $includeSpecials = FALSE )
{
if ( isset( $this->sqltype_typeno[$typedescription] ) ) {
$r = $this->sqltype_typeno[$typedescription];
} else {
$r = self::C_DATATYPE_SPECIFIED;
}
if ( $includeSpecials ) {
return $r;
}
2014-10-13 09:24:53 +00:00
if ( $r >= QueryWriter::C_DATATYPE_RANGE_SPECIAL ) {
return self::C_DATATYPE_SPECIFIED;
}
return $r;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addUniqueIndex
*/
public function addUniqueIndex( $table, $columns )
{
$table = $this->esc( $table );
sort( $columns ); // Else we get multiple indexes due to order-effects
foreach ( $columns as $k => $v ) {
$columns[$k] = $this->esc( $v );
}
$r = $this->adapter->get( "SHOW INDEX FROM $table" );
$name = 'UQ_' . sha1( implode( ',', $columns ) );
if ( $r ) {
foreach ( $r as $i ) {
if ( $i['Key_name'] == $name ) {
return;
}
}
}
2014-10-13 09:24:53 +00:00
try {
$sql = "ALTER TABLE $table
ADD UNIQUE INDEX $name (" . implode( ',', $columns ) . ")";
} catch ( \Exception $e ) {
//do nothing, dont use alter table ignore, this will delete duplicate records in 3-ways!
}
$this->adapter->exec( $sql );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addIndex
*/
public function addIndex( $type, $name, $column )
{
$table = $type;
$table = $this->esc( $table );
$name = preg_replace( '/\W/', '', $name );
$column = $this->esc( $column );
try {
2014-10-13 09:24:53 +00:00
foreach ( $this->adapter->get( "SHOW INDEX FROM $table " ) as $ind ) if ( $ind['Key_name'] === $name ) return;
$this->adapter->exec( "CREATE INDEX $name ON $table ($column) " );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
}
}
/**
* @see QueryWriter::addFK
*/
public function addFK( $type, $targetType, $field, $targetField, $isDependent = FALSE )
{
$db = $this->adapter->getCell( 'SELECT DATABASE()' );
$cfks = $this->adapter->getCell('
SELECT CONSTRAINT_NAME
FROM information_schema.KEY_COLUMN_USAGE
WHERE
TABLE_SCHEMA = ?
AND TABLE_NAME = ?
AND COLUMN_NAME = ? AND
CONSTRAINT_NAME != \'PRIMARY\'
AND REFERENCED_TABLE_NAME IS NOT NULL
', array($db, $type, $field));
if ($cfks) return;
try {
$fkName = 'fk_'.($type.'_'.$field);
$cName = 'c_'.$fkName;
$this->adapter->exec( "
ALTER TABLE {$this->esc($type)}
ADD CONSTRAINT $cName
FOREIGN KEY $fkName ( {$this->esc($field)} ) REFERENCES {$this->esc($targetType)} (
{$this->esc($targetField)}) ON DELETE " . ( $isDependent ? 'CASCADE' : 'SET NULL' ) . ' ON UPDATE '.( $isDependent ? 'CASCADE' : 'SET NULL' ).';');
} catch (\Exception $e ) {
// Failure of fk-constraints is not a problem
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::sqlStateIn
*/
public function sqlStateIn( $state, $list )
{
$stateMap = array(
2014-10-13 09:24:53 +00:00
'42S02' => QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
'42S22' => QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN,
'23000' => QueryWriter::C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION
);
return in_array( ( isset( $stateMap[$state] ) ? $stateMap[$state] : '0' ), $list );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::wipeAll
*/
public function wipeAll()
{
$this->adapter->exec( 'SET FOREIGN_KEY_CHECKS = 0;' );
foreach ( $this->getTables() as $t ) {
try {
$this->adapter->exec( "DROP TABLE IF EXISTS `$t`" );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
}
try {
$this->adapter->exec( "DROP VIEW IF EXISTS `$t`" );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
}
}
$this->adapter->exec( 'SET FOREIGN_KEY_CHECKS = 1;' );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\QueryWriter {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\Adapter as Adapter;
/**
* RedBean SQLiteWriter with support for SQLite types
*
* @file RedBean/QueryWriter/SQLiteT.php
* @desc Represents a SQLite Database to RedBean
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class SQLiteT extends AQueryWriter implements QueryWriter
{
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
protected $adapter;
/**
* @var string
*/
protected $quoteCharacter = '`';
/**
* Data types
*/
const C_DATATYPE_INTEGER = 0;
const C_DATATYPE_NUMERIC = 1;
const C_DATATYPE_TEXT = 2;
const C_DATATYPE_SPECIFIED = 99;
/**
* Gets all information about a table (from a type).
*
* Format:
* array(
* name => name of the table
* columns => array( name => datatype )
* indexes => array() raw index information rows from PRAGMA query
* keys => array() raw key information rows from PRAGMA query
* )
*
* @param string $type type you want to get info of
*
* @return array $info
*/
protected function getTable( $type )
{
$tableName = $this->esc( $type, TRUE );
$columns = $this->getColumns( $type );
$indexes = $this->getIndexes( $type );
$keys = $this->getKeys( $type );
$table = array(
'columns' => $columns,
'indexes' => $indexes,
'keys' => $keys,
'name' => $tableName
);
$this->tableArchive[$tableName] = $table;
return $table;
}
/**
* Puts a table. Updates the table structure.
* In SQLite we can't change columns, drop columns, change or add foreign keys so we
* have a table-rebuild function. You simply load your table with getTable(), modify it and
* then store it with putTable()...
*
* @param array $tableMap information array
*/
protected function putTable( $tableMap )
{
$table = $tableMap['name'];
$q = array();
$q[] = "DROP TABLE IF EXISTS tmp_backup;";
$oldColumnNames = array_keys( $this->getColumns( $table ) );
foreach ( $oldColumnNames as $k => $v ) $oldColumnNames[$k] = "`$v`";
$q[] = "CREATE TEMPORARY TABLE tmp_backup(" . implode( ",", $oldColumnNames ) . ");";
$q[] = "INSERT INTO tmp_backup SELECT * FROM `$table`;";
$q[] = "PRAGMA foreign_keys = 0 ";
$q[] = "DROP TABLE `$table`;";
$newTableDefStr = '';
foreach ( $tableMap['columns'] as $column => $type ) {
if ( $column != 'id' ) {
$newTableDefStr .= ",`$column` $type";
}
}
$fkDef = '';
foreach ( $tableMap['keys'] as $key ) {
$fkDef .= ", FOREIGN KEY(`{$key['from']}`)
REFERENCES `{$key['table']}`(`{$key['to']}`)
ON DELETE {$key['on_delete']} ON UPDATE {$key['on_update']}";
}
$q[] = "CREATE TABLE `$table` ( `id` INTEGER PRIMARY KEY AUTOINCREMENT $newTableDefStr $fkDef );";
foreach ( $tableMap['indexes'] as $name => $index ) {
if ( strpos( $name, 'UQ_' ) === 0 ) {
$cols = explode( '__', substr( $name, strlen( 'UQ_' . $table ) ) );
foreach ( $cols as $k => $v ) $cols[$k] = "`$v`";
$q[] = "CREATE UNIQUE INDEX $name ON `$table` (" . implode( ',', $cols ) . ")";
} else $q[] = "CREATE INDEX $name ON `$table` ({$index['name']}) ";
}
$q[] = "INSERT INTO `$table` SELECT * FROM tmp_backup;";
$q[] = "DROP TABLE tmp_backup;";
$q[] = "PRAGMA foreign_keys = 1 ";
foreach ( $q as $sq ) $this->adapter->exec( $sq );
}
/**
* Returns the indexes for type $type.
*
* @param string $type
*
* @return array $indexInfo index information
*/
protected function getIndexes( $type )
{
$table = $this->esc( $type, TRUE );
$indexes = $this->adapter->get( "PRAGMA index_list('$table')" );
$indexInfoList = array();
foreach ( $indexes as $i ) {
$indexInfoList[$i['name']] = $this->adapter->getRow( "PRAGMA index_info('{$i['name']}') " );
$indexInfoList[$i['name']]['unique'] = $i['unique'];
}
return $indexInfoList;
}
/**
* Returns the keys for type $type.
*
* @param string $type
*
* @return array $keysInfo keys information
*/
protected function getKeys( $type )
{
$table = $this->esc( $type, TRUE );
$keys = $this->adapter->get( "PRAGMA foreign_key_list('$table')" );
$keyInfoList = array();
foreach ( $keys as $k ) {
$keyInfoList['from_' . $k['from'] . '_to_table_' . $k['table'] . '_col_' . $k['to']] = $k;
}
return $keyInfoList;
}
/**
* Adds a foreign key to a type
*
* @param string $type type you want to modify table of
* @param string $targetType target type
* @param string $field field of the type that needs to get the fk
* @param string $targetField field where the fk needs to point to
* @param integer $buildopt 0 = NO ACTION, 1 = ON DELETE CASCADE
*
* @return boolean $didIt
*
* @note: cant put this in try-catch because that can hide the fact
* that database has been damaged.
*/
protected function buildFK( $type, $targetType, $field, $targetField, $constraint = FALSE )
{
$consSQL = ( $constraint ? 'CASCADE' : 'SET NULL' );
$t = $this->getTable( $type );
$label = 'from_' . $field . '_to_table_' . $targetType . '_col_' . $targetField;
2014-10-13 09:24:53 +00:00
foreach($t['keys'] as $key) {
if ($key['from'] === $field) return FALSE;
}
$t['keys'][$label] = array(
'table' => $targetType,
'from' => $field,
'to' => $targetField,
2014-10-13 09:24:53 +00:00
'on_update' => $consSQL,
'on_delete' => $consSQL
);
$this->putTable( $t );
return TRUE;
}
/**
* Add the constraints for a specific database driver: SQLite.
*
* @param string $table table to add fk constrains to
* @param string $table1 first reference table
* @param string $table2 second reference table
* @param string $property1 first reference column
* @param string $property2 second reference column
*
* @return boolean $success whether the constraint has been applied
*/
protected function constrain( $table, $table1, $table2, $property1, $property2 )
{
$firstState = $this->buildFK( $table, $table1, $property1, 'id', TRUE );
$secondState = $this->buildFK( $table, $table2, $property2, 'id', TRUE );
return ( $firstState && $secondState );
}
/**
* Constructor
*
2014-10-13 09:24:53 +00:00
* @param Adapter $adapter Database Adapter
*/
2014-10-13 09:24:53 +00:00
public function __construct( Adapter $adapter )
{
$this->typeno_sqltype = array(
2014-10-13 09:24:53 +00:00
SQLiteT::C_DATATYPE_INTEGER => 'INTEGER',
SQLiteT::C_DATATYPE_NUMERIC => 'NUMERIC',
SQLiteT::C_DATATYPE_TEXT => 'TEXT',
);
$this->sqltype_typeno = array();
foreach ( $this->typeno_sqltype as $k => $v ) {
$this->sqltype_typeno[$v] = $k;
}
$this->adapter = $adapter;
}
/**
* This method returns the datatype to be used for primary key IDS and
* foreign keys. Returns one if the data type constants.
*
* @return integer $const data type to be used for IDS.
*/
public function getTypeForID()
{
return self::C_DATATYPE_INTEGER;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::scanType
*/
public function scanType( $value, $flagSpecial = FALSE )
{
$this->svalue = $value;
if ( $value === NULL ) return self::C_DATATYPE_INTEGER;
if ( $this->startsWithZeros( $value ) ) return self::C_DATATYPE_TEXT;
2014-10-13 09:24:53 +00:00
if ( $value === TRUE || $value === FALSE ) return self::C_DATATYPE_INTEGER;
if ( is_numeric( $value ) && ( intval( $value ) == $value ) && $value < 2147483648 && $value > -2147483648 ) return self::C_DATATYPE_INTEGER;
if ( ( is_numeric( $value ) && $value < 2147483648 )
|| preg_match( '/\d{4}\-\d\d\-\d\d/', $value )
|| preg_match( '/\d{4}\-\d\d\-\d\d\s\d\d:\d\d:\d\d/', $value )
) {
return self::C_DATATYPE_NUMERIC;
}
return self::C_DATATYPE_TEXT;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addColumn
*/
public function addColumn( $table, $column, $type )
{
$column = $this->check( $column );
$table = $this->check( $table );
$type = $this->typeno_sqltype[$type];
$this->adapter->exec( "ALTER TABLE `$table` ADD `$column` $type " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::code
*/
public function code( $typedescription, $includeSpecials = FALSE )
{
$r = ( ( isset( $this->sqltype_typeno[$typedescription] ) ) ? $this->sqltype_typeno[$typedescription] : 99 );
return $r;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::widenColumn
*/
public function widenColumn( $type, $column, $datatype )
{
$t = $this->getTable( $type );
$t['columns'][$column] = $this->typeno_sqltype[$datatype];
$this->putTable( $t );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getTables();
*/
public function getTables()
{
return $this->adapter->getCol( "SELECT name FROM sqlite_master
WHERE type='table' AND name!='sqlite_sequence';" );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::createTable
*/
public function createTable( $table )
{
$table = $this->esc( $table );
$sql = "CREATE TABLE $table ( id INTEGER PRIMARY KEY AUTOINCREMENT ) ";
$this->adapter->exec( $sql );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getColumns
*/
public function getColumns( $table )
{
$table = $this->esc( $table, TRUE );
$columnsRaw = $this->adapter->get( "PRAGMA table_info('$table')" );
$columns = array();
foreach ( $columnsRaw as $r ) $columns[$r['name']] = $r['type'];
return $columns;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addUniqueIndex
*/
public function addUniqueIndex( $type, $columns )
{
$name = 'UQ_' . $this->esc( $type, TRUE ) . implode( '__', $columns );
$t = $this->getTable( $type );
if ( isset( $t['indexes'][$name] ) ) return;
$t['indexes'][$name] = array( 'name' => $name );
$this->putTable( $t );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::sqlStateIn
*/
public function sqlStateIn( $state, $list )
{
$stateMap = array(
2014-10-13 09:24:53 +00:00
'HY000' => QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
'23000' => QueryWriter::C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION
);
return in_array( ( isset( $stateMap[$state] ) ? $stateMap[$state] : '0' ), $list );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addIndex
*/
public function addIndex( $type, $name, $column )
{
$table = $type;
$table = $this->esc( $table );
$name = preg_replace( '/\W/', '', $name );
$column = $this->esc( $column, TRUE );
2014-10-13 09:24:53 +00:00
try {
foreach ( $this->adapter->get( "PRAGMA INDEX_LIST($table) " ) as $ind ) {
if ( $ind['name'] === $name ) return;
}
2014-10-13 09:24:53 +00:00
$t = $this->getTable( $type );
$t['indexes'][$name] = array( 'name' => $column );
2014-10-13 09:24:53 +00:00
$this->putTable( $t );
} catch( \Exception $exception ) {
//do nothing
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::wipe
*/
public function wipe( $type )
{
$table = $this->esc( $type );
$this->adapter->exec( "DELETE FROM $table " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addFK
*/
public function addFK( $type, $targetType, $field, $targetField, $isDep = FALSE )
{
return $this->buildFK( $type, $targetType, $field, $targetField, $isDep );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::wipeAll
*/
public function wipeAll()
{
$this->adapter->exec( 'PRAGMA foreign_keys = 0 ' );
foreach ( $this->getTables() as $t ) {
try {
$this->adapter->exec( "DROP TABLE IF EXISTS `$t`" );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
}
try {
$this->adapter->exec( "DROP TABLE IF EXISTS `$t`" );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
}
}
$this->adapter->exec( 'PRAGMA foreign_keys = 1 ' );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\QueryWriter {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\Adapter as Adapter;
/**
* RedBean PostgreSQL Query Writer
*
* @file RedBean/QueryWriter/PostgreSQL.php
* @desc QueryWriter for the PostgreSQL database system.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class PostgreSQL extends AQueryWriter implements QueryWriter
{
/**
* Data types
*/
const C_DATATYPE_INTEGER = 0;
const C_DATATYPE_DOUBLE = 1;
const C_DATATYPE_TEXT = 3;
const C_DATATYPE_SPECIAL_DATE = 80;
const C_DATATYPE_SPECIAL_DATETIME = 81;
const C_DATATYPE_SPECIAL_POINT = 90;
const C_DATATYPE_SPECIAL_LSEG = 91;
const C_DATATYPE_SPECIAL_CIRCLE = 92;
const C_DATATYPE_SPECIAL_MONEY = 93;
2014-10-13 09:24:53 +00:00
const C_DATATYPE_SPECIAL_POLYGON = 94;
const C_DATATYPE_SPECIFIED = 99;
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
protected $adapter;
/**
* @var string
*/
protected $quoteCharacter = '"';
/**
* @var string
*/
protected $defaultValue = 'DEFAULT';
/**
* Returns the insert suffix SQL Snippet
*
* @param string $table table
*
* @return string $sql SQL Snippet
*/
protected function getInsertSuffix( $table )
{
return 'RETURNING id ';
}
/**
* Add the constraints for a specific database driver: PostgreSQL.
*
* @param string $table table to add fk constraints to
* @param string $table1 first reference table
* @param string $table2 second reference table
* @param string $property1 first reference column
* @param string $property2 second reference column
*
* @return boolean
*/
protected function constrain( $table, $table1, $table2, $property1, $property2 )
{
try {
$adapter = $this->adapter;
$fkCode = 'fk' . md5( $table . $property1 . $property2 );
$sql = "SELECT c.oid, n.nspname, c.relname,
n2.nspname, c2.relname, cons.conname
FROM pg_class c
JOIN pg_namespace n ON n.oid = c.relnamespace
LEFT OUTER JOIN pg_constraint cons ON cons.conrelid = c.oid
LEFT OUTER JOIN pg_class c2 ON cons.confrelid = c2.oid
LEFT OUTER JOIN pg_namespace n2 ON n2.oid = c2.relnamespace
WHERE c.relkind = 'r'
2014-10-13 09:24:53 +00:00
AND n.nspname = ANY( current_schemas( FALSE ) )
AND (cons.contype = 'f' OR cons.contype IS NULL)
AND ( cons.conname = '{$fkCode}a' OR cons.conname = '{$fkCode}b' )
";
$rows = $adapter->get( $sql );
if ( !count( $rows ) ) {
$sql1 = "ALTER TABLE \"$table\" ADD CONSTRAINT
{$fkCode}a FOREIGN KEY ($property1)
2014-10-13 09:24:53 +00:00
REFERENCES \"$table1\" (id) ON DELETE CASCADE ON UPDATE CASCADE ";
$sql2 = "ALTER TABLE \"$table\" ADD CONSTRAINT
{$fkCode}b FOREIGN KEY ($property2)
2014-10-13 09:24:53 +00:00
REFERENCES \"$table2\" (id) ON DELETE CASCADE ON UPDATE CASCADE ";
$adapter->exec( $sql1 );
$adapter->exec( $sql2 );
2014-10-13 09:24:53 +00:00
return TRUE;
}
2014-10-13 09:24:53 +00:00
return FALSE;
} catch (\Exception $e ) {
return FALSE;
}
}
/**
* Constructor
*
2014-10-13 09:24:53 +00:00
* @param Adapter $adapter Database Adapter
*/
2014-10-13 09:24:53 +00:00
public function __construct( Adapter $adapter )
{
$this->typeno_sqltype = array(
self::C_DATATYPE_INTEGER => ' integer ',
self::C_DATATYPE_DOUBLE => ' double precision ',
self::C_DATATYPE_TEXT => ' text ',
self::C_DATATYPE_SPECIAL_DATE => ' date ',
self::C_DATATYPE_SPECIAL_DATETIME => ' timestamp without time zone ',
self::C_DATATYPE_SPECIAL_POINT => ' point ',
self::C_DATATYPE_SPECIAL_LSEG => ' lseg ',
self::C_DATATYPE_SPECIAL_CIRCLE => ' circle ',
self::C_DATATYPE_SPECIAL_MONEY => ' money ',
2014-10-13 09:24:53 +00:00
self::C_DATATYPE_SPECIAL_POLYGON => ' polygon ',
);
$this->sqltype_typeno = array();
foreach ( $this->typeno_sqltype as $k => $v ) {
$this->sqltype_typeno[trim( strtolower( $v ) )] = $k;
}
$this->adapter = $adapter;
}
/**
* This method returns the datatype to be used for primary key IDS and
* foreign keys. Returns one if the data type constants.
*
* @return integer $const data type to be used for IDS.
*/
public function getTypeForID()
{
return self::C_DATATYPE_INTEGER;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getTables
*/
public function getTables()
{
2014-10-13 09:24:53 +00:00
return $this->adapter->getCol( 'SELECT table_name FROM information_schema.tables WHERE table_schema = ANY( current_schemas( FALSE ) )' );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::createTable
*/
public function createTable( $table )
{
$table = $this->esc( $table );
$this->adapter->exec( " CREATE TABLE $table (id SERIAL PRIMARY KEY); " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::getColumns
*/
public function getColumns( $table )
{
$table = $this->esc( $table, TRUE );
$columnsRaw = $this->adapter->get( "SELECT column_name, data_type FROM information_schema.columns WHERE table_name='$table'" );
$columns = array();
foreach ( $columnsRaw as $r ) {
$columns[$r['column_name']] = $r['data_type'];
}
return $columns;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::scanType
*/
public function scanType( $value, $flagSpecial = FALSE )
{
$this->svalue = $value;
if ( $flagSpecial && $value ) {
if ( preg_match( '/^\d{4}\-\d\d-\d\d$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_DATE;
}
if ( preg_match( '/^\d{4}\-\d\d-\d\d\s\d\d:\d\d:\d\d(\.\d{1,6})?$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_DATETIME;
}
if ( preg_match( '/^\([\d\.]+,[\d\.]+\)$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_POINT;
}
if ( preg_match( '/^\[\([\d\.]+,[\d\.]+\),\([\d\.]+,[\d\.]+\)\]$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_LSEG;
}
if ( preg_match( '/^\<\([\d\.]+,[\d\.]+\),[\d\.]+\>$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_CIRCLE;
}
if ( preg_match( '/^\((\([\d\.]+,[\d\.]+\),?)+\)$/', $value ) ) {
return PostgreSQL::C_DATATYPE_SPECIAL_POLYGON;
}
if ( preg_match( '/^\-?\$[\d,\.]+$/', $value ) ) {
2014-10-13 09:24:53 +00:00
return PostgreSQL::C_DATATYPE_SPECIAL_MONEY;
}
}
2014-10-13 09:24:53 +00:00
if ( $this->startsWithZeros( $value ) ) return self::C_DATATYPE_TEXT;
2014-10-13 09:24:53 +00:00
if ( $value === FALSE || $value === TRUE || $value === NULL || ( $value instanceof NULL ) || ( is_numeric( $value )
&& floor( $value ) == $value
&& $value < 2147483648
&& $value > -2147483648 )
) {
return self::C_DATATYPE_INTEGER;
} elseif ( is_numeric( $value ) ) {
return self::C_DATATYPE_DOUBLE;
} else {
return self::C_DATATYPE_TEXT;
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::code
*/
public function code( $typedescription, $includeSpecials = FALSE )
{
$r = ( isset( $this->sqltype_typeno[$typedescription] ) ) ? $this->sqltype_typeno[$typedescription] : 99;
if ( $includeSpecials ) return $r;
2014-10-13 09:24:53 +00:00
if ( $r >= QueryWriter::C_DATATYPE_RANGE_SPECIAL ) {
return self::C_DATATYPE_SPECIFIED;
}
return $r;
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::widenColumn
*/
public function widenColumn( $type, $column, $datatype )
{
$table = $type;
$type = $datatype;
$table = $this->esc( $table );
$column = $this->esc( $column );
$newtype = $this->typeno_sqltype[$type];
$this->adapter->exec( "ALTER TABLE $table \n\t ALTER COLUMN $column TYPE $newtype " );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addUniqueIndex
*/
public function addUniqueIndex( $table, $columns )
{
$table = $this->esc( $table, TRUE );
sort( $columns ); //else we get multiple indexes due to order-effects
foreach ( $columns as $k => $v ) {
$columns[$k] = $this->esc( $v );
}
$r = $this->adapter->get( "SELECT i.relname AS index_name
FROM pg_class t,pg_class i,pg_index ix,pg_attribute a
WHERE t.oid = ix.indrelid
AND i.oid = ix.indexrelid
AND a.attrelid = t.oid
AND a.attnum = ANY(ix.indkey)
AND t.relkind = 'r'
AND t.relname = '$table'
ORDER BY t.relname, i.relname;" );
$name = "UQ_" . sha1( $table . implode( ',', $columns ) );
if ( $r ) {
foreach ( $r as $i ) {
if ( strtolower( $i['index_name'] ) == strtolower( $name ) ) {
return;
}
}
}
$sql = "ALTER TABLE \"$table\"
ADD CONSTRAINT $name UNIQUE (" . implode( ',', $columns ) . ")";
$this->adapter->exec( $sql );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::sqlStateIn
*/
public function sqlStateIn( $state, $list )
{
$stateMap = array(
2014-10-13 09:24:53 +00:00
'42P01' => QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
'42703' => QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN,
'23505' => QueryWriter::C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION
);
return in_array( ( isset( $stateMap[$state] ) ? $stateMap[$state] : '0' ), $list );
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addIndex
*/
public function addIndex( $type, $name, $column )
{
$table = $type;
$table = $this->esc( $table );
$name = preg_replace( '/\W/', '', $name );
$column = $this->esc( $column );
if ( $this->adapter->getCell( "SELECT COUNT(*) FROM pg_class WHERE relname = '$name'" ) ) {
return;
}
try {
$this->adapter->exec( "CREATE INDEX $name ON $table ($column) " );
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
//do nothing
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::addFK
*/
public function addFK( $type, $targetType, $field, $targetField, $isDep = FALSE )
{
2014-10-13 09:24:53 +00:00
$db = $this->adapter->getCell( 'SELECT current_database()' );
$cfks = $this->adapter->getCell('
SELECT constraint_name
FROM information_schema.KEY_COLUMN_USAGE
WHERE
table_catalog = ?
AND table_schema = ANY( current_schemas( FALSE ) )
AND table_name = ?
AND column_name = ?
', array($db, $type, $field));
try{
if (!$cfks) {
$delRule = ( $isDep ? 'CASCADE' : 'SET NULL' );
2014-10-13 09:24:53 +00:00
$this->adapter->exec( "ALTER TABLE {$this->esc($type)}
ADD FOREIGN KEY ( {$this->esc($field)} ) REFERENCES {$this->esc($targetType)} (
{$this->esc($targetField)}) ON DELETE $delRule ON UPDATE $delRule DEFERRABLE ;" );
}
2014-10-13 09:24:53 +00:00
} catch (\Exception $e ) {
return FALSE;
}
}
/**
2014-10-13 09:24:53 +00:00
* @see QueryWriter::wipeAll
*/
public function wipeAll()
{
$this->adapter->exec( 'SET CONSTRAINTS ALL DEFERRED' );
foreach ( $this->getTables() as $t ) {
$t = $this->esc( $t );
$this->adapter->exec( "DROP TABLE IF EXISTS $t CASCADE " );
}
$this->adapter->exec( 'SET CONSTRAINTS ALL IMMEDIATE' );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
/**
* RedBean\Exception Base
*
* @file RedBean/Exception.php
* @desc Represents the base class for RedBean\Exceptions
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class RedException extends \Exception
{
2014-10-13 09:24:53 +00:00
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\RedException {
use RedBeanPHP\RedException as RedException;
/**
* RedBean\Exception SQL
*
* @file RedBean/Exception/SQL.php
* @desc Represents a generic database exception independent of the underlying driver.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class SQL extends RedException
{
/**
* @var string
*/
2014-10-13 09:24:53 +00:00
private $sqlState;
/**
2014-10-13 09:24:53 +00:00
* Returns an ANSI-92 compliant SQL state.
*
2014-10-13 09:24:53 +00:00
* @return string $state ANSI state code
*/
2014-10-13 09:24:53 +00:00
public function getSQLState()
{
2014-10-13 09:24:53 +00:00
return $this->sqlState;
}
/**
2014-10-13 09:24:53 +00:00
* @todo parse state to verify valid ANSI92!
* Stores ANSI-92 compliant SQL state.
*
2014-10-13 09:24:53 +00:00
* @param string $sqlState code
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function setSQLState( $sqlState )
{
2014-10-13 09:24:53 +00:00
$this->sqlState = $sqlState;
}
/**
2014-10-13 09:24:53 +00:00
* To String prints both code and SQL state.
*
2014-10-13 09:24:53 +00:00
* @return string $message prints this exception instance as a string
*/
2014-10-13 09:24:53 +00:00
public function __toString()
{
2014-10-13 09:24:53 +00:00
return '[' . $this->getSQLState() . '] - ' . $this->getMessage()."\n".
'trace: ' . $this->getTraceAsString();
}
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\BeanHelper\FacadeBeanHelper as FacadeBeanHelper;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\SimpleModel as SimpleModel;
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\OODB as OODB;
2014-10-13 09:24:53 +00:00
/**
* Abstract Repository
*
* @file RedBean/Repository.php
* @desc RedBean Object Database
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* OODB manages two repositories, a fluid one that
* adjust the database schema on-the-fly to accomodate for
* new bean types (tables) and new properties (columns) and
* a frozen one for use in a production environment. OODB
* allows you to swap the repository instances using the freeze()
* method.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
abstract class Repository
{
/**
* @var array
*/
protected $stash = NULL;
2014-10-13 09:24:53 +00:00
/*
* @var integer
*/
protected $nesting = 0;
2014-10-13 09:24:53 +00:00
/**
* @var DBAdapter
*/
protected $writer;
/**
2014-10-13 09:24:53 +00:00
* Process groups. Internal function. Processes different kind of groups for
* storage function. Given a list of original beans and a list of current beans,
* this function calculates which beans remain in the list (residue), which
* have been deleted (are in the trashcan) and which beans have been added
* (additions).
*
* @param array $originals originals
* @param array $current the current beans
* @param array $additions beans that have been added
* @param array $trashcan beans that have been deleted
* @param array $residue beans that have been left untouched
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
protected function processGroups( $originals, $current, $additions, $trashcan, $residue )
{
2014-10-13 09:24:53 +00:00
return array(
array_merge( $additions, array_diff( $current, $originals ) ),
array_merge( $trashcan, array_diff( $originals, $current ) ),
array_merge( $residue, array_intersect( $current, $originals ) )
);
}
/**
2014-10-13 09:24:53 +00:00
* Processes an embedded bean.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|SimpleModel $embeddedBean the bean or model
*
* @return integer
*/
2014-10-13 09:24:53 +00:00
protected function prepareEmbeddedBean( $embeddedBean )
{
2014-10-13 09:24:53 +00:00
if ( !$embeddedBean->id || $embeddedBean->getMeta( 'tainted' ) ) {
$this->store( $embeddedBean );
}
return $embeddedBean->id;
}
/**
2014-10-13 09:24:53 +00:00
* Processes a list of beans from a bean. A bean may contain lists. This
* method handles shared addition lists; i.e. the $bean->sharedObject properties.
*
* @param OODBBean $bean the bean
* @param array $sharedAdditions list with shared additions
*
* @return void
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
protected function processSharedAdditions( $bean, $sharedAdditions )
{
2014-10-13 09:24:53 +00:00
foreach ( $sharedAdditions as $addition ) {
if ( $addition instanceof OODBBean ) {
$this->oodb->getAssociationManager()->associate( $addition, $bean );
} else {
throw new RedException( 'Array may only contain OODBBeans' );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Processes a list of beans from a bean. A bean may contain lists. This
* method handles own lists; i.e. the $bean->ownObject properties.
* A residue is a bean in an own-list that stays where it is. This method
* checks if there have been any modification to this bean, in that case
* the bean is stored once again, otherwise the bean will be left untouched.
*
* @param OODBBean $bean the bean
* @param array $ownresidue list
*
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processResidue( $ownresidue )
{
2014-10-13 09:24:53 +00:00
foreach ( $ownresidue as $residue ) {
if ( $residue->getMeta( 'tainted' ) ) {
$this->store( $residue );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Processes a list of beans from a bean. A bean may contain lists. This
* method handles own lists; i.e. the $bean->ownObject properties.
* A trash can bean is a bean in an own-list that has been removed
* (when checked with the shadow). This method
* checks if the bean is also in the dependency list. If it is the bean will be removed.
* If not, the connection between the bean and the owner bean will be broken by
* setting the ID to NULL.
*
* @param OODBBean $bean the bean
* @param array $ownTrashcan list
*
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processTrashcan( $bean, $ownTrashcan )
{
2014-10-13 09:24:53 +00:00
foreach ( $ownTrashcan as $trash ) {
2014-10-13 09:24:53 +00:00
$myFieldLink = $bean->getMeta( 'type' ) . '_id';
$alias = $bean->getMeta( 'sys.alias.' . $trash->getMeta( 'type' ) );
if ( $alias ) $myFieldLink = $alias . '_id';
2014-10-13 09:24:53 +00:00
if ( $trash->getMeta( 'sys.garbage' ) === true ) {
$this->trash( $trash );
} else {
$trash->$myFieldLink = NULL;
$this->store( $trash );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Unassociates the list items in the trashcan.
*
* @param OODBBean $bean bean
* @param array $sharedTrashcan list
*
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processSharedTrashcan( $bean, $sharedTrashcan )
{
2014-10-13 09:24:53 +00:00
foreach ( $sharedTrashcan as $trash ) {
$this->oodb->getAssociationManager()->unassociate( $trash, $bean );
}
}
/**
2014-10-13 09:24:53 +00:00
* Stores all the beans in the residue group.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
* @param array $sharedresidue list
*
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processSharedResidue( $bean, $sharedresidue )
{
2014-10-13 09:24:53 +00:00
foreach ( $sharedresidue as $residue ) {
$this->store( $residue );
}
}
/**
2014-10-13 09:24:53 +00:00
* Determines whether the bean has 'loaded lists' or
* 'loaded embedded beans' that need to be processed
* by the store() method.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to be examined
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
protected function hasListsOrObjects( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$processLists = FALSE;
foreach ( $bean as $value ) {
if ( is_array( $value ) || is_object( $value ) ) {
$processLists = TRUE;
break;
}
}
2014-10-13 09:24:53 +00:00
return $processLists;
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Converts an embedded bean to an ID, removed the bean property and
* stores the bean in the embedded beans array.
*
2014-10-13 09:24:53 +00:00
* @param array $embeddedBeans destination array for embedded bean
* @param OODBBean $bean target bean
* @param string $property property that contains the embedded bean
* @param OODBBean $value embedded bean itself
*/
2014-10-13 09:24:53 +00:00
protected function processEmbeddedBean( &$embeddedBeans, $bean, $property, OODBBean $value )
{
2014-10-13 09:24:53 +00:00
$linkField = $property . '_id';
$id = $this->prepareEmbeddedBean( $value );
if ($bean->$linkField != $id) $bean->$linkField = $id;
$bean->setMeta( 'cast.' . $linkField, 'id' );
$embeddedBeans[$linkField] = $value;
unset( $bean->$property );
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Constructor, requires a query writer.
*
2014-10-13 09:24:53 +00:00
* @param QueryWriter $writer writer
*/
2014-10-13 09:24:53 +00:00
public function __construct( OODB $oodb, QueryWriter $writer )
{
2014-10-13 09:24:53 +00:00
$this->writer = $writer;
$this->oodb = $oodb;
}
/**
2014-10-13 09:24:53 +00:00
* Checks whether a OODBBean bean is valid.
* If the type is not valid or the ID is not valid it will
* throw an exception: Security.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean the bean that needs to be checked
*
2014-10-13 09:24:53 +00:00
* @return void
*
* @throws Security $exception
*/
2014-10-13 09:24:53 +00:00
public function check( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
//Is all meta information present?
if ( !isset( $bean->id ) ) {
throw new RedException( 'Bean has incomplete Meta Information id ' );
}
if ( !( $bean->getMeta( 'type' ) ) ) {
throw new RedException( 'Bean has incomplete Meta Information II' );
}
//Pattern of allowed characters
$pattern = '/[^a-z0-9_]/i';
//Does the type contain invalid characters?
if ( preg_match( $pattern, $bean->getMeta( 'type' ) ) ) {
throw new RedException( 'Bean Type is invalid' );
}
//Are the properties and values valid?
foreach ( $bean as $prop => $value ) {
if (
is_array( $value )
|| ( is_object( $value ) )
) {
throw new RedException( "Invalid Bean value: property $prop" );
} else if (
strlen( $prop ) < 1
|| preg_match( $pattern, $prop )
) {
throw new RedException( "Invalid Bean property: property $prop" );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Searches the database for a bean that matches conditions $conditions and sql $addSQL
* and returns an array containing all the beans that have been found.
*
* Conditions need to take form:
*
* array(
* 'PROPERTY' => array( POSSIBLE VALUES... 'John', 'Steve' )
* 'PROPERTY' => array( POSSIBLE VALUES... )
* );
*
* All conditions are glued together using the AND-operator, while all value lists
* are glued using IN-operators thus acting as OR-conditions.
*
* Note that you can use property names; the columns will be extracted using the
* appropriate bean formatter.
*
* @param string $type type of beans you are looking for
* @param array $conditions list of conditions
* @param string $addSQL SQL to be used in query
* @param array $bindings whether you prefer to use a WHERE clause or not (TRUE = not)
*
2014-10-13 09:24:53 +00:00
* @return array
*
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public function find( $type, $conditions = array(), $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
//for backward compatibility, allow mismatch arguments:
if ( is_array( $sql ) ) {
if ( isset( $sql[1] ) ) {
$bindings = $sql[1];
}
$sql = $sql[0];
}
try {
$beans = $this->convertToBeans( $type, $this->writer->queryRecord( $type, $conditions, $sql, $bindings ) );
2014-10-13 09:24:53 +00:00
return $beans;
} catch ( SQL $exception ) {
$this->handleException( $exception );
}
return array();
}
/**
2014-10-13 09:24:53 +00:00
* Stores a bean in the database. This method takes a
* OODBBean Bean Object $bean and stores it
* in the database. If the database schema is not compatible
* with this bean and RedBean runs in fluid mode the schema
* will be altered to store the bean correctly.
* If the database schema is not compatible with this bean and
* RedBean runs in frozen mode it will throw an exception.
* This function returns the primary key ID of the inserted
* bean.
*
* The return value is an integer if possible. If it is not possible to
* represent the value as an integer a string will be returned. We use
* explicit casts instead of functions to preserve performance
* (0.13 vs 0.28 for 10000 iterations on Core i3).
*
* @param OODBBean|SimpleModel $bean bean to store
*
2014-10-13 09:24:53 +00:00
* @return integer|string
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public function store( $bean )
{
2014-10-13 09:24:53 +00:00
$processLists = $this->hasListsOrObjects( $bean );
if ( !$processLists && !$bean->getMeta( 'tainted' ) ) {
return $bean->getID(); //bail out!
}
$this->oodb->signal( 'update', $bean );
$processLists = $this->hasListsOrObjects( $bean ); //check again, might have changed by model!
if ( $processLists ) {
$this->processLists( $bean );
} else {
$this->storeBean( $bean );
}
2014-10-13 09:24:53 +00:00
$this->oodb->signal( 'after_update', $bean );
2014-10-13 09:24:53 +00:00
return ( (string) $bean->id === (string) (int) $bean->id ) ? (int) $bean->id : (string) $bean->id;
}
/**
2014-10-13 09:24:53 +00:00
* Returns an array of beans. Pass a type and a series of ids and
* this method will bring you the corresponding beans.
*
2014-10-13 09:24:53 +00:00
* important note: Because this method loads beans using the load()
* function (but faster) it will return empty beans with ID 0 for
* every bean that could not be located. The resulting beans will have the
* passed IDs as their keys.
*
* @param string $type type of beans
* @param array $ids ids to load
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function batch( $type, $ids )
{
2014-10-13 09:24:53 +00:00
if ( !$ids ) {
return array();
}
$collection = array();
try {
$rows = $this->writer->queryRecord( $type, array( 'id' => $ids ) );
} catch ( SQL $e ) {
$this->handleException( $e );
$rows = FALSE;
}
$this->stash[$this->nesting] = array();
if ( !$rows ) {
return array();
}
foreach ( $rows as $row ) {
$this->stash[$this->nesting][$row['id']] = $row;
}
foreach ( $ids as $id ) {
$collection[$id] = $this->load( $type, $id );
}
$this->stash[$this->nesting] = NULL;
2014-10-13 09:24:53 +00:00
return $collection;
}
/**
2014-10-13 09:24:53 +00:00
* This is a convenience method; it converts database rows
* (arrays) into beans. Given a type and a set of rows this method
* will return an array of beans of the specified type loaded with
* the data fields provided by the result set from the database.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans you would like to have
* @param array $rows rows from the database result
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function convertToBeans( $type, $rows )
{
2014-10-13 09:24:53 +00:00
$collection = array();
$this->stash[$this->nesting] = array();
foreach ( $rows as $row ) {
$id = $row['id'];
$this->stash[$this->nesting][$id] = $row;
$collection[$id] = $this->load( $type, $id );
}
$this->stash[$this->nesting] = NULL;
2014-10-13 09:24:53 +00:00
return $collection;
}
/**
2014-10-13 09:24:53 +00:00
* Counts the number of beans of type $type.
* This method accepts a second argument to modify the count-query.
* A third argument can be used to provide bindings for the SQL snippet.
*
* @param string $type type of bean we are looking for
* @param string $addSQL additional SQL snippet
* @param array $bindings parameters to bind to SQL
*
* @return integer
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public function count( $type, $addSQL = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$type = AQueryWriter::camelsSnake( $type );
if ( count( explode( '_', $type ) ) > 2 ) {
throw new RedException( 'Invalid type for count.' );
}
2014-10-13 09:24:53 +00:00
try {
return (int) $this->writer->queryRecordCount( $type, array(), $addSQL, $bindings );
} catch ( SQL $exception ) {
if ( !$this->writer->sqlStateIn( $exception->getSQLState(), array(
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN ) ) ) {
throw $exception;
}
}
2014-10-13 09:24:53 +00:00
return 0;
}
/**
2014-10-13 09:24:53 +00:00
* Removes a bean from the database.
* This function will remove the specified OODBBean
* Bean Object from the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|SimpleModel $bean bean you want to remove from database
*
2014-10-13 09:24:53 +00:00
* @return void
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public function trash( $bean )
{
2014-10-13 09:24:53 +00:00
$this->oodb->signal( 'delete', $bean );
foreach ( $bean as $property => $value ) {
if ( $value instanceof OODBBean ) {
unset( $bean->$property );
}
if ( is_array( $value ) ) {
if ( strpos( $property, 'own' ) === 0 ) {
unset( $bean->$property );
} elseif ( strpos( $property, 'shared' ) === 0 ) {
unset( $bean->$property );
}
}
}
try {
$this->writer->deleteRecord( $bean->getMeta( 'type' ), array( 'id' => array( $bean->id ) ), NULL );
} catch ( SQL $exception ) {
$this->handleException( $exception );
}
2014-10-13 09:24:53 +00:00
$bean->id = 0;
$this->oodb->signal( 'after_delete', $bean );
}
/**
2014-10-13 09:24:53 +00:00
* Checks whether the specified table already exists in the database.
* Not part of the Object Database interface!
*
* @deprecated Use AQueryWriter::typeExists() instead.
*
* @param string $table table name
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function tableExists( $table )
{
2014-10-13 09:24:53 +00:00
return $this->writer->tableExists( $table );
}
/**
2014-10-13 09:24:53 +00:00
* Trash all beans of a given type. Wipes an entire type of bean.
*
* @param string $type type of bean you wish to delete all instances of
*
* @return boolean
*
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public function wipe( $type )
{
2014-10-13 09:24:53 +00:00
try {
$this->writer->wipe( $type );
2014-10-13 09:24:53 +00:00
return TRUE;
} catch ( SQL $exception ) {
if ( !$this->writer->sqlStateIn( $exception->getSQLState(), array( QueryWriter::C_SQLSTATE_NO_SUCH_TABLE ) ) ) {
throw $exception;
}
2014-10-13 09:24:53 +00:00
return FALSE;
}
}
2014-10-13 09:24:53 +00:00
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\Repository {
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\BeanHelper\FacadeBeanHelper as FacadeBeanHelper;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\SimpleModel as SimpleModel;
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\Repository as Repository;
2014-10-13 09:24:53 +00:00
/**
* Fluid Repository
*
* @file RedBean/Repository/Fluid.php
* @desc RedBean Object Database
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* OODB manages two repositories, a fluid one that
* adjust the database schema on-the-fly to accomodate for
* new bean types (tables) and new properties (columns) and
* a frozen one for use in a production environment. OODB
* allows you to swap the repository instances using the freeze()
* method.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class Fluid extends Repository
{
/**
2014-10-13 09:24:53 +00:00
* Figures out the desired type given the cast string ID.
*
2014-10-13 09:24:53 +00:00
* @param string $cast cast identifier
*
2014-10-13 09:24:53 +00:00
* @return integer
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
private function getTypeFromCast( $cast )
{
2014-10-13 09:24:53 +00:00
if ( $cast == 'string' ) {
$typeno = $this->writer->scanType( 'STRING' );
} elseif ( $cast == 'id' ) {
$typeno = $this->writer->getTypeForID();
} elseif ( isset( $this->writer->sqltype_typeno[$cast] ) ) {
$typeno = $this->writer->sqltype_typeno[$cast];
} else {
2014-10-13 09:24:53 +00:00
throw new RedException( 'Invalid Cast' );
}
2014-10-13 09:24:53 +00:00
return $typeno;
}
/**
2014-10-13 09:24:53 +00:00
* Orders the Query Writer to create a table if it does not exist already and
* adds a note in the build report about the creation.
*
* @param OODBBean $bean bean to update report of
* @param string $table table to check and create if not exists
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
private function createTableIfNotExists( OODBBean $bean, $table )
{
2014-10-13 09:24:53 +00:00
//Does table exist? If not, create
if ( !$this->tableExists( $this->writer->esc( $table, TRUE ) ) ) {
$this->writer->createTable( $table );
$bean->setMeta( 'buildreport.flags.created', TRUE );
}
}
/**
2014-10-13 09:24:53 +00:00
* Processes all column based build commands.
* A build command is an additional instruction for the Query Writer. It is processed only when
* a column gets created. The build command is often used to instruct the writer to write some
* extra SQL to create indexes or constraints. Build commands are stored in meta data of the bean.
* They are only for internal use, try to refrain from using them in your code directly.
*
2014-10-13 09:24:53 +00:00
* @param string $table name of the table to process build commands for
* @param string $property name of the property to process build commands for
* @param OODBBean $bean bean that contains the build commands
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
private function processBuildCommands( $table, $property, OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
if ( $inx = ( $bean->getMeta( 'buildcommand.indexes' ) ) ) {
if ( isset( $inx[$property] ) ) {
$this->writer->addIndex( $table, $inx[$property], $property );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Adds the unique constraints described in the meta data.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
private function addUniqueConstraints( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
if ( $uniques = $bean->getMeta( 'buildcommand.unique' ) ) {
$table = $bean->getMeta( 'type' );
foreach ( $uniques as $unique ) {
if ( !$this->oodb->isChilled( $table ) ) $this->writer->addUniqueIndex( $table, $unique );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Molds the table to fit the bean data.
* Given a property and a value and the bean, this method will
* adjust the table structure to fit the requirements of the property and value.
* This may include adding a new column or widening an existing column to hold a larger
* or different kind of value. This method employs the writer to adjust the table
* structure in the database. Schema updates are recorded in meta properties of the bean.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to get cast data from and store meta in
* @param string $property property to store
* @param mixed $value value to store
*
* @return void
*/
2014-10-13 09:24:53 +00:00
private function moldTable( OODBBean $bean, $property, $value )
{
2014-10-13 09:24:53 +00:00
$table = $bean->getMeta( 'type' );
$columns = $this->writer->getColumns( $table );
if ( !$this->oodb->isChilled( $bean->getMeta( 'type' ) ) ) {
if ( $bean->getMeta( "cast.$property", -1 ) !== -1 ) { //check for explicitly specified types
$cast = $bean->getMeta( "cast.$property" );
$typeno = $this->getTypeFromCast( $cast );
} else {
$cast = FALSE;
$typeno = $this->writer->scanType( $value, TRUE );
}
if ( isset( $columns[$this->writer->esc( $property, TRUE )] ) ) { //Is this property represented in the table ?
if ( !$cast ) { //rescan without taking into account special types >80
$typeno = $this->writer->scanType( $value, FALSE );
}
$sqlt = $this->writer->code( $columns[$this->writer->esc( $property, TRUE )] );
if ( $typeno > $sqlt ) { //no, we have to widen the database column type
$this->writer->widenColumn( $table, $property, $typeno );
$bean->setMeta( 'buildreport.flags.widen', TRUE );
}
} else {
$this->writer->addColumn( $table, $property, $typeno );
$bean->setMeta( 'buildreport.flags.addcolumn', TRUE );
$this->processBuildCommands( $table, $property, $bean );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Processes embedded beans.
* Each embedded bean will be indexed and foreign keys will
* be created if the bean is in the dependency list.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
* @param array $embeddedBeans embedded beans
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
private function addForeignKeysForParentBeans( $bean, $embeddedBeans )
{
2014-10-13 09:24:53 +00:00
$cachedIndex = array();
foreach ( $embeddedBeans as $linkField => $embeddedBean ) {
$beanType = $bean->getMeta( 'type' );
$embeddedType = $embeddedBean->getMeta( 'type' );
$key = $beanType . '|' . $embeddedType . '>' . $linkField;
if ( !isset( $cachedIndex[$key] ) ) {
$this->writer->addIndex( $bean->getMeta( 'type' ),
'index_foreignkey_' . $beanType . '_' . $embeddedType,
$linkField );
$this->writer->addFK( $beanType, $embeddedType, $linkField, 'id', FALSE );
$cachedIndex[$key] = TRUE;
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Part of the store() functionality.
* Handles all new additions after the bean has been saved.
* Stores addition bean in own-list, extracts the id and
* adds a foreign key. Also adds a constraint in case the type is
* in the dependent list.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
* @param array $ownAdditions list of addition beans in own-list
*
* @return void
2014-10-13 09:24:53 +00:00
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
private function processAdditions( $bean, $ownAdditions )
{
2014-10-13 09:24:53 +00:00
$beanType = $bean->getMeta( 'type' );
2014-10-13 09:24:53 +00:00
$cachedIndex = array();
foreach ( $ownAdditions as $addition ) {
if ( $addition instanceof OODBBean ) {
2014-10-13 09:24:53 +00:00
$myFieldLink = $beanType . '_id';
$alias = $bean->getMeta( 'sys.alias.' . $addition->getMeta( 'type' ) );
if ( $alias ) $myFieldLink = $alias . '_id';
2014-10-13 09:24:53 +00:00
$addition->$myFieldLink = $bean->id;
$addition->setMeta( 'cast.' . $myFieldLink, 'id' );
$this->store( $addition );
$additionType = $addition->getMeta( 'type' );
$key = $additionType . '|' . $beanType . '>' . $myFieldLink;
if ( !isset( $cachedIndex[$key] ) ) {
$this->writer->addIndex( $additionType,
'index_foreignkey_' . $additionType . '_' . $beanType,
$myFieldLink );
$isDep = $bean->getMeta( 'sys.exclusive-'.$additionType );
$this->writer->addFK( $additionType, $beanType, $myFieldLink, 'id', $isDep );
$cachedIndex[$key] = TRUE;
}
2014-10-13 09:24:53 +00:00
} else {
throw new RedException( 'Array may only contain OODBBeans' );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Stores a cleaned bean; i.e. only scalar values. This is the core of the store()
* method. When all lists and embedded beans (parent objects) have been processed and
* removed from the original bean the bean is passed to this method to be stored
* in the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean the clean bean
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function storeBean( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
if ( $bean->getMeta( 'changed' ) ) {
$this->check( $bean );
$table = $bean->getMeta( 'type' );
$this->createTableIfNotExists( $bean, $table );
$updateValues = $this->getUpdateValues( $bean );
$this->addUniqueConstraints( $bean );
$bean->id = $this->writer->updateRecord( $table, $updateValues, $bean->id );
$bean->setMeta( 'changed', FALSE );
}
2014-10-13 09:24:53 +00:00
$bean->setMeta( 'tainted', FALSE );
}
/**
2014-10-13 09:24:53 +00:00
* Returns a structured array of update values using the following format:
* array(
* property => $property,
* value => $value
* );
*
* @param OODBBean $bean bean to extract update values from
*
* @return array
*/
2014-10-13 09:24:53 +00:00
protected function getUpdateValues( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$updateValues = array();
foreach ( $bean as $property => $value ) {
if ( $property !== 'id' ) {
$this->moldTable( $bean, $property, $value );
}
if ( $property !== 'id' ) {
$updateValues[] = array( 'property' => $property, 'value' => $value );
}
}
2014-10-13 09:24:53 +00:00
return $updateValues;
}
/**
2014-10-13 09:24:53 +00:00
* Handles\Exceptions. Suppresses exceptions caused by missing structures.
*
* @param\Exception $exception exception
*
2014-10-13 09:24:53 +00:00
* @return void
*
* @throws\Exception
*/
2014-10-13 09:24:53 +00:00
protected function handleException( \Exception $exception )
{
2014-10-13 09:24:53 +00:00
if ( !$this->writer->sqlStateIn( $exception->getSQLState(),
array(
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN ) )
) {
throw $exception;
}
}
/**
2014-10-13 09:24:53 +00:00
* Stores a bean and its lists in one run.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processLists( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$sharedAdditions = $sharedTrashcan = $sharedresidue = $sharedItems = $ownAdditions = $ownTrashcan = $ownresidue = $embeddedBeans = array(); //Define groups
foreach ( $bean as $property => $value ) {
$value = ( $value instanceof SimpleModel ) ? $value->unbox() : $value;
if ( $value instanceof OODBBean ) {
$this->processEmbeddedBean( $embeddedBeans, $bean, $property, $value );
} elseif ( is_array( $value ) ) {
$originals = $bean->getMeta( 'sys.shadow.' . $property, array() );
$bean->setMeta( 'sys.shadow.' . $property, NULL ); //clear shadow
if ( strpos( $property, 'own' ) === 0 ) {
list( $ownAdditions, $ownTrashcan, $ownresidue ) = $this->processGroups( $originals, $value, $ownAdditions, $ownTrashcan, $ownresidue );
$listName = lcfirst( substr( $property, 3 ) );
if ($bean->getMeta( 'sys.exclusive-'. $listName ) ) {
OODBBean::setMetaAll( $ownTrashcan, 'sys.garbage', TRUE );
}
unset( $bean->$property );
} elseif ( strpos( $property, 'shared' ) === 0 ) {
list( $sharedAdditions, $sharedTrashcan, $sharedresidue ) = $this->processGroups( $originals, $value, $sharedAdditions, $sharedTrashcan, $sharedresidue );
unset( $bean->$property );
}
}
}
2014-10-13 09:24:53 +00:00
$this->storeBean( $bean );
$this->addForeignKeysForParentBeans( $bean, $embeddedBeans );
$this->processTrashcan( $bean, $ownTrashcan );
$this->processAdditions( $bean, $ownAdditions );
$this->processResidue( $ownresidue );
$this->processSharedTrashcan( $bean, $sharedTrashcan );
$this->processSharedAdditions( $bean, $sharedAdditions );
$this->processSharedResidue( $bean, $sharedresidue );
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Dispenses a new bean (a OODBBean Bean Object)
* of the specified type. Always
* use this function to get an empty bean object. Never
* instantiate a OODBBean yourself because it needs
* to be configured before you can use it with RedBean. This
* function applies the appropriate initialization /
* configuration for you.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to dispense
* @param string $number number of beans you would like to get
* @param boolean $alwaysReturnArray if TRUE always returns the result as an array
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function dispense( $type, $number = 1, $alwaysReturnArray = FALSE )
{
2014-10-13 09:24:53 +00:00
$OODBBEAN = defined( 'REDBEAN_OODBBEAN_CLASS' ) ? REDBEAN_OODBBEAN_CLASS : '\RedBeanPHP\OODBBean';
$beans = array();
for ( $i = 0; $i < $number; $i++ ) {
$bean = new $OODBBEAN;
$bean->initializeForDispense( $type, $this->oodb->getBeanHelper() );
$this->check( $bean );
$this->oodb->signal( 'dispense', $bean );
$beans[] = $bean;
}
2014-10-13 09:24:53 +00:00
return ( count( $beans ) === 1 && !$alwaysReturnArray ) ? array_pop( $beans ) : $beans;
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Loads a bean from the object database.
* It searches for a OODBBean Bean Object in the
* database. It does not matter how this bean has been stored.
* RedBean uses the primary key ID $id and the string $type
* to find the bean. The $type specifies what kind of bean you
* are looking for; this is the same type as used with the
* dispense() function. If RedBean finds the bean it will return
* the OODB Bean object; if it cannot find the bean
* RedBean will return a new bean of type $type and with
* primary key ID 0. In the latter case it acts basically the
* same as dispense().
*
* Important note:
* If the bean cannot be found in the database a new bean of
* the specified type will be generated and returned.
*
* @param string $type type of bean you want to load
* @param integer $id ID of the bean you want to load
*
* @throws SQL
*
* @return OODBBean
*
*/
2014-10-13 09:24:53 +00:00
public function load( $type, $id )
{
2014-10-13 09:24:53 +00:00
$bean = $this->dispense( $type );
if ( isset( $this->stash[$this->nesting][$id] ) ) {
$row = $this->stash[$this->nesting][$id];
} else {
2014-10-13 09:24:53 +00:00
try {
$rows = $this->writer->queryRecord( $type, array( 'id' => array( $id ) ) );
} catch ( SQL $exception ) {
if ( $this->writer->sqlStateIn( $exception->getSQLState(),
array(
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN,
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE )
)
) {
$rows = 0;
}
}
if ( empty( $rows ) ) {
return $bean;
}
$row = array_pop( $rows );
}
2014-10-13 09:24:53 +00:00
$bean->importRow( $row );
$this->nesting++;
$this->oodb->signal( 'open', $bean );
$this->nesting--;
return $bean->setMeta( 'tainted', FALSE );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP\Repository {
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\BeanHelper\FacadeBeanHelper as FacadeBeanHelper;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\SimpleModel as SimpleModel;
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\Repository as Repository;
2014-10-13 09:24:53 +00:00
/**
* Frozen Repository
*
* @file RedBean/Repository/Frozen.php
* @desc RedBean Object Database
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* OODB manages two repositories, a fluid one that
* adjust the database schema on-the-fly to accomodate for
* new bean types (tables) and new properties (columns) and
* a frozen one for use in a production environment. OODB
* allows you to swap the repository instances using the freeze()
* method.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class Frozen extends Repository
{
/**
2014-10-13 09:24:53 +00:00
* Handles\Exceptions. Suppresses exceptions caused by missing structures.
*
2014-10-13 09:24:53 +00:00
* @param \Exception $exception exception
*
2014-10-13 09:24:53 +00:00
* @return void
*
2014-10-13 09:24:53 +00:00
* @throws \Exception
*/
2014-10-13 09:24:53 +00:00
protected function handleException( \Exception $exception )
{
2014-10-13 09:24:53 +00:00
throw $exception;
}
/**
2014-10-13 09:24:53 +00:00
* Stores a cleaned bean; i.e. only scalar values. This is the core of the store()
* method. When all lists and embedded beans (parent objects) have been processed and
* removed from the original bean the bean is passed to this method to be stored
* in the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean the clean bean
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function storeBean( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
if ( $bean->getMeta( 'changed' ) ) {
2014-10-13 09:24:53 +00:00
list( $properties, $table ) = $bean->getPropertiesAndType();
$id = $properties['id'];
unset($properties['id']);
$updateValues = array();
$k1 = 'property';
$k2 = 'value';
foreach( $properties as $key => $value ) {
$updateValues[] = array( $k1 => $key, $k2 => $value );
}
$bean->id = $this->writer->updateRecord( $table, $updateValues, $id );
$bean->setMeta( 'changed', FALSE );
}
$bean->setMeta( 'tainted', FALSE );
}
/**
2014-10-13 09:24:53 +00:00
* Part of the store() functionality.
* Handles all new additions after the bean has been saved.
* Stores addition bean in own-list, extracts the id and
* adds a foreign key. Also adds a constraint in case the type is
* in the dependent list.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
* @param array $ownAdditions list of addition beans in own-list
*
2014-10-13 09:24:53 +00:00
* @return void
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
protected function processAdditions( $bean, $ownAdditions )
{
2014-10-13 09:24:53 +00:00
$beanType = $bean->getMeta( 'type' );
2014-10-13 09:24:53 +00:00
$cachedIndex = array();
foreach ( $ownAdditions as $addition ) {
if ( $addition instanceof OODBBean ) {
2014-10-13 09:24:53 +00:00
$myFieldLink = $beanType . '_id';
$alias = $bean->getMeta( 'sys.alias.' . $addition->getMeta( 'type' ) );
if ( $alias ) $myFieldLink = $alias . '_id';
$addition->$myFieldLink = $bean->id;
$addition->setMeta( 'cast.' . $myFieldLink, 'id' );
$this->store( $addition );
} else {
throw new RedException( 'Array may only contain OODBBeans' );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Stores a bean and its lists in one run.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
protected function processLists( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$sharedAdditions = $sharedTrashcan = $sharedresidue = $sharedItems = $ownAdditions = $ownTrashcan = $ownresidue = $embeddedBeans = array(); //Define groups
foreach ( $bean as $property => $value ) {
$value = ( $value instanceof SimpleModel ) ? $value->unbox() : $value;
if ( $value instanceof OODBBean ) {
$this->processEmbeddedBean( $embeddedBeans, $bean, $property, $value );
} elseif ( is_array( $value ) ) {
$originals = $bean->getMeta( 'sys.shadow.' . $property, array() );
$bean->setMeta( 'sys.shadow.' . $property, NULL ); //clear shadow
if ( strpos( $property, 'own' ) === 0 ) {
list( $ownAdditions, $ownTrashcan, $ownresidue ) = $this->processGroups( $originals, $value, $ownAdditions, $ownTrashcan, $ownresidue );
$listName = lcfirst( substr( $property, 3 ) );
if ($bean->getMeta( 'sys.exclusive-'. $listName ) ) {
OODBBean::setMetaAll( $ownTrashcan, 'sys.garbage', TRUE );
}
unset( $bean->$property );
} elseif ( strpos( $property, 'shared' ) === 0 ) {
list( $sharedAdditions, $sharedTrashcan, $sharedresidue ) = $this->processGroups( $originals, $value, $sharedAdditions, $sharedTrashcan, $sharedresidue );
unset( $bean->$property );
}
}
}
2014-10-13 09:24:53 +00:00
$this->storeBean( $bean );
$this->processTrashcan( $bean, $ownTrashcan );
$this->processAdditions( $bean, $ownAdditions );
$this->processResidue( $ownresidue );
$this->processSharedTrashcan( $bean, $sharedTrashcan );
$this->processSharedAdditions( $bean, $sharedAdditions );
$this->processSharedResidue( $bean, $sharedresidue );
}
/**
2014-10-13 09:24:53 +00:00
* Dispenses a new bean (a OODBBean Bean Object)
* of the specified type. Always
* use this function to get an empty bean object. Never
* instantiate a OODBBean yourself because it needs
* to be configured before you can use it with RedBean. This
* function applies the appropriate initialization /
* configuration for you.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to dispense
* @param string $number number of beans you would like to get
* @param boolean $alwaysReturnArray if TRUE always returns the result as an array
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function dispense( $type, $number = 1, $alwaysReturnArray = FALSE )
{
2014-10-13 09:24:53 +00:00
$OODBBEAN = defined( 'REDBEAN_OODBBEAN_CLASS' ) ? REDBEAN_OODBBEAN_CLASS : '\RedBeanPHP\OODBBean';
$beans = array();
for ( $i = 0; $i < $number; $i++ ) {
$bean = new $OODBBEAN;
$bean->initializeForDispense( $type, $this->oodb->getBeanHelper() );
$this->oodb->signal( 'dispense', $bean );
$beans[] = $bean;
}
2014-10-13 09:24:53 +00:00
return ( count( $beans ) === 1 && !$alwaysReturnArray ) ? array_pop( $beans ) : $beans;
}
/**
2014-10-13 09:24:53 +00:00
* Loads a bean from the object database.
* It searches for a OODBBean Bean Object in the
* database. It does not matter how this bean has been stored.
* RedBean uses the primary key ID $id and the string $type
* to find the bean. The $type specifies what kind of bean you
* are looking for; this is the same type as used with the
* dispense() function. If RedBean finds the bean it will return
* the OODB Bean object; if it cannot find the bean
* RedBean will return a new bean of type $type and with
* primary key ID 0. In the latter case it acts basically the
* same as dispense().
*
2014-10-13 09:24:53 +00:00
* Important note:
* If the bean cannot be found in the database a new bean of
* the specified type will be generated and returned.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to load
* @param integer $id ID of the bean you want to load
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*
*/
2014-10-13 09:24:53 +00:00
public function load( $type, $id )
{
2014-10-13 09:24:53 +00:00
$bean = $this->dispense( $type );
if ( isset( $this->stash[$this->nesting][$id] ) ) {
$row = $this->stash[$this->nesting][$id];
} else {
try {
$rows = $this->writer->queryRecord( $type, array( 'id' => array( $id ) ) );
} catch ( SQL $exception ) {
if ( $this->writer->sqlStateIn( $exception->getSQLState(),
array(
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN,
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE )
)
) {
throw $exception; //only throw if frozen
2014-10-13 09:24:53 +00:00
}
}
2014-10-13 09:24:53 +00:00
if ( empty( $rows ) ) {
return $bean;
}
2014-10-13 09:24:53 +00:00
$row = array_pop( $rows );
}
2014-10-13 09:24:53 +00:00
$bean->importRow( $row );
$this->nesting++;
$this->oodb->signal( 'open', $bean );
$this->nesting--;
2014-10-13 09:24:53 +00:00
return $bean->setMeta( 'tainted', FALSE );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\BeanHelper\FacadeBeanHelper as FacadeBeanHelper;
use RedBeanPHP\AssociationManager as AssociationManager;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\SimpleModel as SimpleModel;
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\Repository as Repository;
use RedBeanPHP\Repository\Fluid as FluidRepo;
use RedBeanPHP\Repository\Frozen as FrozenRepo;
/**
* RedBean Object Oriented DataBase
*
* @file RedBean/OODB.php
* @desc RedBean Object Database
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* The RedBean OODB Class is the main class of RedBeanPHP.
* It takes OODBBean objects and stores them to and loads them from the
* database as well as providing other CRUD functions. This class acts as a
* object database.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class OODB extends Observable
{
/**
2014-10-13 09:24:53 +00:00
* @var array
*/
2014-10-13 09:24:53 +00:00
private static $sqlFilters = array();
/**
2014-10-13 09:24:53 +00:00
* @var array
*/
2014-10-13 09:24:53 +00:00
protected $chillList = array();
/**
* @var array
*/
2014-10-13 09:24:53 +00:00
protected $stash = NULL;
2014-10-13 09:24:53 +00:00
/*
* @var integer
*/
2014-10-13 09:24:53 +00:00
protected $nesting = 0;
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
2014-10-13 09:24:53 +00:00
protected $writer;
/**
2014-10-13 09:24:53 +00:00
* @var boolean
*/
2014-10-13 09:24:53 +00:00
protected $isFrozen = FALSE;
/**
2014-10-13 09:24:53 +00:00
* @var FacadeBeanHelper
*/
2014-10-13 09:24:53 +00:00
protected $beanhelper = NULL;
/**
2014-10-13 09:24:53 +00:00
* @var AssociationManager
*/
2014-10-13 09:24:53 +00:00
protected $assocManager = NULL;
/**
2014-10-13 09:24:53 +00:00
* @var Repository
*/
2014-10-13 09:24:53 +00:00
protected $repository = NULL;
/**
2014-10-13 09:24:53 +00:00
* @var FrozenRepo
*/
2014-10-13 09:24:53 +00:00
protected $frozenRepository = NULL;
/**
2014-10-13 09:24:53 +00:00
* @var FluidRepo
*/
2014-10-13 09:24:53 +00:00
protected $fluidRepository = NULL;
/**
2014-10-13 09:24:53 +00:00
* Unboxes a bean from a FUSE model if needed and checks whether the bean is
* an instance of OODBBean.
*
* @param OODBBean $bean bean you wish to unbox
*
* @return OODBBean
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
protected function unboxIfNeeded( $bean )
{
if ( $bean instanceof SimpleModel ) {
$bean = $bean->unbox();
}
if ( !( $bean instanceof OODBBean ) ) {
throw new RedException( 'OODB Store requires a bean, got: ' . gettype( $bean ) );
}
return $bean;
}
/**
2014-10-13 09:24:53 +00:00
* Constructor, requires a query writer.
*
* @param QueryWriter $writer writer
*/
2014-10-13 09:24:53 +00:00
public function __construct( QueryWriter $writer )
{
if ( $writer instanceof QueryWriter ) {
$this->writer = $writer;
}
$this->freeze( FALSE );
}
/**
2014-10-13 09:24:53 +00:00
* Toggles fluid or frozen mode. In fluid mode the database
* structure is adjusted to accomodate your objects. In frozen mode
* this is not the case.
*
* You can also pass an array containing a selection of frozen types.
* Let's call this chilly mode, it's just like fluid mode except that
* certain types (i.e. tables) aren't touched.
*
* @param boolean|array $toggle TRUE if you want to use OODB instance in frozen mode
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function freeze( $toggle )
{
if ( is_array( $toggle ) ) {
$this->chillList = $toggle;
$this->isFrozen = FALSE;
} else {
$this->isFrozen = (boolean) $toggle;
}
if ( $this->isFrozen ) {
if ( !$this->frozenRepository ) {
$this->frozenRepository = new FrozenRepo( $this, $this->writer );
}
$this->repository = $this->frozenRepository;
} else {
if ( !$this->fluidRepository ) {
$this->fluidRepository = new FluidRepo( $this, $this->writer );
}
$this->repository = $this->fluidRepository;
}
if ( count( self::$sqlFilters ) ) {
AQueryWriter::setSQLFilters( self::$sqlFilters, ( !$this->isFrozen ) );
}
}
/**
2014-10-13 09:24:53 +00:00
* Returns the current mode of operation of RedBean.
* In fluid mode the database
* structure is adjusted to accomodate your objects.
* In frozen mode
* this is not the case.
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function isFrozen()
{
return (bool) $this->isFrozen;
}
/**
2014-10-13 09:24:53 +00:00
* Determines whether a type is in the chill list.
* If a type is 'chilled' it's frozen, so its schema cannot be
* changed anymore. However other bean types may still be modified.
* This method is a convenience method for other objects to check if
* the schema of a certain type is locked for modification.
*
* @param string $type the type you wish to check
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function isChilled( $type )
{
return (boolean) ( in_array( $type, $this->chillList ) );
}
/**
2014-10-13 09:24:53 +00:00
* Dispenses a new bean (a OODBBean Bean Object)
* of the specified type. Always
* use this function to get an empty bean object. Never
* instantiate a OODBBean yourself because it needs
* to be configured before you can use it with RedBean. This
* function applies the appropriate initialization /
* configuration for you.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to dispense
* @param string $number number of beans you would like to get
* @param boolean $alwaysReturnArray if TRUE always returns the result as an array
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
public function dispense( $type, $number = 1, $alwaysReturnArray = FALSE )
{
if ( $number < 1 ) {
if ( $alwaysReturnArray ) return array();
return NULL;
}
return $this->repository->dispense( $type, $number, $alwaysReturnArray );
}
/**
* Sets bean helper to be given to beans.
* Bean helpers assist beans in getting a reference to a toolbox.
*
2014-10-13 09:24:53 +00:00
* @param BeanHelper $beanhelper helper
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function setBeanHelper( BeanHelper $beanhelper )
{
2014-10-13 09:24:53 +00:00
$this->beanhelper = $beanhelper;
}
2014-10-13 09:24:53 +00:00
/**
* Returns the current bean helper.
* Bean helpers assist beans in getting a reference to a toolbox.
*
* @return BeanHelper
*/
public function getBeanHelper()
{
return $this->beanhelper;
}
/**
2014-10-13 09:24:53 +00:00
* Checks whether a OODBBean bean is valid.
* If the type is not valid or the ID is not valid it will
* throw an exception: Security.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean the bean that needs to be checked
*
* @return void
*
* @throws Security $exception
*/
2014-10-13 09:24:53 +00:00
public function check( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$this->repository->check( $bean );
}
/**
2014-10-13 09:24:53 +00:00
* Searches the database for a bean that matches conditions $conditions and sql $addSQL
* and returns an array containing all the beans that have been found.
*
2014-10-13 09:24:53 +00:00
* Conditions need to take form:
*
2014-10-13 09:24:53 +00:00
* array(
* 'PROPERTY' => array( POSSIBLE VALUES... 'John', 'Steve' )
* 'PROPERTY' => array( POSSIBLE VALUES... )
* );
*
2014-10-13 09:24:53 +00:00
* All conditions are glued together using the AND-operator, while all value lists
* are glued using IN-operators thus acting as OR-conditions.
*
2014-10-13 09:24:53 +00:00
* Note that you can use property names; the columns will be extracted using the
* appropriate bean formatter.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans you are looking for
* @param array $conditions list of conditions
* @param string $addSQL SQL to be used in query
* @param array $bindings whether you prefer to use a WHERE clause or not (TRUE = not)
*
* @return array
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public function find( $type, $conditions = array(), $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return $this->repository->find( $type, $conditions, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Checks whether the specified table already exists in the database.
* Not part of the Object Database interface!
*
2014-10-13 09:24:53 +00:00
* @deprecated Use AQueryWriter::typeExists() instead.
*
2014-10-13 09:24:53 +00:00
* @param string $table table name
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function tableExists( $table )
{
2014-10-13 09:24:53 +00:00
return $this->repository->tableExists( $table );
}
/**
2014-10-13 09:24:53 +00:00
* Stores a bean in the database. This method takes a
* OODBBean Bean Object $bean and stores it
* in the database. If the database schema is not compatible
* with this bean and RedBean runs in fluid mode the schema
* will be altered to store the bean correctly.
* If the database schema is not compatible with this bean and
* RedBean runs in frozen mode it will throw an exception.
* This function returns the primary key ID of the inserted
* bean.
*
2014-10-13 09:24:53 +00:00
* The return value is an integer if possible. If it is not possible to
* represent the value as an integer a string will be returned. We use
* explicit casts instead of functions to preserve performance
* (0.13 vs 0.28 for 10000 iterations on Core i3).
*
* @param OODBBean|SimpleModel $bean bean to store
*
* @return integer|string
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public function store( $bean )
{
2014-10-13 09:24:53 +00:00
$bean = $this->unboxIfNeeded( $bean );
return $this->repository->store( $bean );
}
/**
2014-10-13 09:24:53 +00:00
* Loads a bean from the object database.
* It searches for a OODBBean Bean Object in the
* database. It does not matter how this bean has been stored.
* RedBean uses the primary key ID $id and the string $type
* to find the bean. The $type specifies what kind of bean you
* are looking for; this is the same type as used with the
* dispense() function. If RedBean finds the bean it will return
* the OODB Bean object; if it cannot find the bean
* RedBean will return a new bean of type $type and with
* primary key ID 0. In the latter case it acts basically the
* same as dispense().
*
2014-10-13 09:24:53 +00:00
* Important note:
* If the bean cannot be found in the database a new bean of
* the specified type will be generated and returned.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to load
* @param integer $id ID of the bean you want to load
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*
*/
2014-10-13 09:24:53 +00:00
public function load( $type, $id )
{
2014-10-13 09:24:53 +00:00
return $this->repository->load( $type, $id );
}
/**
2014-10-13 09:24:53 +00:00
* Removes a bean from the database.
* This function will remove the specified OODBBean
* Bean Object from the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|SimpleModel $bean bean you want to remove from database
*
2014-10-13 09:24:53 +00:00
* @return void
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
public function trash( $bean )
{
$bean = $this->unboxIfNeeded( $bean );
return $this->repository->trash( $bean );
}
/**
* Returns an array of beans. Pass a type and a series of ids and
* this method will bring you the corresponding beans.
*
2014-10-13 09:24:53 +00:00
* important note: Because this method loads beans using the load()
* function (but faster) it will return empty beans with ID 0 for
* every bean that could not be located. The resulting beans will have the
* passed IDs as their keys.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans
* @param array $ids ids to load
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function batch( $type, $ids )
{
2014-10-13 09:24:53 +00:00
return $this->repository->batch( $type, $ids );
}
/**
2014-10-13 09:24:53 +00:00
* This is a convenience method; it converts database rows
* (arrays) into beans. Given a type and a set of rows this method
* will return an array of beans of the specified type loaded with
* the data fields provided by the result set from the database.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans you would like to have
* @param array $rows rows from the database result
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function convertToBeans( $type, $rows )
{
2014-10-13 09:24:53 +00:00
return $this->repository->convertToBeans( $type, $rows );
}
/**
2014-10-13 09:24:53 +00:00
* Counts the number of beans of type $type.
* This method accepts a second argument to modify the count-query.
* A third argument can be used to provide bindings for the SQL snippet.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean we are looking for
* @param string $addSQL additional SQL snippet
* @param array $bindings parameters to bind to SQL
*
* @return integer
*
2014-10-13 09:24:53 +00:00
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public function count( $type, $addSQL = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return $this->repository->count( $type, $addSQL, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Trash all beans of a given type. Wipes an entire type of bean.
*
* @param string $type type of bean you wish to delete all instances of
*
* @return boolean
*
* @throws SQL
*/
public function wipe( $type )
{
2014-10-13 09:24:53 +00:00
return $this->repository->wipe( $type );
}
/**
2014-10-13 09:24:53 +00:00
* Returns an Association Manager for use with OODB.
* A simple getter function to obtain a reference to the association manager used for
* storage and more.
*
2014-10-13 09:24:53 +00:00
* @return AssociationManager
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
public function getAssociationManager()
{
if ( !isset( $this->assocManager ) ) {
throw new RedException( 'No association manager available.' );
}
return $this->assocManager;
}
/**
* Sets the association manager instance to be used by this OODB.
* A simple setter function to set the association manager to be used for storage and
* more.
*
2014-10-13 09:24:53 +00:00
* @param AssociationManager $assoc sets the association manager to be used
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function setAssociationManager( AssociationManager $assocManager )
{
2014-10-13 09:24:53 +00:00
$this->assocManager = $assocManager;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the currently used repository instance.
* For testing purposes only.
*
2014-10-13 09:24:53 +00:00
* @return Repository
*/
2014-10-13 09:24:53 +00:00
public function getCurrentRepository()
{
2014-10-13 09:24:53 +00:00
return $this->repository;
}
/**
2014-10-13 09:24:53 +00:00
* Binds an SQL function to a column.
* This method can be used to setup a decode/encode scheme or
* perform UUID insertion. This method is especially useful for handling
* MySQL spatial columns, because they need to be processed first using
* the asText/GeomFromText functions.
*
2014-10-13 09:24:53 +00:00
* @param string $mode (read or write)
* @param string $field
* @param string $function
*/
2014-10-13 09:24:53 +00:00
public function bindFunc( $mode, $field, $function )
{
2014-10-13 09:24:53 +00:00
list( $type, $property ) = explode( '.', $field );
$mode = ($mode === 'write') ? QueryWriter::C_SQLFILTER_WRITE : QueryWriter::C_SQLFILTER_READ;
2014-10-13 09:24:53 +00:00
if ( !isset( self::$sqlFilters[$mode] ) ) self::$sqlFilters[$mode] = array();
if ( !isset( self::$sqlFilters[$mode][$type] ) ) self::$sqlFilters[$mode][$type] = array();
2014-10-13 09:24:53 +00:00
if ( is_null( $function ) ) {
unset( self::$sqlFilters[$mode][$type][$property] );
} else {
if ($mode === QueryWriter::C_SQLFILTER_WRITE) {
self::$sqlFilters[$mode][$type][$property] = $function.'(?)';
} else {
self::$sqlFilters[$mode][$type][$property] = $function."($field)";
}
}
2014-10-13 09:24:53 +00:00
AQueryWriter::setSQLFilters( self::$sqlFilters, ( !$this->isFrozen ) );
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\OODB as OODB;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\Adapter as Adapter;
/**
* @file RedBean/ToolBox.php
* @desc A RedBeanPHP-wide service locator
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* ToolBox.
* The toolbox is an integral part of RedBeanPHP providing the basic
* architectural building blocks to manager objects, helpers and additional tools
* like plugins. A toolbox contains the three core components of RedBeanPHP:
* the adapter, the query writer and the core functionality of RedBeanPHP in
* OODB.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class ToolBox
{
/**
2014-10-13 09:24:53 +00:00
* @var OODB
*/
protected $oodb;
/**
* @var QueryWriter
*/
protected $writer;
/**
* @var DBAdapter
*/
protected $adapter;
/**
* Constructor.
* The toolbox is an integral part of RedBeanPHP providing the basic
* architectural building blocks to manager objects, helpers and additional tools
* like plugins. A toolbox contains the three core components of RedBeanPHP:
* the adapter, the query writer and the core functionality of RedBeanPHP in
* OODB.
*
2014-10-13 09:24:53 +00:00
* @param OODB $oodb Object Database
* @param DBAdapter $adapter Adapter
* @param QueryWriter $writer Writer
*
2014-10-13 09:24:53 +00:00
* @return ToolBox
*/
2014-10-13 09:24:53 +00:00
public function __construct( OODB $oodb, Adapter $adapter, QueryWriter $writer )
{
2014-10-13 09:24:53 +00:00
$this->oodb = $oodb;
$this->adapter = $adapter;
$this->writer = $writer;
return $this;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the query writer in this toolbox.
* The Query Writer is responsible for building the queries for a
* specific database and executing them through the adapter.
*
2014-10-13 09:24:53 +00:00
* @return QueryWriter
*/
2014-10-13 09:24:53 +00:00
public function getWriter()
{
2014-10-13 09:24:53 +00:00
return $this->writer;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the OODB instance in this toolbox.
* OODB is responsible for creating, storing, retrieving and deleting
* single beans. Other components rely
* on OODB for their basic functionality.
*
2014-10-13 09:24:53 +00:00
* @return OODB
*/
2014-10-13 09:24:53 +00:00
public function getRedBean()
{
2014-10-13 09:24:53 +00:00
return $this->oodb;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the database adapter in this toolbox.
* The adapter is responsible for executing the query and binding the values.
* The adapter also takes care of transaction handling.
*
* @return DBAdapter
*/
2014-10-13 09:24:53 +00:00
public function getDatabaseAdapter()
{
2014-10-13 09:24:53 +00:00
return $this->adapter;
}
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\OODB as OODB;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\OODBBean as OODBBean;
2014-10-13 09:24:53 +00:00
/**
* RedBean Finder
*
* @file RedBean/Finder.php
* @desc Helper class to harmonize APIs.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class Finder
{
2014-10-13 09:24:53 +00:00
/**
* @var ToolBox
*/
protected $toolbox;
/**
* @var OODB
*/
protected $redbean;
/**
2014-10-13 09:24:53 +00:00
* Constructor.
* The Finder requires a toolbox.
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $toolbox
*/
2014-10-13 09:24:53 +00:00
public function __construct( ToolBox $toolbox )
{
2014-10-13 09:24:53 +00:00
$this->toolbox = $toolbox;
$this->redbean = $toolbox->getRedBean();
}
/**
2014-10-13 09:24:53 +00:00
* Finds a bean using a type and a where clause (SQL).
* As with most Query tools in RedBean you can provide values to
* be inserted in the SQL statement by populating the value
* array parameter; you can either use the question mark notation
* or the slot-notation (:keyname).
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
* @return array
2014-10-13 09:24:53 +00:00
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public function find( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
if ( !is_array( $bindings ) ) {
throw new RedException(
'Expected array, ' . gettype( $bindings ) . ' given.'
);
}
return $this->redbean->find( $type, array(), $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Finder::find
* The variation also exports the beans (i.e. it returns arrays).
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function findAndExport( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$arr = array();
foreach ( $this->find( $type, $sql, $bindings ) as $key => $item ) {
$arr[] = $item->export();
}
2014-10-13 09:24:53 +00:00
return $arr;
}
/**
2014-10-13 09:24:53 +00:00
* @see Finder::find
* This variation returns the first bean only.
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function findOne( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$sql = $this->toolbox->getWriter()->glueLimitOne( $sql );
$items = $this->find( $type, $sql, $bindings );
if ( empty($items) ) {
return NULL;
}
return reset( $items );
}
/**
2014-10-13 09:24:53 +00:00
* @see Finder::find
* This variation returns the last bean only.
*
2014-10-13 09:24:53 +00:00
* @param string $type the type of bean you are looking for
* @param string $sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function findLast( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$items = $this->find( $type, $sql, $bindings );
if ( empty($items) ) {
return NULL;
}
return end( $items );
}
/**
2014-10-13 09:24:53 +00:00
* @see Finder::find
* Convience method. Tries to find beans of a certain type,
* if no beans are found, it dispenses a bean of that type.
*
2014-10-13 09:24:53 +00:00
* @param string $type the type of bean you are looking for
* @param string $sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function findOrDispense( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$foundBeans = $this->find( $type, $sql, $bindings );
if ( empty( $foundBeans ) ) {
return array( $this->redbean->dispense( $type ) );
} else {
return $foundBeans;
}
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\Observable as Observable;
use RedBeanPHP\OODB as OODB;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\ToolBox as ToolBox;
/**
* Association Manager
*
* @file RedBean/AssociationManager.php
* @desc Manages simple bean associations.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class AssociationManager extends Observable
{
/**
2014-10-13 09:24:53 +00:00
* @var OODB
*/
2014-10-13 09:24:53 +00:00
protected $oodb;
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
2014-10-13 09:24:53 +00:00
protected $adapter;
/**
2014-10-13 09:24:53 +00:00
* @var QueryWriter
*/
2014-10-13 09:24:53 +00:00
protected $writer;
/**
2014-10-13 09:24:53 +00:00
* Handles\Exceptions. Suppresses exceptions caused by missing structures.
*
2014-10-13 09:24:53 +00:00
* @param\Exception $exception
*
* @return void
2014-10-13 09:24:53 +00:00
*
* @throws\Exception
*/
2014-10-13 09:24:53 +00:00
private function handleException(\Exception $exception )
{
2014-10-13 09:24:53 +00:00
if ( $this->oodb->isFrozen() || !$this->writer->sqlStateIn( $exception->getSQLState(),
array(
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN )
)
) {
throw $exception;
}
}
/**
2014-10-13 09:24:53 +00:00
* Internal method.
* Returns the many-to-many related rows of table $type for bean $bean using additional SQL in $sql and
* $bindings bindings. If $getLinks is TRUE, link rows are returned instead.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean reference bean
* @param string $type target type
* @param string $sql additional SQL snippet
* @param array $bindings bindings
*
* @return array
2014-10-13 09:24:53 +00:00
*
* @throws Security
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
private function relatedRows( $bean, $type, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$ids = array( $bean->id );
$sourceType = $bean->getMeta( 'type' );
try {
return $this->writer->queryRecordRelated( $sourceType, $type, $ids, $sql, $bindings );
} catch ( SQL $exception ) {
$this->handleException( $exception );
return array();
}
}
/**
2014-10-13 09:24:53 +00:00
* Associates a pair of beans. This method associates two beans, no matter
* what types. Accepts a base bean that contains data for the linking record.
* This method is used by associate. This method also accepts a base bean to be used
* as the template for the link record in the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean1 first bean
* @param OODBBean $bean2 second bean
* @param OODBBean $bean base bean (association record)
*
2014-10-13 09:24:53 +00:00
* @throws\Exception|SQL
*
2014-10-13 09:24:53 +00:00
* @return mixed
*/
2014-10-13 09:24:53 +00:00
protected function associateBeans( OODBBean $bean1, OODBBean $bean2, OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$property1 = $bean1->getMeta( 'type' ) . '_id';
$property2 = $bean2->getMeta( 'type' ) . '_id';
if ( $property1 == $property2 ) {
$property2 = $bean2->getMeta( 'type' ) . '2_id';
}
if ( !$this->oodb->isFrozen() ) {
//Dont mess with other tables, only add the unique constraint if:
//1. the table exists (otherwise we cant inspect it)
//2. the table only contains N-M fields: ID, N-ID, M-ID.
$unique = array( $property1, $property2 );
$type = $bean->getMeta( 'type' );
$tables = $this->writer->getTables();
if ( in_array( $type, $tables ) && !$this->oodb->isChilled( $type ) ) {
$columns = ( $this->writer->getColumns( $type ) );
if ( count( $columns ) === 3
&& isset( $columns[ 'id' ] )
&& isset( $columns[ $property1 ] )
&& isset( $columns[ $property2 ] ) ) {
$bean->setMeta( 'buildcommand.unique', array( $unique ) );
}
}
//add a build command for Single Column Index (to improve performance in case unqiue cant be used)
$indexName1 = 'index_for_' . $bean->getMeta( 'type' ) . '_' . $property1;
$indexName2 = 'index_for_' . $bean->getMeta( 'type' ) . '_' . $property2;
$bean->setMeta( 'buildcommand.indexes', array( $property1 => $indexName1, $property2 => $indexName2 ) );
}
$this->oodb->store( $bean1 );
$this->oodb->store( $bean2 );
$bean->setMeta( "cast.$property1", "id" );
$bean->setMeta( "cast.$property2", "id" );
$bean->$property1 = $bean1->id;
$bean->$property2 = $bean2->id;
$results = array();
try {
$id = $this->oodb->store( $bean );
//On creation, add constraints....
if ( !$this->oodb->isFrozen() &&
$bean->getMeta( 'buildreport.flags.created' )
) {
$bean->setMeta( 'buildreport.flags.created', 0 );
if ( !$this->oodb->isFrozen() ) {
$this->writer->addConstraintForTypes( $bean1->getMeta( 'type' ), $bean2->getMeta( 'type' ) );
}
}
$results[] = $id;
} catch ( SQL $exception ) {
if ( !$this->writer->sqlStateIn( $exception->getSQLState(),
array( QueryWriter::C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION ) )
) {
throw $exception;
}
}
return $results;
}
/**
2014-10-13 09:24:53 +00:00
* Constructor
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $tools toolbox
*/
2014-10-13 09:24:53 +00:00
public function __construct( ToolBox $tools )
{
2014-10-13 09:24:53 +00:00
$this->oodb = $tools->getRedBean();
$this->adapter = $tools->getDatabaseAdapter();
$this->writer = $tools->getWriter();
$this->toolbox = $tools;
}
/**
2014-10-13 09:24:53 +00:00
* Creates a table name based on a types array.
* Manages the get the correct name for the linking table for the
* types provided.
*
2014-10-13 09:24:53 +00:00
* @todo find a nice way to decouple this class from QueryWriter?
*
* @param array $types 2 types as strings
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public function getTable( $types )
{
2014-10-13 09:24:53 +00:00
return $this->writer->getAssocTable( $types );
}
/**
2014-10-13 09:24:53 +00:00
* Associates two beans in a many-to-many relation.
* This method will associate two beans and store the connection between the
* two in a link table. Instead of two single beans this method also accepts
* two sets of beans. Returns the ID or the IDs of the linking beans.
*
* @param OODBBean|array $beans1 one or more beans to form the association
* @param OODBBean|array $beans2 one or more beans to form the association
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function associate( $beans1, $beans2 )
{
2014-10-13 09:24:53 +00:00
if ( !is_array( $beans1 ) ) {
$beans1 = array( $beans1 );
}
if ( !is_array( $beans2 ) ) {
$beans2 = array( $beans2 );
}
$results = array();
foreach ( $beans1 as $bean1 ) {
foreach ( $beans2 as $bean2 ) {
$table = $this->getTable( array( $bean1->getMeta( 'type' ), $bean2->getMeta( 'type' ) ) );
$bean = $this->oodb->dispense( $table );
$results[] = $this->associateBeans( $bean1, $bean2, $bean );
}
}
return ( count( $results ) > 1 ) ? $results : reset( $results );
}
/**
2014-10-13 09:24:53 +00:00
* Counts the number of related beans in an N-M relation.
* This method returns the number of beans of type $type associated
* with reference bean(s) $bean. The query can be tuned using an
* SQL snippet for additional filtering.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|array $bean a bean object or an array of beans
* @param string $type type of bean you're interested in
* @param string $sql SQL snippet (optional)
* @param array $bindings bindings for your SQL string
*
2014-10-13 09:24:53 +00:00
* @return integer
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public function relatedCount( $bean, $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
if ( !( $bean instanceof OODBBean ) ) {
throw new RedException(
'Expected array or OODBBean but got:' . gettype( $bean )
);
}
if ( !$bean->id ) {
return 0;
}
$beanType = $bean->getMeta( 'type' );
try {
return $this->writer->queryRecordCountRelated( $beanType, $type, $bean->id, $sql, $bindings );
} catch ( SQL $exception ) {
$this->handleException( $exception );
return 0;
}
}
/**
2014-10-13 09:24:53 +00:00
* Breaks the association between two beans. This method unassociates two beans. If the
* method succeeds the beans will no longer form an association. In the database
* this means that the association record will be removed. This method uses the
* OODB trash() method to remove the association links, thus giving FUSE models the
* opportunity to hook-in additional business logic. If the $fast parameter is
* set to boolean TRUE this method will remove the beans without their consent,
* bypassing FUSE. This can be used to improve performance.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean1 first bean
* @param OODBBean $bean2 second bean
* @param boolean $fast If TRUE, removes the entries by query without FUSE
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function unassociate( $beans1, $beans2, $fast = NULL )
{
2014-10-13 09:24:53 +00:00
$beans1 = ( !is_array( $beans1 ) ) ? array( $beans1 ) : $beans1;
$beans2 = ( !is_array( $beans2 ) ) ? array( $beans2 ) : $beans2;
foreach ( $beans1 as $bean1 ) {
foreach ( $beans2 as $bean2 ) {
try {
$this->oodb->store( $bean1 );
$this->oodb->store( $bean2 );
$type1 = $bean1->getMeta( 'type' );
$type2 = $bean2->getMeta( 'type' );
$row = $this->writer->queryRecordLink( $type1, $type2, $bean1->id, $bean2->id );
$linkType = $this->getTable( array( $type1, $type2 ) );
if ( $fast ) {
$this->writer->deleteRecord( $linkType, array( 'id' => $row['id'] ) );
return;
}
$beans = $this->oodb->convertToBeans( $linkType, array( $row ) );
if ( count( $beans ) > 0 ) {
$bean = reset( $beans );
$this->oodb->trash( $bean );
}
} catch ( SQL $exception ) {
$this->handleException( $exception );
}
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Removes all relations for a bean. This method breaks every connection between
* a certain bean $bean and every other bean of type $type. Warning: this method
* is really fast because it uses a direct SQL query however it does not inform the
* models about this. If you want to notify FUSE models about deletion use a foreach-loop
* with unassociate() instead. (that might be slower though)
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean reference bean
* @param string $type type of beans that need to be unassociated
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function clearRelations( OODBBean $bean, $type )
{
2014-10-13 09:24:53 +00:00
$this->oodb->store( $bean );
try {
$this->writer->deleteRelations( $bean->getMeta( 'type' ), $type, $bean->id );
} catch ( SQL $exception ) {
$this->handleException( $exception );
}
}
/**
2014-10-13 09:24:53 +00:00
* Returns all the beans associated with $bean.
* This method will return an array containing all the beans that have
* been associated once with the associate() function and are still
* associated with the bean specified. The type parameter indicates the
* type of beans you are looking for. You can also pass some extra SQL and
* values for that SQL to filter your results after fetching the
* related beans.
*
2014-10-13 09:24:53 +00:00
* Don't try to make use of subqueries, a subquery using IN() seems to
* be slower than two queries!
*
* Since 3.2, you can now also pass an array of beans instead just one
* bean as the first parameter.
*
* @param OODBBean|array $bean the bean you have
* @param string $type the type of beans you want
* @param string $sql SQL snippet for extra filtering
* @param array $bindings values to be inserted in SQL slots
* @param boolean $glue whether the SQL should be prefixed with WHERE
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function related( $bean, $type, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$sql = $this->writer->glueSQLCondition( $sql );
$rows = $this->relatedRows( $bean, $type, $sql, $bindings );
$links = array();
foreach ( $rows as $key => $row ) {
if ( !isset( $links[$row['id']] ) ) {
$links[$row['id']] = array();
}
$links[$row['id']][] = $row['linked_by'];
unset( $rows[$key]['linked_by'] );
}
$beans = $this->oodb->convertToBeans( $type, $rows );
foreach ( $beans as $bean ) {
$bean->setMeta( 'sys.belongs-to', $links[$bean->id] );
}
return $beans;
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\OODBBean as OODBBean;
/**
* Bean Helper Interface
*
* @file RedBean/IBeanHelper.php
* @desc Interface for Bean Helper.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* Interface for Bean Helper.
* A little bolt that glues the whole machinery together.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface BeanHelper
{
/**
2014-10-13 09:24:53 +00:00
* Returns a toolbox to empower the bean.
* This allows beans to perform OODB operations by themselves,
* as such the bean is a proxy for OODB. This allows beans to implement
* their magic getters and setters and return lists.
*
2014-10-13 09:24:53 +00:00
* @return ToolBox $toolbox toolbox
*/
2014-10-13 09:24:53 +00:00
public function getToolbox();
/**
2014-10-13 09:24:53 +00:00
* Does approximately the same as getToolbox but also extracts the
* toolbox for you.
* This method returns a list with all toolbox items in Toolbox Constructor order:
* OODB, adapter, writer and finally the toolbox itself!.
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function getExtractedToolbox();
/**
2014-10-13 09:24:53 +00:00
* Given a certain bean this method will
* return the corresponding model.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public function getModelForBean( OODBBean $bean );
}
}
namespace RedBeanPHP\BeanHelper {
use RedBeanPHP\BeanHelper as BeanHelper;
use RedBeanPHP\Facade as Facade;
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\SimpleModelHelper as SimpleModelHelper;
/**
* Bean Helper.
* The Bean helper helps beans to access access the toolbox and
* FUSE models. This Bean Helper makes use of the facade to obtain a
* reference to the toolbox.
*
* @file RedBean/BeanHelperFacade.php
* @desc Finds the toolbox for the bean.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* (c) copyright G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class SimpleFacadeBeanHelper implements BeanHelper
{
/**
2014-10-13 09:24:53 +00:00
* Factory function to create instance of Simple Model, if any.
*
2014-10-13 09:24:53 +00:00
* @var closure
*/
2014-10-13 09:24:53 +00:00
private static $factory = null;
/**
2014-10-13 09:24:53 +00:00
* @see BeanHelper::getToolbox
*/
2014-10-13 09:24:53 +00:00
public function getToolbox()
{
2014-10-13 09:24:53 +00:00
return Facade::getToolBox();
}
/**
2014-10-13 09:24:53 +00:00
* @see BeanHelper::getModelForBean
*/
2014-10-13 09:24:53 +00:00
public function getModelForBean( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$model = $bean->getMeta( 'type' );
$prefix = defined( 'REDBEAN_MODEL_PREFIX' ) ? REDBEAN_MODEL_PREFIX : '\\Model_';
2014-10-13 09:24:53 +00:00
if ( strpos( $model, '_' ) !== FALSE ) {
$modelParts = explode( '_', $model );
$modelName = '';
foreach( $modelParts as $part ) {
$modelName .= ucfirst( $part );
}
$modelName = $prefix . $modelName;
if ( !class_exists( $modelName ) ) {
//second try
$modelName = $prefix . ucfirst( $model );
if ( !class_exists( $modelName ) ) {
return NULL;
}
}
} else {
$modelName = $prefix . ucfirst( $model );
if ( !class_exists( $modelName ) ) {
return NULL;
}
}
$obj = self::factory( $modelName );
$obj->loadBean( $bean );
return $obj;
}
/**
2014-10-13 09:24:53 +00:00
* @see BeanHelper::getExtractedToolbox
*/
2014-10-13 09:24:53 +00:00
public function getExtractedToolbox()
{
2014-10-13 09:24:53 +00:00
return Facade::getExtractedToolbox();
}
/**
2014-10-13 09:24:53 +00:00
* Factory method using a customizable factory function to create
* the instance of the Simple Model.
*
2014-10-13 09:24:53 +00:00
* @param string $modelClassName name of the class
*
2014-10-13 09:24:53 +00:00
* @return SimpleModel
*/
2014-10-13 09:24:53 +00:00
public static function factory( $modelClassName )
{
2014-10-13 09:24:53 +00:00
$factory = self::$factory;
return ( $factory ) ? $factory( $modelClassName ) : new $modelClassName();
}
/**
2014-10-13 09:24:53 +00:00
* Sets the factory function to create the model when using FUSE
* to connect a bean to a model.
*
2014-10-13 09:24:53 +00:00
* @param closure $factory
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function setFactoryFunction( $factory )
{
2014-10-13 09:24:53 +00:00
self::$factory = $factory;
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\OODBBean as OODBBean;
/**
* SimpleModel
* Base Model For All RedBeanPHP Models using FUSE.
*
* @file RedBean/SimpleModel.php
* @desc Part of FUSE
* @author Gabor de Mooij and the RedBeanPHP Team
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class SimpleModel
{
/**
2014-10-13 09:24:53 +00:00
* @var OODBBean
*/
2014-10-13 09:24:53 +00:00
protected $bean;
/**
2014-10-13 09:24:53 +00:00
* Used by FUSE: the ModelHelper class to connect a bean to a model.
* This method loads a bean in the model.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function loadBean( OODBBean $bean )
{
2014-10-13 09:24:53 +00:00
$this->bean = $bean;
}
/**
2014-10-13 09:24:53 +00:00
* Magic Getter to make the bean properties available from
* the $this-scope.
*
2014-10-13 09:24:53 +00:00
* @note this method returns a value, not a reference!
* To obtain a reference unbox the bean first!
*
2014-10-13 09:24:53 +00:00
* @param string $prop property
*
* @return mixed
*/
2014-10-13 09:24:53 +00:00
public function __get( $prop )
{
2014-10-13 09:24:53 +00:00
return $this->bean->$prop;
}
/**
2014-10-13 09:24:53 +00:00
* Magic Setter.
* Sets the value directly as a bean property.
*
2014-10-13 09:24:53 +00:00
* @param string $prop property
* @param mixed $value value
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function __set( $prop, $value )
{
2014-10-13 09:24:53 +00:00
$this->bean->$prop = $value;
}
/**
2014-10-13 09:24:53 +00:00
* Isset implementation.
* Implements the isset function for array-like access.
*
2014-10-13 09:24:53 +00:00
* @param string $key key to check
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function __isset( $key )
{
2014-10-13 09:24:53 +00:00
return isset( $this->bean->$key );
}
/**
2014-10-13 09:24:53 +00:00
* Box the bean using the current model.
* This method wraps the current bean in this model.
* This method can be reached using FUSE through a simple
* OODBBean. The method returns a RedBeanPHP Simple Model.
* This is useful if you would like to rely on PHP type hinting.
* You can box your beans before passing them to functions or methods
* with typed parameters.
*
2014-10-13 09:24:53 +00:00
* @return SimpleModel
*/
2014-10-13 09:24:53 +00:00
public function box()
{
2014-10-13 09:24:53 +00:00
return $this;
}
/**
2014-10-13 09:24:53 +00:00
* Unbox the bean from the model.
* This method returns the bean inside the model.
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function unbox()
{
2014-10-13 09:24:53 +00:00
return $this->bean;
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\Observer as Observer;
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\Observable as Observable;
/**
* RedBean Model Helper
*
* @file RedBean/ModelHelper.php
* @desc Connects beans to models, in essence
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* This is the core of so-called FUSE.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class SimpleModelHelper implements Observer
{
/**
2014-10-13 09:24:53 +00:00
* @see Observer::onEvent
*/
2014-10-13 09:24:53 +00:00
public function onEvent( $eventName, $bean )
{
2014-10-13 09:24:53 +00:00
$bean->$eventName();
}
/**
2014-10-13 09:24:53 +00:00
* Attaches the FUSE event listeners. Now the Model Helper will listen for
* CRUD events. If a CRUD event occurs it will send a signal to the model
* that belongs to the CRUD bean and this model will take over control from
* there.
*
2014-10-13 09:24:53 +00:00
* @param Observable $observable
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function attachEventListeners( Observable $observable )
{
2014-10-13 09:24:53 +00:00
foreach ( array( 'update', 'open', 'delete', 'after_delete', 'after_update', 'dispense' ) as $e ) {
$observable->addEventListener( $e, $this );
}
}
}
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\AssociationManager as AssociationManager;
use RedBeanPHP\OODBBean as OODBBean;
2014-10-13 09:24:53 +00:00
/**
* RedBean Tag Manager.
* The tag manager offers an easy way to quickly implement basic tagging
* functionality.
*
* @file RedBean/TagManager.php
* @desc RedBean Tag Manager
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* Provides methods to tag beans and perform tag-based searches in the
* bean database.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class TagManager
{
2014-10-13 09:24:53 +00:00
/**
* @var ToolBox
*/
protected $toolbox;
2014-10-13 09:24:53 +00:00
/**
* @var AssociationManager
*/
protected $associationManager;
2014-10-13 09:24:53 +00:00
/**
* @var OODBBean
*/
protected $redbean;
/**
2014-10-13 09:24:53 +00:00
* Checks if the argument is a comma separated string, in this case
* it will split the string into words and return an array instead.
* In case of an array the argument will be returned 'as is'.
*
2014-10-13 09:24:53 +00:00
* @param array|string $tagList list of tags
*
* @return array
*/
2014-10-13 09:24:53 +00:00
private function extractTagsIfNeeded( $tagList )
{
2014-10-13 09:24:53 +00:00
if ( $tagList !== FALSE && !is_array( $tagList ) ) {
$tags = explode( ',', (string) $tagList );
} else {
$tags = $tagList;
}
2014-10-13 09:24:53 +00:00
return $tags;
}
/**
2014-10-13 09:24:53 +00:00
* Constructor.
* The tag manager offers an easy way to quickly implement basic tagging
* functionality.
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $toolbox
*/
2014-10-13 09:24:53 +00:00
public function __construct( ToolBox $toolbox )
{
2014-10-13 09:24:53 +00:00
$this->toolbox = $toolbox;
$this->redbean = $toolbox->getRedBean();
2014-10-13 09:24:53 +00:00
$this->associationManager = $this->redbean->getAssociationManager();
}
/**
2014-10-13 09:24:53 +00:00
* Finds a tag bean by it's title.
* Internal method.
*
2014-10-13 09:24:53 +00:00
* @param string $title title
*
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
protected function findTagByTitle( $title )
{
2014-10-13 09:24:53 +00:00
$beans = $this->redbean->find( 'tag', array( 'title' => array( $title ) ) );
2014-10-13 09:24:53 +00:00
if ( $beans ) {
$bean = reset( $beans );
2014-10-13 09:24:53 +00:00
return $bean;
}
return NULL;
}
/**
2014-10-13 09:24:53 +00:00
* Tests whether a bean has been associated with one ore more
* of the listed tags. If the third parameter is TRUE this method
* will return TRUE only if all tags that have been specified are indeed
* associated with the given bean, otherwise FALSE.
* If the third parameter is FALSE this
* method will return TRUE if one of the tags matches, FALSE if none
* match.
*
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to check for tags
* @param array|string $tags list of tags
* @param boolean $all whether they must all match or just some
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public function hasTag( $bean, $tags, $all = FALSE )
{
2014-10-13 09:24:53 +00:00
$foundtags = $this->tag( $bean );
$tags = $this->extractTagsIfNeeded( $tags );
$same = array_intersect( $tags, $foundtags );
if ( $all ) {
return ( implode( ',', $same ) === implode( ',', $tags ) );
}
return (bool) ( count( $same ) > 0 );
}
/**
2014-10-13 09:24:53 +00:00
* Removes all sepcified tags from the bean. The tags specified in
* the second parameter will no longer be associated with the bean.
*
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean tagged bean
* @param array|string $tagList list of tags (names)
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public function untag( $bean, $tagList )
{
2014-10-13 09:24:53 +00:00
$tags = $this->extractTagsIfNeeded( $tagList );
foreach ( $tags as $tag ) {
if ( $t = $this->findTagByTitle( $tag ) ) {
$this->associationManager->unassociate( $bean, $t );
}
}
}
/**
2014-10-13 09:24:53 +00:00
* Tags a bean or returns tags associated with a bean.
* If $tagList is NULL or omitted this method will return a
* comma separated list of tags associated with the bean provided.
* If $tagList is a comma separated list (string) of tags all tags will
* be associated with the bean.
* You may also pass an array instead of a string.
*
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to be tagged
* @param array|string $tagList a list of tags
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public function tag( OODBBean $bean, $tagList = NULL )
{
2014-10-13 09:24:53 +00:00
if ( is_null( $tagList ) ) {
$tags = $bean->sharedTag;
$foundTags = array();
foreach ( $tags as $tag ) {
$foundTags[] = $tag->title;
}
return $foundTags;
}
2014-10-13 09:24:53 +00:00
$this->associationManager->clearRelations( $bean, 'tag' );
$this->addTags( $bean, $tagList );
return $tagList;
}
/**
2014-10-13 09:24:53 +00:00
* Adds tags to a bean.
* If $tagList is a comma separated list of tags all tags will
* be associated with the bean.
* You may also pass an array instead of a string.
*
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to add tags to
* @param array|string $tagList list of tags to add to bean
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public function addTags( OODBBean $bean, $tagList )
{
2014-10-13 09:24:53 +00:00
$tags = $this->extractTagsIfNeeded( $tagList );
if ( $tagList === FALSE ) {
return;
}
foreach ( $tags as $tag ) {
if ( !$t = $this->findTagByTitle( $tag ) ) {
$t = $this->redbean->dispense( 'tag' );
$t->title = $tag;
$this->redbean->store( $t );
}
$this->associationManager->associate( $bean, $t );
}
}
/**
2014-10-13 09:24:53 +00:00
* Returns all beans that have been tagged with one or more
* of the specified tags.
*
2014-10-13 09:24:53 +00:00
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
* @param string $beanType type of bean you are looking for
* @param array|string $tagList list of tags to match
* @param string $sql additional SQL (use only for pagination)
* @param array $bindings bindings
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function tagged( $beanType, $tagList, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$tags = $this->extractTagsIfNeeded( $tagList );
$records = $this->toolbox->getWriter()->queryTagged( $beanType, $tags, FALSE, $sql, $bindings );
2014-10-13 09:24:53 +00:00
return $this->redbean->convertToBeans( $beanType, $records );
}
/**
2014-10-13 09:24:53 +00:00
* Returns all beans that have been tagged with ALL of the tags given.
*
2014-10-13 09:24:53 +00:00
* Tag list can be either an array with tag names or a comma separated list
* of tag names.
*
2014-10-13 09:24:53 +00:00
* @param string $beanType type of bean you are looking for
* @param array|string $tagList list of tags to match
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function taggedAll( $beanType, $tagList, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
$tags = $this->extractTagsIfNeeded( $tagList );
$records = $this->toolbox->getWriter()->queryTagged( $beanType, $tags, TRUE, $sql, $bindings );
return $this->redbean->convertToBeans( $beanType, $records );
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\OODBBean as OODBBean;
/**
* Label Maker
*
* @file RedBean/LabelMaker.php
* @desc Makes so-called label beans
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class LabelMaker
{
/**
2014-10-13 09:24:53 +00:00
* @var ToolBox
*/
protected $toolbox;
/**
* Constructor.
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $toolbox
*/
2014-10-13 09:24:53 +00:00
public function __construct( ToolBox $toolbox )
{
2014-10-13 09:24:53 +00:00
$this->toolbox = $toolbox;
}
/**
* A label is a bean with only an id, type and name property.
* This function will dispense beans for all entries in the array. The
* values of the array will be assigned to the name property of each
* individual bean.
*
* @param string $type type of beans you would like to have
* @param array $labels list of labels, names for each bean
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function dispenseLabels( $type, $labels )
{
2014-10-13 09:24:53 +00:00
$labelBeans = array();
foreach ( $labels as $label ) {
$labelBean = $this->toolbox->getRedBean()->dispense( $type );
$labelBean->name = $label;
$labelBeans[] = $labelBean;
}
2014-10-13 09:24:53 +00:00
return $labelBeans;
}
/**
* Gathers labels from beans. This function loops through the beans,
* collects the values of the name properties of each individual bean
* and stores the names in a new array. The array then gets sorted using the
* default sort function of PHP (sort).
*
* @param array $beans list of beans to loop
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function gatherLabels( $beans )
{
2014-10-13 09:24:53 +00:00
$labels = array();
foreach ( $beans as $bean ) {
$labels[] = $bean->name;
}
2014-10-13 09:24:53 +00:00
sort( $labels );
return $labels;
}
/**
2014-10-13 09:24:53 +00:00
* Returns a label or an array of labels for use as ENUMs.
*
* @param string $enum ENUM specification for label
*
* @return array|OODBBean
*/
2014-10-13 09:24:53 +00:00
public function enum( $enum )
{
2014-10-13 09:24:53 +00:00
$oodb = $this->toolbox->getRedBean();
if ( strpos( $enum, ':' ) === FALSE ) {
$type = $enum;
$value = FALSE;
} else {
list( $type, $value ) = explode( ':', $enum );
$value = preg_replace( '/\W+/', '_', strtoupper( trim( $value ) ) );
}
2014-10-13 09:24:53 +00:00
$values = $oodb->find( $type );
if ( $value === FALSE ) {
return $values;
}
foreach( $values as $enumItem ) {
if ( $enumItem->name === $value ) return $enumItem;
}
$newEnumItems = $this->dispenseLabels( $type, array( $value ) );
$newEnumItem = reset( $newEnumItems );
$oodb->store( $newEnumItem );
return $newEnumItem;
}
2014-10-13 09:24:53 +00:00
}
}
namespace RedBeanPHP {
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\OODB as OODB;
use RedBeanPHP\QueryWriter as QueryWriter;
use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
use RedBeanPHP\AssociationManager as AssociationManager;
use RedBeanPHP\TagManager as TagManager;
use RedBeanPHP\DuplicationManager as DuplicationManager;
use RedBeanPHP\LabelMaker as LabelMaker;
use RedBeanPHP\Finder as Finder;
use RedBeanPHP\RedException\SQL as SQL;
use RedBeanPHP\RedException\Security as Security;
use RedBeanPHP\Logger as Logger;
use RedBeanPHP\Logger\RDefault as RDefault;
use RedBeanPHP\Logger\RDefault\Debug as Debug;
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\SimpleModel as SimpleModel;
use RedBeanPHP\SimpleModelHelper as SimpleModelHelper;
use RedBeanPHP\Adapter as Adapter;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
use RedBeanPHP\RedException as RedException;
use RedBeanPHP\BeanHelper\SimpleFacadeBeanHelper as SimpleFacadeBeanHelper;
use RedBeanPHP\Driver\RPDO as RPDO;
2014-10-13 09:24:53 +00:00
/**
* RedBean Facade
*
* Version Information
* RedBean Version @version 4.1
*
* @file RedBean/Facade.php
* @desc Convenience class for RedBeanPHP.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* This class hides the object landscape of
* RedBeanPHP behind a single letter class providing
* almost all functionality with simple static calls.
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class Facade
{
/**
2014-10-13 09:24:53 +00:00
* RedBeanPHP version constant.
*/
2014-10-13 09:24:53 +00:00
const C_REDBEANPHP_VERSION = '4.1';
2014-10-13 09:24:53 +00:00
/**
* @var array
*/
private static $toolboxes = array();
/**
2014-10-13 09:24:53 +00:00
* @var ToolBox
*/
2014-10-13 09:24:53 +00:00
private static $toolbox;
2014-10-13 09:24:53 +00:00
/**
* @var OODB
*/
private static $redbean;
/**
2014-10-13 09:24:53 +00:00
* @var QueryWriter
*/
2014-10-13 09:24:53 +00:00
private static $writer;
/**
2014-10-13 09:24:53 +00:00
* @var DBAdapter
*/
2014-10-13 09:24:53 +00:00
private static $adapter;
/**
2014-10-13 09:24:53 +00:00
* @var AssociationManager
*/
private static $associationManager;
/**
* @var TagManager
*/
private static $tagManager;
/**
* @var DuplicationManager
*/
private static $duplicationManager;
/**
* @var LabelMaker
*/
private static $labelMaker;
/**
* @var Finder
*/
private static $finder;
/**
* @var string
*/
private static $currentDB = '';
/**
* @var array
*/
private static $plugins = array();
/**
* @var string
*/
2014-10-13 09:24:53 +00:00
private static $exportCaseStyle = 'default';
/**
2014-10-13 09:24:53 +00:00
* Internal Query function, executes the desired query. Used by
* all facade query functions. This keeps things DRY.
*
* @throws SQL
*
2014-10-13 09:24:53 +00:00
* @param string $method desired query method (i.e. 'cell', 'col', 'exec' etc..)
* @param string $sql the sql you want to execute
* @param array $bindings array of values to be bound to query statement
*
* @return array
*/
2014-10-13 09:24:53 +00:00
private static function query( $method, $sql, $bindings )
{
2014-10-13 09:24:53 +00:00
if ( !self::$redbean->isFrozen() ) {
try {
$rs = Facade::$adapter->$method( $sql, $bindings );
} catch ( SQL $exception ) {
if ( self::$writer->sqlStateIn( $exception->getSQLState(),
array(
QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN,
QueryWriter::C_SQLSTATE_NO_SUCH_TABLE )
)
) {
return ( $method === 'getCell' ) ? NULL : array();
} else {
throw $exception;
}
}
return $rs;
} else {
return Facade::$adapter->$method( $sql, $bindings );
}
}
/**
2014-10-13 09:24:53 +00:00
* Returns the RedBeanPHP version string.
* The RedBeanPHP version string always has the same format "X.Y"
* where X is the major version number and Y is the minor version number.
* Point releases are not mentioned in the version string.
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function getVersion()
{
2014-10-13 09:24:53 +00:00
return self::C_REDBEANPHP_VERSION;
}
/**
2014-10-13 09:24:53 +00:00
* Tests the connection.
* Returns TRUE if connection has been established and
* FALSE otherwise.
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public static function testConnection()
{
2014-10-13 09:24:53 +00:00
if ( !isset( self::$adapter ) ) return FALSE;
$database = self::$adapter->getDatabase();
try {
@$database->connect();
} catch ( \Exception $e ) {}
return $database->isConnected();
}
/**
2014-10-13 09:24:53 +00:00
* Kickstarts redbean for you. This method should be called before you start using
* RedBean. The Setup() method can be called without any arguments, in this case it will
* try to create a SQLite database in /tmp called red.db (this only works on UNIX-like systems).
*
* @param string $dsn Database connection string
* @param string $username Username for database
* @param string $password Password for database
* @param boolean $frozen TRUE if you want to setup in frozen mode
*
2014-10-13 09:24:53 +00:00
* @return ToolBox
*/
2014-10-13 09:24:53 +00:00
public static function setup( $dsn = NULL, $username = NULL, $password = NULL, $frozen = FALSE )
{
2014-10-13 09:24:53 +00:00
if ( is_null( $dsn ) ) {
$dsn = 'sqlite:/' . sys_get_temp_dir() . '/red.db';
}
self::addDatabase( 'default', $dsn, $username, $password, $frozen );
self::selectDatabase( 'default' );
return self::$toolbox;
}
/**
2014-10-13 09:24:53 +00:00
* Toggles Narrow Field Mode.
* See documentation in QueryWriter.
*
2014-10-13 09:24:53 +00:00
* @param boolean $mode TRUE = Narrow Field Mode
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function setNarrowFieldMode( $mode )
{
2014-10-13 09:24:53 +00:00
AQueryWriter::setNarrowFieldMode( $mode );
}
/**
2014-10-13 09:24:53 +00:00
* Starts a transaction within a closure (or other valid callback).
* If an\Exception is thrown inside, the operation is automatically rolled back.
* If no\Exception happens, it commits automatically.
* It also supports (simulated) nested transactions (that is useful when
* you have many methods that needs transactions but are unaware of
* each other).
* ex:
* $from = 1;
* $to = 2;
* $amount = 300;
*
2014-10-13 09:24:53 +00:00
* R::transaction(function() use($from, $to, $amount)
* {
* $accountFrom = R::load('account', $from);
* $accountTo = R::load('account', $to);
*
2014-10-13 09:24:53 +00:00
* $accountFrom->money -= $amount;
* $accountTo->money += $amount;
*
2014-10-13 09:24:53 +00:00
* R::store($accountFrom);
* R::store($accountTo);
* });
*
2014-10-13 09:24:53 +00:00
* @param callable $callback Closure (or other callable) with the transaction logic
*
2014-10-13 09:24:53 +00:00
* @throws Security
*
2014-10-13 09:24:53 +00:00
* @return mixed
*
*/
2014-10-13 09:24:53 +00:00
public static function transaction( $callback )
{
2014-10-13 09:24:53 +00:00
if ( !is_callable( $callback ) ) {
throw new RedException( 'R::transaction needs a valid callback.' );
}
2014-10-13 09:24:53 +00:00
static $depth = 0;
$result = null;
try {
if ( $depth == 0 ) {
self::begin();
}
$depth++;
$result = call_user_func( $callback ); //maintain 5.2 compatibility
$depth--;
if ( $depth == 0 ) {
self::commit();
}
} catch (\Exception $exception ) {
$depth--;
if ( $depth == 0 ) {
self::rollback();
}
throw $exception;
}
return $result;
}
/**
2014-10-13 09:24:53 +00:00
* Adds a database to the facade, afterwards you can select the database using
* selectDatabase($key), where $key is the name you assigned to this database.
*
* Usage:
*
2014-10-13 09:24:53 +00:00
* R::addDatabase( 'database-1', 'sqlite:/tmp/db1.txt' );
* R::selectDatabase( 'database-1' ); //to select database again
*
2014-10-13 09:24:53 +00:00
* This method allows you to dynamically add (and select) new databases
* to the facade. Adding a database with the same key will cause an exception.
*
2014-10-13 09:24:53 +00:00
* @param string $key ID for the database
* @param string $dsn DSN for the database
* @param string $user User for connection
* @param NULL|string $pass Password for connection
* @param bool $frozen Whether this database is frozen or not
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function addDatabase( $key, $dsn, $user = NULL, $pass = NULL, $frozen = FALSE )
{
2014-10-13 09:24:53 +00:00
if ( isset( self::$toolboxes[$key] ) ) {
throw new RedException( 'A database has already be specified for this key.' );
}
2014-10-13 09:24:53 +00:00
if ( is_object($dsn) ) {
$db = new RPDO( $dsn );
$dbType = $db->getDatabaseType();
} else {
$db = new RPDO( $dsn, $user, $pass, TRUE );
$dbType = substr( $dsn, 0, strpos( $dsn, ':' ) );
}
$adapter = new DBAdapter( $db );
$writers = array('pgsql' => 'PostgreSQL',
'sqlite' => 'SQLiteT',
'cubrid' => 'CUBRID',
'mysql' => 'MySQL');
$wkey = trim( strtolower( $dbType ) );
if ( !isset( $writers[$wkey] ) ) trigger_error( 'Unsupported DSN: '.$wkey );
$writerClass = '\\RedBeanPHP\\QueryWriter\\'.$writers[$wkey];
$writer = new $writerClass( $adapter );
$redbean = new OODB( $writer );
$redbean->freeze( ( $frozen === TRUE ) );
self::$toolboxes[$key] = new ToolBox( $redbean, $adapter, $writer );
}
/**
2014-10-13 09:24:53 +00:00
* Selects a different database for the Facade to work with.
* If you use the R::setup() you don't need this method. This method is meant
* for multiple database setups. This method selects the database identified by the
* database ID ($key). Use addDatabase() to add a new database, which in turn
* can be selected using selectDatabase(). If you use R::setup(), the resulting
* database will be stored under key 'default', to switch (back) to this database
* use R::selectDatabase( 'default' ). This method returns TRUE if the database has been
* switched and FALSE otherwise (for instance if you already using the specified database).
*
2014-10-13 09:24:53 +00:00
* @param string $key Key of the database to select
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public static function selectDatabase( $key )
{
2014-10-13 09:24:53 +00:00
if ( self::$currentDB === $key ) {
return FALSE;
}
2014-10-13 09:24:53 +00:00
self::configureFacadeWithToolbox( self::$toolboxes[$key] );
self::$currentDB = $key;
2014-10-13 09:24:53 +00:00
return TRUE;
}
/**
2014-10-13 09:24:53 +00:00
* Toggles DEBUG mode.
* In Debug mode all SQL that happens under the hood will
* be printed to the screen or logged by provided logger.
* If no database connection has been configured using R::setup() or
* R::selectDatabase() this method will throw an exception.
* Returns the attached logger instance.
*
* @param boolean $tf
* @param integer $mode (0 = to STDOUT, 1 = to ARRAY)
*
* @throws Security
*
* @return Logger\RDefault
*/
2014-10-13 09:24:53 +00:00
public static function debug( $tf = TRUE, $mode = 0 )
{
if ($mode > 1) {
$mode -= 2;
$logger = new Debug;
} else {
$logger = new RDefault;
}
2014-10-13 09:24:53 +00:00
if ( !isset( self::$adapter ) ) {
throw new RedException( 'Use R::setup() first.' );
}
$logger->setMode($mode);
self::$adapter->getDatabase()->setDebugMode( $tf, $logger );
2014-10-13 09:24:53 +00:00
return $logger;
}
/**
2014-10-13 09:24:53 +00:00
* Inspects the database schema. If you pass the type of a bean this
* method will return the fields of its table in the database.
* The keys of this array will be the field names and the values will be
* the column types used to store their values.
* If no type is passed, this method returns a list of all tables in the database.
*
* @param string $type Type of bean (i.e. table) you want to inspect
*
* @return array
*/
public static function inspect( $type = NULL )
{
2014-10-13 09:24:53 +00:00
return ($type === NULL) ? self::$writer->getTables() : self::$writer->getColumns( $type );
}
/**
2014-10-13 09:24:53 +00:00
* Stores a bean in the database. This method takes a
* OODBBean Bean Object $bean and stores it
* in the database. If the database schema is not compatible
* with this bean and RedBean runs in fluid mode the schema
* will be altered to store the bean correctly.
* If the database schema is not compatible with this bean and
* RedBean runs in frozen mode it will throw an exception.
* This function returns the primary key ID of the inserted
* bean.
*
2014-10-13 09:24:53 +00:00
* The return value is an integer if possible. If it is not possible to
* represent the value as an integer a string will be returned.
*
* @param OODBBean|SimpleModel $bean bean to store
*
* @return integer|string
*
2014-10-13 09:24:53 +00:00
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public static function store( $bean )
{
2014-10-13 09:24:53 +00:00
return self::$redbean->store( $bean );
}
/**
2014-10-13 09:24:53 +00:00
* Toggles fluid or frozen mode. In fluid mode the database
* structure is adjusted to accomodate your objects. In frozen mode
* this is not the case.
*
2014-10-13 09:24:53 +00:00
* You can also pass an array containing a selection of frozen types.
* Let's call this chilly mode, it's just like fluid mode except that
* certain types (i.e. tables) aren't touched.
*
2014-10-13 09:24:53 +00:00
* @param boolean|array $trueFalse
*/
2014-10-13 09:24:53 +00:00
public static function freeze( $tf = TRUE )
{
2014-10-13 09:24:53 +00:00
self::$redbean->freeze( $tf );
}
/**
2014-10-13 09:24:53 +00:00
* Loads multiple types of beans with the same ID.
* This might look like a strange method, however it can be useful
* for loading a one-to-one relation.
*
* Usage:
* list($author, $bio) = R::load('author, bio', $id);
*
2014-10-13 09:24:53 +00:00
* @param string|array $types
* @param mixed $id
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public static function loadMulti( $types, $id )
{
2014-10-13 09:24:53 +00:00
if ( is_string( $types ) ) {
$types = explode( ',', $types );
}
if ( !is_array( $types ) ) {
return array();
}
2014-10-13 09:24:53 +00:00
foreach ( $types as $k => $typeItem ) {
$types[$k] = self::$redbean->load( $typeItem, $id );
}
2014-10-13 09:24:53 +00:00
return $types;
}
/**
2014-10-13 09:24:53 +00:00
* Loads a bean from the object database.
* It searches for a OODBBean Bean Object in the
* database. It does not matter how this bean has been stored.
* RedBean uses the primary key ID $id and the string $type
* to find the bean. The $type specifies what kind of bean you
* are looking for; this is the same type as used with the
* dispense() function. If RedBean finds the bean it will return
* the OODB Bean object; if it cannot find the bean
* RedBean will return a new bean of type $type and with
* primary key ID 0. In the latter case it acts basically the
* same as dispense().
*
2014-10-13 09:24:53 +00:00
* Important note:
* If the bean cannot be found in the database a new bean of
* the specified type will be generated and returned.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you want to load
* @param integer $id ID of the bean you want to load
*
* @throws SQL
*
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public static function load( $type, $id )
{
2014-10-13 09:24:53 +00:00
return self::$redbean->load( $type, $id );
}
/**
2014-10-13 09:24:53 +00:00
* Removes a bean from the database.
* This function will remove the specified OODBBean
* Bean Object from the database.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|SimpleModel $bean bean you want to remove from database
*
2014-10-13 09:24:53 +00:00
* @return void
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public static function trash( $bean )
{
2014-10-13 09:24:53 +00:00
self::$redbean->trash( $bean );
}
/**
2014-10-13 09:24:53 +00:00
* Dispenses a new RedBean OODB Bean for use with
* the rest of the methods.
*
2014-10-13 09:24:53 +00:00
* @param string|array $typeOrBeanArray type or bean array to import
* @param integer $number number of beans to dispense
* @param boolean $alwaysReturnArray if TRUE always returns the result as an array
*
2014-10-13 09:24:53 +00:00
* @return array|OODBBean
*
* @throws Security
*/
2014-10-13 09:24:53 +00:00
public static function dispense( $typeOrBeanArray, $num = 1, $alwaysReturnArray = FALSE )
{
2014-10-13 09:24:53 +00:00
if ( is_array($typeOrBeanArray) ) {
if ( !isset( $typeOrBeanArray['_type'] ) ) throw new RedException('Missing _type field.');
$import = $typeOrBeanArray;
$type = $import['_type'];
unset( $import['_type'] );
} else {
$type = $typeOrBeanArray;
}
2014-10-13 09:24:53 +00:00
if ( !preg_match( '/^[a-z0-9]+$/', $type ) ) {
throw new RedException( 'Invalid type: ' . $type );
}
2014-10-13 09:24:53 +00:00
$beanOrBeans = self::$redbean->dispense( $type, $num, $alwaysReturnArray );
2014-10-13 09:24:53 +00:00
if ( isset( $import ) ) {
$beanOrBeans->import( $import );
}
2014-10-13 09:24:53 +00:00
return $beanOrBeans;
}
/**
2014-10-13 09:24:53 +00:00
* Takes a comma separated list of bean types
* and dispenses these beans. For each type in the list
* you can specify the number of beans to be dispensed.
*
* Usage:
*
* list($book, $page, $text) = R::dispenseAll('book,page,text');
*
* This will dispense a book, a page and a text. This way you can
* quickly dispense beans of various types in just one line of code.
*
* Usage:
*
2014-10-13 09:24:53 +00:00
* list($book, $pages) = R::dispenseAll('book,page*100');
*
* This returns an array with a book bean and then another array
* containing 100 page beans.
*
* @param string $order a description of the desired dispense order using the syntax above
* @param boolean $onlyArrays return only arrays even if amount < 2
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function dispenseAll( $order, $onlyArrays = FALSE )
{
2014-10-13 09:24:53 +00:00
$list = array();
2014-10-13 09:24:53 +00:00
foreach( explode( ',', $order ) as $order ) {
if ( strpos( $order, '*' ) !== false ) {
list( $type, $amount ) = explode( '*', $order );
} else {
$type = $order;
$amount = 1;
}
2014-10-13 09:24:53 +00:00
$list[] = self::dispense( $type, $amount, $onlyArrays );
}
2014-10-13 09:24:53 +00:00
return $list;
}
/**
2014-10-13 09:24:53 +00:00
* Convience method. Tries to find beans of a certain type,
* if no beans are found, it dispenses a bean of that type.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of bean you are looking for
* @param string $sql SQL code for finding the bean
* @param array $bindings parameters to bind to SQL
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function findOrDispense( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$finder->findOrDispense( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Finds a bean using a type and a where clause (SQL).
* As with most Query tools in RedBean you can provide values to
* be inserted in the SQL statement by populating the value
* array parameter; you can either use the question mark notation
* or the slot-notation (:keyname).
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function find( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$finder->find( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Facade::find
* The findAll() method differs from the find() method in that it does
* not assume a WHERE-clause, so this is valid:
*
* R::findAll('person',' ORDER BY name DESC ');
*
* Your SQL does not have to start with a valid WHERE-clause condition.
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function findAll( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$finder->find( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Facade::find
* The variation also exports the beans (i.e. it returns arrays).
*
2014-10-13 09:24:53 +00:00
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function findAndExport( $type, $sql = NULL, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$finder->findAndExport( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Facade::find
* This variation returns the first bean only.
*
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public static function findOne( $type, $sql = NULL, $bindings = array() )
{
return self::$finder->findOne( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* @see Facade::find
* This variation returns the last bean only.
*
* @param string $type type the type of bean you are looking for
* @param string $sql sql SQL query to find the desired bean, starting right after WHERE clause
* @param array $bindings values array of values to be bound to parameters in query
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public static function findLast( $type, $sql = NULL, $bindings = array() )
{
return self::$finder->findLast( $type, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Returns an array of beans. Pass a type and a series of ids and
* this method will bring you the corresponding beans.
*
* important note: Because this method loads beans using the load()
* function (but faster) it will return empty beans with ID 0 for
* every bean that could not be located. The resulting beans will have the
* passed IDs as their keys.
*
* @param string $type type of beans
* @param array $ids ids to load
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function batch( $type, $ids )
{
return self::$redbean->batch( $type, $ids );
}
/**
2014-10-13 09:24:53 +00:00
* @see Facade::batch
*
2014-10-13 09:24:53 +00:00
* Alias for batch(). Batch method is older but since we added so-called *All
* methods like storeAll, trashAll, dispenseAll and findAll it seemed logical to
* improve the consistency of the Facade API and also add an alias for batch() called
* loadAll.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans
* @param array $ids ids to load
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function loadAll( $type, $ids )
{
return self::$redbean->batch( $type, $ids );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
*
2014-10-13 09:24:53 +00:00
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return integer
*/
2014-10-13 09:24:53 +00:00
public static function exec( $sql, $bindings = array() )
{
return self::query( 'exec', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
*
2014-10-13 09:24:53 +00:00
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getAll( $sql, $bindings = array() )
{
return self::query( 'get', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
*
2014-10-13 09:24:53 +00:00
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function getCell( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::query( 'getCell', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
*
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getRow( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::query( 'getRow', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
*
2014-10-13 09:24:53 +00:00
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getCol( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::query( 'getCol', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
* Results will be returned as an associative array. The first
* column in the select clause will be used for the keys in this array and
* the second column will be used for the values. If only one column is
* selected in the query, both key and value of the array will have the
* value of this field for each row.
*
2014-10-13 09:24:53 +00:00
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getAssoc( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::query( 'getAssoc', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Convenience function to execute Queries directly.
* Executes SQL.
* Results will be returned as an associative array indexed by the first
* column in the select.
*
* @param string $sql sql SQL query to execute
* @param array $bindings values a list of values to be bound to query parameters
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getAssocRow( $sql, $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::query( 'getAssocRow', $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Makes a copy of a bean. This method makes a deep copy
* of the bean.The copy will have the following features.
* - All beans in own-lists will be duplicated as well
* - All references to shared beans will be copied but not the shared beans themselves
* - All references to parent objects (_id fields) will be copied but not the parents themselves
* In most cases this is the desired scenario for copying beans.
* This function uses a trail-array to prevent infinite recursion, if a recursive bean is found
* (i.e. one that already has been processed) the ID of the bean will be returned.
* This should not happen though.
*
* Note:
* This function does a reflectional database query so it may be slow.
*
* @deprecated
* This function is deprecated in favour of R::duplicate().
* This function has a confusing method signature, the R::duplicate() function
* only accepts two arguments: bean and filters.
*
* @param OODBBean $bean bean to be copied
* @param array $trail for internal usage, pass array()
* @param boolean $pid for internal usage
* @param array $white white list filter with bean types to duplicate
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function dup( $bean, $trail = array(), $pid = FALSE, $filters = array() )
{
2014-10-13 09:24:53 +00:00
self::$duplicationManager->setFilters( $filters );
return self::$duplicationManager->dup( $bean, $trail, $pid );
}
/**
2014-10-13 09:24:53 +00:00
* Makes a deep copy of a bean. This method makes a deep copy
* of the bean.The copy will have the following:
*
* - All beans in own-lists will be duplicated as well
* - All references to shared beans will be copied but not the shared beans themselves
* - All references to parent objects (_id fields) will be copied but not the parents themselves
*
* In most cases this is the desired scenario for copying beans.
* This function uses a trail-array to prevent infinite recursion, if a recursive bean is found
* (i.e. one that already has been processed) the ID of the bean will be returned.
* This should not happen though.
*
2014-10-13 09:24:53 +00:00
* Note:
* This function does a reflectional database query so it may be slow.
*
* Note:
* This is a simplified version of the deprecated R::dup() function.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to be copied
* @param array $white white list filter with bean types to duplicate
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function duplicate( $bean, $filters = array() )
{
2014-10-13 09:24:53 +00:00
return self::dup( $bean, array(), FALSE, $filters );
}
/**
2014-10-13 09:24:53 +00:00
* Exports a collection of beans. Handy for XML/JSON exports with a
* Javascript framework like Dojo or ExtJS.
* What will be exported:
* - contents of the bean
* - all own bean lists (recursively)
* - all shared beans (not THEIR own lists)
*
2014-10-13 09:24:53 +00:00
* @param array|OODBBean $beans beans to be exported
* @param boolean $parents whether you want parent beans to be exported
* @param array $filters whitelist of types
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function exportAll( $beans, $parents = FALSE, $filters = array())
{
2014-10-13 09:24:53 +00:00
return self::$duplicationManager->exportAll( $beans, $parents, $filters, self::$exportCaseStyle );
}
/**
2014-10-13 09:24:53 +00:00
* Selects case style for export.
* This will determine the case style for the keys of exported beans (see exportAll).
* The following options are accepted:
*
2014-10-13 09:24:53 +00:00
* 'default' RedBeanPHP by default enforces Snake Case (i.e. book_id is_valid )
* 'camel' Camel Case (i.e. bookId isValid )
* 'dolphin' Dolphin Case (i.e. bookID isValid ) Like CamelCase but ID is written all uppercase
*
* @warning RedBeanPHP transforms camelCase to snake_case using a slightly different
* algorithm, it also converts isACL to is_acl (not is_a_c_l) and bookID to book_id.
* Due to information loss this cannot be corrected. However if you might try
* DolphinCase for IDs it takes into account the exception concerning IDs.
*
* @param string $caseStyle case style identifier
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function useExportCase( $caseStyle = 'default' )
{
2014-10-13 09:24:53 +00:00
if ( !in_array( $caseStyle, array( 'default', 'camel', 'dolphin' ) ) ) throw new RedException( 'Invalid case selected.' );
self::$exportCaseStyle = $caseStyle;
}
/**
2014-10-13 09:24:53 +00:00
* Converts a series of rows to beans.
* This method converts a series of rows to beans.
* The type of the desired output beans can be specified in the
* first parameter. The second parameter is meant for the database
* result rows.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans to produce
* @param array $rows must contain an array of array
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function convertToBeans( $type, $rows )
{
return self::$redbean->convertToBeans( $type, $rows );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Tests whether a bean has been associated with one ore more
* of the listed tags. If the third parameter is TRUE this method
* will return TRUE only if all tags that have been specified are indeed
* associated with the given bean, otherwise FALSE.
* If the third parameter is FALSE this
* method will return TRUE if one of the tags matches, FALSE if none
* match.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to check for tags
* @param array $tags list of tags
* @param boolean $all whether they must all match or just some
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public static function hasTag( $bean, $tags, $all = FALSE )
{
2014-10-13 09:24:53 +00:00
return self::$tagManager->hasTag( $bean, $tags, $all );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Removes all specified tags from the bean. The tags specified in
* the second parameter will no longer be associated with the bean.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean tagged bean
* @param array $tagList list of tags (names)
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function untag( $bean, $tagList )
{
2014-10-13 09:24:53 +00:00
self::$tagManager->untag( $bean, $tagList );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Tags a bean or returns tags associated with a bean.
* If $tagList is NULL or omitted this method will return a
* comma separated list of tags associated with the bean provided.
* If $tagList is a comma separated list (string) of tags all tags will
* be associated with the bean.
* You may also pass an array instead of a string.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean
* @param mixed $tagList tags
*
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function tag( OODBBean $bean, $tagList = NULL )
{
2014-10-13 09:24:53 +00:00
return self::$tagManager->tag( $bean, $tagList );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Adds tags to a bean.
* If $tagList is a comma separated list of tags all tags will
* be associated with the bean.
* You may also pass an array instead of a string.
*
* @param OODBBean $bean bean
* @param array $tagList list of tags to add to bean
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function addTags( OODBBean $bean, $tagList )
{
2014-10-13 09:24:53 +00:00
self::$tagManager->addTags( $bean, $tagList );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Returns all beans that have been tagged with one of the tags given.
*
* @param string $beanType type of bean you are looking for
* @param array $tagList list of tags to match
* @param string $sql additional SQL
* @param array $bindings bindings
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function tagged( $beanType, $tagList, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$tagManager->tagged( $beanType, $tagList, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Part of RedBeanPHP Tagging API.
* Returns all beans that have been tagged with ALL of the tags given.
*
2014-10-13 09:24:53 +00:00
* @param string $beanType type of bean you are looking for
* @param array $tagList list of tags to match
* @param string $sql additional SQL
* @param array $bindings bindings
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function taggedAll( $beanType, $tagList, $sql = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return self::$tagManager->taggedAll( $beanType, $tagList, $sql, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Wipes all beans of type $beanType.
*
* @param string $beanType type of bean you want to destroy entirely
*
2014-10-13 09:24:53 +00:00
* @return boolean
*/
2014-10-13 09:24:53 +00:00
public static function wipe( $beanType )
{
2014-10-13 09:24:53 +00:00
return Facade::$redbean->wipe( $beanType );
}
/**
2014-10-13 09:24:53 +00:00
* Counts the number of beans of type $type.
* This method accepts a second argument to modify the count-query.
* A third argument can be used to provide bindings for the SQL snippet.
*
* @param string $type type of bean we are looking for
* @param string $addSQL additional SQL snippet
* @param array $bindings parameters to bind to SQL
*
2014-10-13 09:24:53 +00:00
* @return integer
*
* @throws SQL
*/
2014-10-13 09:24:53 +00:00
public static function count( $type, $addSQL = '', $bindings = array() )
{
2014-10-13 09:24:53 +00:00
return Facade::$redbean->count( $type, $addSQL, $bindings );
}
/**
2014-10-13 09:24:53 +00:00
* Configures the facade, want to have a new Writer? A new Object Database or a new
* Adapter and you want it on-the-fly? Use this method to hot-swap your facade with a new
* toolbox.
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $tb toolbox
*
2014-10-13 09:24:53 +00:00
* @return ToolBox
*/
2014-10-13 09:24:53 +00:00
public static function configureFacadeWithToolbox( ToolBox $tb )
{
2014-10-13 09:24:53 +00:00
$oldTools = self::$toolbox;
2014-10-13 09:24:53 +00:00
self::$toolbox = $tb;
2014-10-13 09:24:53 +00:00
self::$writer = self::$toolbox->getWriter();
self::$adapter = self::$toolbox->getDatabaseAdapter();
self::$redbean = self::$toolbox->getRedBean();
self::$finder = new Finder( self::$toolbox );
2014-10-13 09:24:53 +00:00
self::$associationManager = new AssociationManager( self::$toolbox );
2014-10-13 09:24:53 +00:00
self::$redbean->setAssociationManager( self::$associationManager );
2014-10-13 09:24:53 +00:00
self::$labelMaker = new LabelMaker( self::$toolbox );
2014-10-13 09:24:53 +00:00
$helper = new SimpleModelHelper();
$helper->attachEventListeners( self::$redbean );
self::$redbean->setBeanHelper( new SimpleFacadeBeanHelper );
self::$duplicationManager = new DuplicationManager( self::$toolbox );
self::$tagManager = new TagManager( self::$toolbox );
return $oldTools;
}
/**
2014-10-13 09:24:53 +00:00
* Facade Convience method for adapter transaction system.
* Begins a transaction.
*
2014-10-13 09:24:53 +00:00
* @return bool
*/
2014-10-13 09:24:53 +00:00
public static function begin()
{
2014-10-13 09:24:53 +00:00
if ( !self::$redbean->isFrozen() ) return FALSE;
2014-10-13 09:24:53 +00:00
self::$adapter->startTransaction();
2014-10-13 09:24:53 +00:00
return TRUE;
}
/**
2014-10-13 09:24:53 +00:00
* Facade Convience method for adapter transaction system.
* Commits a transaction.
*
2014-10-13 09:24:53 +00:00
* @return bool
*/
2014-10-13 09:24:53 +00:00
public static function commit()
{
2014-10-13 09:24:53 +00:00
if ( !self::$redbean->isFrozen() ) return FALSE;
self::$adapter->commit();
return TRUE;
}
/**
2014-10-13 09:24:53 +00:00
* Facade Convience method for adapter transaction system.
* Rolls back a transaction.
*
2014-10-13 09:24:53 +00:00
* @return bool
*/
2014-10-13 09:24:53 +00:00
public static function rollback()
{
2014-10-13 09:24:53 +00:00
if ( !self::$redbean->isFrozen() ) return FALSE;
2014-10-13 09:24:53 +00:00
self::$adapter->rollback();
return TRUE;
}
/**
2014-10-13 09:24:53 +00:00
* Returns a list of columns. Format of this array:
* array( fieldname => type )
* Note that this method only works in fluid mode because it might be
* quite heavy on production servers!
*
* @param string $table name of the table (not type) you want to get columns of
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function getColumns( $table )
{
2014-10-13 09:24:53 +00:00
return self::$writer->getColumns( $table );
}
/**
2014-10-13 09:24:53 +00:00
* Generates question mark slots for an array of values.
*
2014-10-13 09:24:53 +00:00
* @param array $array
*
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function genSlots( $array )
{
2014-10-13 09:24:53 +00:00
return ( count( $array ) ) ? implode( ',', array_fill( 0, count( $array ), '?' ) ) : '';
}
/**
2014-10-13 09:24:53 +00:00
* Nukes the entire database.
* This will remove all schema structures from the database.
* Only works in fluid mode. Be careful with this method.
*
2014-10-13 09:24:53 +00:00
* @warning dangerous method, will remove all tables, columns etc.
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function nuke()
{
2014-10-13 09:24:53 +00:00
if ( !self::$redbean->isFrozen() ) {
self::$writer->wipeAll();
}
}
/**
2014-10-13 09:24:53 +00:00
* Short hand function to store a set of beans at once, IDs will be
* returned as an array. For information please consult the R::store()
* function.
* A loop saver.
*
2014-10-13 09:24:53 +00:00
* @param array $beans list of beans to be stored
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function storeAll( $beans )
{
2014-10-13 09:24:53 +00:00
$ids = array();
foreach ( $beans as $bean ) {
$ids[] = self::store( $bean );
}
return $ids;
}
/**
2014-10-13 09:24:53 +00:00
* Short hand function to trash a set of beans at once.
* For information please consult the R::trash() function.
* A loop saver.
*
2014-10-13 09:24:53 +00:00
* @param array $beans list of beans to be trashed
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function trashAll( $beans )
{
2014-10-13 09:24:53 +00:00
foreach ( $beans as $bean ) {
self::trash( $bean );
}
}
/**
2014-10-13 09:24:53 +00:00
* Toggles Writer Cache.
* Turns the Writer Cache on or off. The Writer Cache is a simple
* query based caching system that may improve performance without the need
* for cache management. This caching system will cache non-modifying queries
* that are marked with special SQL comments. As soon as a non-marked query
* gets executed the cache will be flushed. Only non-modifying select queries
* have been marked therefore this mechanism is a rather safe way of caching, requiring
* no explicit flushes or reloads. Of course this does not apply if you intend to test
* or simulate concurrent querying.
*
2014-10-13 09:24:53 +00:00
* @param boolean $yesNo TRUE to enable cache, FALSE to disable cache
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function useWriterCache( $yesNo )
{
2014-10-13 09:24:53 +00:00
self::getWriter()->setUseCache( $yesNo );
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* A label is a bean with only an id, type and name property.
* This function will dispense beans for all entries in the array. The
* values of the array will be assigned to the name property of each
* individual bean.
*
2014-10-13 09:24:53 +00:00
* @param string $type type of beans you would like to have
* @param array $labels list of labels, names for each bean
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function dispenseLabels( $type, $labels )
{
2014-10-13 09:24:53 +00:00
return self::$labelMaker->dispenseLabels( $type, $labels );
}
/**
2014-10-13 09:24:53 +00:00
* Generates and returns an ENUM value. This is how RedBeanPHP handles ENUMs.
* Either returns a (newly created) bean respresenting the desired ENUM
* value or returns a list of all enums for the type.
*
2014-10-13 09:24:53 +00:00
* To obtain (and add if necessary) an ENUM value:
*
* $tea->flavour = R::enum( 'flavour:apple' );
*
2014-10-13 09:24:53 +00:00
* Returns a bean of type 'flavour' with name = apple.
* This will add a bean with property name (set to APPLE) to the database
* if it does not exist yet.
*
2014-10-13 09:24:53 +00:00
* To obtain all flavours:
*
2014-10-13 09:24:53 +00:00
* R::enum('flavour');
*
2014-10-13 09:24:53 +00:00
* To get a list of all flavour names:
*
2014-10-13 09:24:53 +00:00
* R::gatherLabels( R::enum( 'flavour' ) );
*
2014-10-13 09:24:53 +00:00
* @param string $enum either type or type-value
*
2014-10-13 09:24:53 +00:00
* @return array|OODBBean
*/
2014-10-13 09:24:53 +00:00
public static function enum( $enum )
{
2014-10-13 09:24:53 +00:00
return self::$labelMaker->enum( $enum );
}
/**
2014-10-13 09:24:53 +00:00
* Gathers labels from beans. This function loops through the beans,
* collects the values of the name properties of each individual bean
* and stores the names in a new array. The array then gets sorted using the
* default sort function of PHP (sort).
*
2014-10-13 09:24:53 +00:00
* @param array $beans list of beans to loop
*
2014-10-13 09:24:53 +00:00
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function gatherLabels( $beans )
{
2014-10-13 09:24:53 +00:00
return self::$labelMaker->gatherLabels( $beans );
}
/**
2014-10-13 09:24:53 +00:00
* Closes the database connection.
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function close()
{
2014-10-13 09:24:53 +00:00
if ( isset( self::$adapter ) ) {
self::$adapter->close();
}
}
/**
2014-10-13 09:24:53 +00:00
* Simple convenience function, returns ISO date formatted representation
* of $time.
*
2014-10-13 09:24:53 +00:00
* @param mixed $time UNIX timestamp
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function isoDate( $time = NULL )
{
2014-10-13 09:24:53 +00:00
if ( !$time ) {
$time = time();
}
2014-10-13 09:24:53 +00:00
return @date( 'Y-m-d', $time );
}
/**
2014-10-13 09:24:53 +00:00
* Simple convenience function, returns ISO date time
* formatted representation
* of $time.
*
2014-10-13 09:24:53 +00:00
* @param mixed $time UNIX timestamp
*
2014-10-13 09:24:53 +00:00
* @return string
*/
2014-10-13 09:24:53 +00:00
public static function isoDateTime( $time = NULL )
{
2014-10-13 09:24:53 +00:00
if ( !$time ) $time = time();
2014-10-13 09:24:53 +00:00
return @date( 'Y-m-d H:i:s', $time );
}
/**
2014-10-13 09:24:53 +00:00
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
2014-10-13 09:24:53 +00:00
* @param Adapter $adapter
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function setDatabaseAdapter( Adapter $adapter )
{
2014-10-13 09:24:53 +00:00
self::$adapter = $adapter;
}
/**
2014-10-13 09:24:53 +00:00
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
2014-10-13 09:24:53 +00:00
* @param QueryWriter $writer
*
2014-10-13 09:24:53 +00:00
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function setWriter( QueryWriter $writer )
{
2014-10-13 09:24:53 +00:00
self::$writer = $writer;
}
/**
2014-10-13 09:24:53 +00:00
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
2014-10-13 09:24:53 +00:00
* @param OODB $redbean
*/
2014-10-13 09:24:53 +00:00
public static function setRedBean( OODB $redbean )
{
2014-10-13 09:24:53 +00:00
self::$redbean = $redbean;
}
2014-10-13 09:24:53 +00:00
/**
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
* @return DBAdapter
*/
public static function getDatabaseAdapter()
{
return self::$adapter;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the current duplication manager instance.
*
2014-10-13 09:24:53 +00:00
* @return DuplicationManager
*/
2014-10-13 09:24:53 +00:00
public static function getDuplicationManager()
{
2014-10-13 09:24:53 +00:00
return self::$duplicationManager;
}
/**
2014-10-13 09:24:53 +00:00
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
2014-10-13 09:24:53 +00:00
* @return QueryWriter
*/
2014-10-13 09:24:53 +00:00
public static function getWriter()
{
2014-10-13 09:24:53 +00:00
return self::$writer;
}
/**
2014-10-13 09:24:53 +00:00
* Optional accessor for neat code.
* Sets the database adapter you want to use.
*
* @return OODB
*/
2014-10-13 09:24:53 +00:00
public static function getRedBean()
{
2014-10-13 09:24:53 +00:00
return self::$redbean;
}
/**
2014-10-13 09:24:53 +00:00
* Returns the toolbox currently used by the facade.
* To set the toolbox use R::setup() or R::configureFacadeWithToolbox().
* To create a toolbox use Setup::kickstart(). Or create a manual
* toolbox using the ToolBox class.
*
* @return ToolBox
*/
2014-10-13 09:24:53 +00:00
public static function getToolBox()
{
2014-10-13 09:24:53 +00:00
return self::$toolbox;
}
2014-10-13 09:24:53 +00:00
/**
* Mostly for internal use, but might be handy
* for some users.
* This returns all the components of the currently
* selected toolbox.
*
* Returns the components in the following order:
*
* 0 - OODB instance (getRedBean())
* 1 - Database Adapter
* 2 - Query Writer
* 3 - Toolbox itself
*
* @return array
*/
public static function getExtractedToolbox()
{
return array(
self::$redbean,
self::$adapter,
self::$writer,
self::$toolbox
);
}
/**
2014-10-13 09:24:53 +00:00
* Facade method for AQueryWriter::renameAssociation()
*
* @param string|array $from
* @param string $to
*
* @return void
*/
2014-10-13 09:24:53 +00:00
public static function renameAssociation( $from, $to = NULL )
{
AQueryWriter::renameAssociation( $from, $to );
}
/**
2014-10-13 09:24:53 +00:00
* Little helper method for Resty Bean Can server and others.
* Takes an array of beans and exports each bean.
* Unlike exportAll this method does not recurse into own lists
* and shared lists, the beans are exported as-is, only loaded lists
* are exported.
*
* @param array $beans beans
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public static function beansToArray( $beans )
{
$list = array();
foreach( $beans as $bean ) {
$list[] = $bean->export();
}
return $list;
}
2014-10-13 09:24:53 +00:00
/**
2014-10-13 09:24:53 +00:00
* Simple but effective debug function.
* Given a one or more beans this method will
* return an array containing first part of the string
* representation of each item in the array.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean|array $data either a bean or an array of beans
*
* @return array
*
*/
2014-10-13 09:24:53 +00:00
public static function dump( $data )
{
$array = array();
if ( $data instanceof OODBBean ) {
$str = strval( $data );
if (strlen($str) > 35) {
$beanStr = substr( $str, 0, 35 ).'... ';
} else {
$beanStr = $str;
}
2014-10-13 09:24:53 +00:00
return $beanStr;
}
if ( is_array( $data ) ) {
foreach( $data as $key => $item ) {
$array[$key] = self::dump( $item );
}
}
2014-10-13 09:24:53 +00:00
return $array;
}
/**
2014-10-13 09:24:53 +00:00
* Binds an SQL function to a column.
* This method can be used to setup a decode/encode scheme or
* perform UUID insertion. This method is especially useful for handling
* MySQL spatial columns, because they need to be processed first using
* the asText/GeomFromText functions.
*
* Example:
*
* R::bindFunc( 'read', 'location.point', 'asText' );
* R::bindFunc( 'write', 'location.point', 'GeomFromText' );
*
* Passing NULL as the function will reset (clear) the function
* for this column/mode.
*
* @param string $mode (read or write)
* @param string $field
* @param string $function
*
*/
2014-10-13 09:24:53 +00:00
public static function bindFunc( $mode, $field, $function ) {
self::$redbean->bindFunc( $mode, $field, $function );
}
/**
2014-10-13 09:24:53 +00:00
* Dynamically extends the facade with a plugin.
* Using this method you can register your plugin with the facade and then
* use the plugin by invoking the name specified plugin name as a method on
* the facade.
*
2014-10-13 09:24:53 +00:00
* Usage:
*
2014-10-13 09:24:53 +00:00
* R::ext( 'makeTea', function() { ... } );
*
* Now you can use your makeTea plugin like this:
*
* R::makeTea();
*
* @param string $pluginName name of the method to call the plugin
* @param callable $callable a PHP callable
*/
2014-10-13 09:24:53 +00:00
public static function ext( $pluginName, $callable )
{
2014-10-13 09:24:53 +00:00
if ( !ctype_alnum( $pluginName ) ) {
throw new RedException( 'Plugin name may only contain alphanumeric characters.' );
}
self::$plugins[$pluginName] = $callable;
}
/**
2014-10-13 09:24:53 +00:00
* Call static for use with dynamic plugins. This magic method will
* intercept static calls and route them to the specified plugin.
*
2014-10-13 09:24:53 +00:00
* @param string $pluginName name of the plugin
* @param array $params list of arguments to pass to plugin method
*
* @return mixed
*/
2014-10-13 09:24:53 +00:00
public static function __callStatic( $pluginName, $params )
{
2014-10-13 09:24:53 +00:00
if ( !ctype_alnum( $pluginName) ) {
throw new RedException( 'Plugin name may only contain alphanumeric characters.' );
}
2014-10-13 09:24:53 +00:00
if ( !isset( self::$plugins[$pluginName] ) ) {
throw new RedException( 'Plugin \''.$pluginName.'\' does not exist, add this plugin using: R::ext(\''.$pluginName.'\')' );
}
return call_user_func_array( self::$plugins[$pluginName], $params );
}
}
2014-10-13 09:24:53 +00:00
}
2014-10-13 09:24:53 +00:00
namespace RedBeanPHP {
2014-10-13 09:24:53 +00:00
use RedBeanPHP\ToolBox as ToolBox;
use RedBeanPHP\AssociationManager as AssociationManager;
use RedBeanPHP\OODB as OODB;
use RedBeanPHP\OODBBean as OODBBean;
use RedBeanPHP\QueryWriter\AQueryWriter as AQueryWriter;
/**
* Duplication Manager
*
* @file RedBean/DuplicationManager.php
* @desc Creates deep copies of beans
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
class DuplicationManager
{
/**
2014-10-13 09:24:53 +00:00
* @var ToolBox
*/
protected $toolbox;
/**
2014-10-13 09:24:53 +00:00
* @var AssociationManager
*/
protected $associationManager;
/**
2014-10-13 09:24:53 +00:00
* @var OODB
*/
protected $redbean;
/**
* @var array
*/
protected $tables = array();
/**
* @var array
*/
protected $columns = array();
/**
* @var array
*/
protected $filters = array();
/**
* @var array
*/
protected $cacheTables = FALSE;
2014-10-13 09:24:53 +00:00
/**
* Recursively turns the keys of an array into
* camelCase.
*
* @param array $array array to camelize
* @param boolean $dolphinMode whether you want the exception for IDs.
*
* @return array
*/
public function camelfy( $array, $dolphinMode = false ) {
$newArray = array();
foreach( $array as $key => $element ) {
$newKey = preg_replace_callback( '/_(\w)/', function( &$matches ){
return strtoupper( $matches[1] );
}, $key);
if ( $dolphinMode ) {
$newKey = preg_replace( '/(\w)Id$/', '$1ID', $newKey );
}
$newArray[$newKey] = ( is_array($element) ) ? $this->camelfy( $element, $dolphinMode ) : $element;
}
return $newArray;
}
/**
* Copies the shared beans in a bean, i.e. all the sharedBean-lists.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $copy target bean to copy lists to
* @param string $shared name of the shared list
* @param array $beans array with shared beans to copy
*
* @return void
*/
2014-10-13 09:24:53 +00:00
private function copySharedBeans( OODBBean $copy, $shared, $beans )
{
$copy->$shared = array();
foreach ( $beans as $subBean ) {
array_push( $copy->$shared, $subBean );
}
}
/**
* Copies the own beans in a bean, i.e. all the ownBean-lists.
* Each bean in the own-list belongs exclusively to its owner so
* we need to invoke the duplicate method again to duplicate each bean here.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $copy target bean to copy lists to
* @param string $owned name of the own list
* @param array $beans array with shared beans to copy
* @param array $trail array with former beans to detect recursion
* @param boolean $preserveIDs TRUE means preserve IDs, for export only
*
* @return void
*/
2014-10-13 09:24:53 +00:00
private function copyOwnBeans( OODBBean $copy, $owned, $beans, $trail, $preserveIDs )
{
$copy->$owned = array();
foreach ( $beans as $subBean ) {
array_push( $copy->$owned, $this->duplicate( $subBean, $trail, $preserveIDs ) );
}
}
/**
* Creates a copy of bean $bean and copies all primitive properties (not lists)
* and the parents beans to the newly created bean. Also sets the ID of the bean
* to 0.
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to copy
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
private function createCopy( OODBBean $bean )
{
$type = $bean->getMeta( 'type' );
$copy = $this->redbean->dispense( $type );
2014-10-13 09:24:53 +00:00
$copy->setMeta( 'sys.dup-from-id', $bean->id );
$copy->setMeta( 'sys.old-id', $bean->id );
$copy->importFrom( $bean );
$copy->id = 0;
return $copy;
}
/**
* Generates a key from the bean type and its ID and determines if the bean
* occurs in the trail, if not the bean will be added to the trail.
* Returns TRUE if the bean occurs in the trail and FALSE otherwise.
*
* @param array $trail list of former beans
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean currently selected bean
*
* @return boolean
*/
2014-10-13 09:24:53 +00:00
private function inTrailOrAdd( &$trail, OODBBean $bean )
{
$type = $bean->getMeta( 'type' );
$key = $type . $bean->getID();
if ( isset( $trail[$key] ) ) {
return TRUE;
}
$trail[$key] = $bean;
return FALSE;
}
/**
* Given the type name of a bean this method returns the canonical names
* of the own-list and the shared-list properties respectively.
* Returns a list with two elements: name of the own-list, and name
* of the shared list.
*
* @param string $typeName bean type name
*
* @return array
*/
private function getListNames( $typeName )
{
$owned = 'own' . ucfirst( $typeName );
$shared = 'shared' . ucfirst( $typeName );
return array( $owned, $shared );
}
/**
* Determines whether the bean has an own list based on
* schema inspection from realtime schema or cache.
*
* @param string $type bean type to get list for
* @param string $target type of list you want to detect
*
* @return boolean
*/
protected function hasOwnList( $type, $target )
{
return isset( $this->columns[$target][$type . '_id'] );
}
/**
* Determines whether the bea has a shared list based on
* schema inspection from realtime schema or cache.
*
* @param string $type bean type to get list for
* @param string $target type of list you are looking for
*
* @return boolean
*/
protected function hasSharedList( $type, $target )
{
2014-10-13 09:24:53 +00:00
return in_array( AQueryWriter::getAssocTableFormat( array( $type, $target ) ), $this->tables );
}
/**
2014-10-13 09:24:53 +00:00
* @see DuplicationManager::dup
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to be copied
* @param array $trail trail to prevent infinite loops
* @param boolean $preserveIDs preserve IDs
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
protected function duplicate( OODBBean $bean, $trail = array(), $preserveIDs = FALSE )
{
if ( $this->inTrailOrAdd( $trail, $bean ) ) return $bean;
$type = $bean->getMeta( 'type' );
$copy = $this->createCopy( $bean );
foreach ( $this->tables as $table ) {
if ( !empty( $this->filters ) ) {
if ( !in_array( $table, $this->filters ) ) continue;
}
list( $owned, $shared ) = $this->getListNames( $table );
if ( $this->hasSharedList( $type, $table ) ) {
if ( $beans = $bean->$shared ) {
$this->copySharedBeans( $copy, $shared, $beans );
}
} elseif ( $this->hasOwnList( $type, $table ) ) {
if ( $beans = $bean->$owned ) {
$this->copyOwnBeans( $copy, $owned, $beans, $trail, $preserveIDs );
}
$copy->setMeta( 'sys.shadow.' . $owned, NULL );
}
$copy->setMeta( 'sys.shadow.' . $shared, NULL );
}
$copy->id = ( $preserveIDs ) ? $bean->id : $copy->id;
return $copy;
}
/**
* Constructor,
* creates a new instance of DupManager.
*
2014-10-13 09:24:53 +00:00
* @param ToolBox $toolbox
*/
2014-10-13 09:24:53 +00:00
public function __construct( ToolBox $toolbox )
{
$this->toolbox = $toolbox;
$this->redbean = $toolbox->getRedBean();
$this->associationManager = $this->redbean->getAssociationManager();
}
/**
* For better performance you can pass the tables in an array to this method.
* If the tables are available the duplication manager will not query them so
* this might be beneficial for performance.
*
* @param array $tables
*
* @return void
*/
public function setTables( $tables )
{
foreach ( $tables as $key => $value ) {
if ( is_numeric( $key ) ) {
$this->tables[] = $value;
} else {
$this->tables[] = $key;
$this->columns[$key] = $value;
}
}
$this->cacheTables = TRUE;
}
/**
* Returns a schema array for cache.
*
* @return array
*/
public function getSchema()
{
return $this->columns;
}
/**
* Indicates whether you want the duplication manager to cache the database schema.
* If this flag is set to TRUE the duplication manager will query the database schema
* only once. Otherwise the duplicationmanager will, by default, query the schema
* every time a duplication action is performed (dup()).
*
* @param boolean $yesNo
*/
public function setCacheTables( $yesNo )
{
$this->cacheTables = $yesNo;
}
/**
* A filter array is an array with table names.
* By setting a table filter you can make the duplication manager only take into account
* certain bean types. Other bean types will be ignored when exporting or making a
* deep copy. If no filters are set all types will be taking into account, this is
* the default behavior.
*
* @param array $filters
*/
public function setFilters( $filters )
{
if ( !is_array( $filters ) ) {
$filters = array( $filters );
}
$this->filters = $filters;
}
/**
* Makes a copy of a bean. This method makes a deep copy
* of the bean.The copy will have the following features.
* - All beans in own-lists will be duplicated as well
* - All references to shared beans will be copied but not the shared beans themselves
* - All references to parent objects (_id fields) will be copied but not the parents themselves
* In most cases this is the desired scenario for copying beans.
* This function uses a trail-array to prevent infinite recursion, if a recursive bean is found
* (i.e. one that already has been processed) the ID of the bean will be returned.
* This should not happen though.
*
* Note:
* This function does a reflectional database query so it may be slow.
*
* Note:
* this function actually passes the arguments to a protected function called
* duplicate() that does all the work. This method takes care of creating a clone
* of the bean to avoid the bean getting tainted (triggering saving when storing it).
*
2014-10-13 09:24:53 +00:00
* @param OODBBean $bean bean to be copied
* @param array $trail for internal usage, pass array()
* @param boolean $preserveIDs for internal usage
*
2014-10-13 09:24:53 +00:00
* @return OODBBean
*/
2014-10-13 09:24:53 +00:00
public function dup( OODBBean $bean, $trail = array(), $preserveIDs = FALSE )
{
if ( !count( $this->tables ) ) {
$this->tables = $this->toolbox->getWriter()->getTables();
}
if ( !count( $this->columns ) ) {
foreach ( $this->tables as $table ) {
$this->columns[$table] = $this->toolbox->getWriter()->getColumns( $table );
}
}
$rs = $this->duplicate( clone( $bean ), $trail, $preserveIDs );
if ( !$this->cacheTables ) {
$this->tables = array();
$this->columns = array();
}
2014-10-13 09:24:53 +00:00
return $rs;
}
/**
* Exports a collection of beans. Handy for XML/JSON exports with a
* Javascript framework like Dojo or ExtJS.
* What will be exported:
* - contents of the bean
* - all own bean lists (recursively)
* - all shared beans (not THEIR own lists)
*
2014-10-13 09:24:53 +00:00
* @param array|OODBBean $beans beans to be exported
* @param boolean $parents also export parents
* @param array $filters only these types (whitelist)
* @param string $caseStyle case style identifier
*
* @return array
*/
2014-10-13 09:24:53 +00:00
public function exportAll( $beans, $parents = FALSE, $filters = array(), $caseStyle = 'snake')
{
$array = array();
if ( !is_array( $beans ) ) {
$beans = array( $beans );
}
foreach ( $beans as $bean ) {
$this->setFilters( $filters );
$duplicate = $this->dup( $bean, array(), TRUE );
$array[] = $duplicate->export( FALSE, $parents, FALSE, $filters );
}
2014-10-13 09:24:53 +00:00
if ( $caseStyle === 'camel' ) $array = $this->camelfy( $array );
if ( $caseStyle === 'dolphin' ) $array = $this->camelfy( $array, true );
return $array;
}
}
2014-10-13 09:24:53 +00:00
}
namespace RedBeanPHP {
/**
* RedBean Plugin
*
* @file RedBean/Plugin.php
* @desc Marker interface for plugins.
* @author Gabor de Mooij and the RedBeanPHP Community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
interface Plugin
{
}
;
}
namespace {
//make some classes available for backward compatibility
class RedBean_SimpleModel extends \RedBeanPHP\SimpleModel {};
if (!class_exists('R')) {
class R extends \RedBeanPHP\Facade{};
}
/**
* Support functions for RedBeanPHP.
*
* @file RedBeanPHP/Functions.php
* @desc Additional convenience shortcut functions for RedBeanPHP
* @author Gabor de Mooij and the RedBeanPHP community
* @license BSD/GPLv2
*
* copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community.
* This source file is subject to the BSD/GPLv2 License that is bundled
* with this source code in the file license.txt.
*/
/**
* Convenience function for ENUM short syntax in queries.
*
* Usage:
*
* R::find( 'paint', ' color_id = ? ', [ EID('color:yellow') ] );
*
* If a function called EID() already exists you'll have to write this
* wrapper yourself ;)
*
* @param string $enumName enum code as you would pass to R::enum()
*
* @return mixed
*/
if (!function_exists('EID')) {
function EID($enumName)
{
return \RedBeanPHP\Facade::enum( $enumName )->id;
}
}
2014-10-13 09:24:53 +00:00
/**
* Prints the result of R::dump() to the screen using
* print_r.
*
* @param mixed $data data to dump
*
* @return void
*/
if ( !function_exists( 'dump' ) ) {
2014-10-13 09:24:53 +00:00
function dmp( $list )
{
print_r( \RedBeanPHP\Facade::dump( $list ) );
}
}
2014-10-13 09:24:53 +00:00
}