+++ /dev/null
-<?php
-
-namespace RedBeanPHP;
-
-use RedBeanPHP\Adapter\DBAdapter as DBAdapter;
-use RedBeanPHP\QueryWriter as QueryWriter;
-use RedBeanPHP\RedException as RedException;
-use RedBeanPHP\RedException\SQL as SQLException;
-
-/**
- * Association Manager.
- * Manages simple bean associations.
- *
- * @file RedBeanPHP/AssociationManager.php
- * @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 AssociationManager extends Observable
-{
- /**
- * @var OODB
- */
- protected $oodb;
-
- /**
- * @var DBAdapter
- */
- protected $adapter;
-
- /**
- * @var QueryWriter
- */
- protected $writer;
-
- /**
- * Handles exceptions. Suppresses exceptions caused by missing structures.
- *
- * @param \Exception $exception exception to handle
- *
- * @return void
- */
- private function handleException( \Exception $exception )
- {
- if ( $this->oodb->isFrozen() || !$this->writer->sqlStateIn( $exception->getSQLState(),
- array(
- QueryWriter::C_SQLSTATE_NO_SUCH_TABLE,
- QueryWriter::C_SQLSTATE_NO_SUCH_COLUMN )
- )
- ) {
- throw $exception;
- }
- }
-
- /**
- * 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.
- *
- * @param OODBBean $bean reference bean instance
- * @param string $type target bean type
- * @param string $sql additional SQL snippet
- * @param array $bindings bindings for query
- *
- * @return array
- */
- private function relatedRows( $bean, $type, $sql = '', $bindings = array() )
- {
- $ids = array( $bean->id );
- $sourceType = $bean->getMeta( 'type' );
- try {
- return $this->writer->queryRecordRelated( $sourceType, $type, $ids, $sql, $bindings );
- } catch ( SQLException $exception ) {
- $this->handleException( $exception );
- return array();
- }
- }
-
- /**
- * 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.
- *
- * @param OODBBean $bean1 first bean
- * @param OODBBean $bean2 second bean
- * @param OODBBean $bean base bean (association record)
- *
- * @return mixed
- */
- protected function associateBeans( OODBBean $bean1, OODBBean $bean2, OODBBean $bean )
- {
- $type = $bean->getMeta( 'type' );
- $property1 = $bean1->getMeta( 'type' ) . '_id';
- $property2 = $bean2->getMeta( 'type' ) . '_id';
-
- if ( $property1 == $property2 ) {
- $property2 = $bean2->getMeta( 'type' ) . '2_id';
- }
-
- $this->oodb->store( $bean1 );
- $this->oodb->store( $bean2 );
-
- $bean->setMeta( "cast.$property1", "id" );
- $bean->setMeta( "cast.$property2", "id" );
- $bean->setMeta( 'sys.buildcommand.unique', array( $property1, $property2 ) );
-
- $bean->$property1 = $bean1->id;
- $bean->$property2 = $bean2->id;
-
- $results = array();
-
- try {
- $id = $this->oodb->store( $bean );
- $results[] = $id;
- } catch ( SQLException $exception ) {
- if ( !$this->writer->sqlStateIn( $exception->getSQLState(),
- array( QueryWriter::C_SQLSTATE_INTEGRITY_CONSTRAINT_VIOLATION ) )
- ) {
- throw $exception;
- }
- }
-
- return $results;
- }
-
- /**
- * Constructor
- *
- * @param ToolBox $tools toolbox
- */
- public function __construct( ToolBox $tools )
- {
- $this->oodb = $tools->getRedBean();
- $this->adapter = $tools->getDatabaseAdapter();
- $this->writer = $tools->getWriter();
- $this->toolbox = $tools;
- }
-
- /**
- * Creates a table name based on a types array.
- * Manages the get the correct name for the linking table for the
- * types provided.
- *
- * @param array $types 2 types as strings
- *
- * @return string
- */
- public function getTable( $types )
- {
- return $this->writer->getAssocTable( $types );
- }
-
- /**
- * 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
- *
- * @return array
- */
- public function associate( $beans1, $beans2 )
- {
- 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 );
- }
-
- /**
- * 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.
- *
- * @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
- *
- * @return integer
- */
- public function relatedCount( $bean, $type, $sql = NULL, $bindings = array() )
- {
- 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 ( SQLException $exception ) {
- $this->handleException( $exception );
-
- return 0;
- }
- }
-
- /**
- * 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.
- *
- * @param OODBBean $bean1 first bean in target association
- * @param OODBBean $bean2 second bean in target association
- * @param boolean $fast if TRUE, removes the entries by query without FUSE
- *
- * @return void
- */
- public function unassociate( $beans1, $beans2, $fast = NULL )
- {
- $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 ( SQLException $exception ) {
- $this->handleException( $exception );
- }
- }
- }
- }
-
- /**
- * 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)
- *
- * @param OODBBean $bean reference bean
- * @param string $type type of beans that need to be unassociated
- *
- * @return void
- */
- public function clearRelations( OODBBean $bean, $type )
- {
- $this->oodb->store( $bean );
- try {
- $this->writer->deleteRelations( $bean->getMeta( 'type' ), $type, $bean->id );
- } catch ( SQLException $exception ) {
- $this->handleException( $exception );
- }
- }
-
- /**
- * 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.
- *
- * 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
- *
- * @return array
- */
- public function related( $bean, $type, $sql = '', $bindings = array() )
- {
- $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;
- }
-}