1
0
mirror of synced 2024-12-13 22:56:04 +03:00
doctrine2/lib/Doctrine/Plugin.php

184 lines
5.9 KiB
PHP
Raw Normal View History

2007-08-01 01:59:45 +04:00
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Plugin
*
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @subpackage Plugin
2007-08-01 01:59:45 +04:00
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Revision$
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Plugin
{
/**
* @var array $_options an array of plugin specific options
*/
2007-10-15 02:11:48 +04:00
protected $_options = array('generateFiles' => false,
'identifier' => false);
2007-09-02 15:29:14 +04:00
/**
* __get
* an alias for getOption
*
* @param string $option
*/
public function __get($option)
{
2007-09-02 21:34:44 +04:00
if (isset($this->_options[$option])) {
2007-09-02 15:29:14 +04:00
return $this->_options[$option];
}
return null;
}
2007-09-02 15:29:14 +04:00
/**
* __isset
*
* @param string $option
*/
public function __isset($option)
{
return isset($this->_options[$option]);
}
2007-08-01 01:59:45 +04:00
/**
* returns the value of an option
*
* @param $option the name of the option to retrieve
* @return mixed the value of the option
*/
public function getOption($name)
{
if ( ! isset($this->_options[$name])) {
throw new Doctrine_Plugin_Exception('Unknown option ' . $name);
}
return $this->_options[$name];
}
2007-08-01 01:59:45 +04:00
/**
* sets given value to an option
*
* @param $option the name of the option to be changed
* @param $value the value of the option
* @return Doctrine_Plugin this object
*/
public function setOption($name, $value)
{
$this->_options[$name] = $value;
return $this;
}
2007-08-01 01:59:45 +04:00
/**
* returns all options and their associated values
*
* @return array all options as an associative array
*/
public function getOptions()
{
2007-09-02 15:29:14 +04:00
return $this->_options;
2007-08-01 01:59:45 +04:00
}
2007-10-13 20:27:47 +04:00
/**
* generates foreign keys for the plugin table based on the owner table
*
* the foreign keys generated by this method can be used for
* setting the relations between the owner and the plugin classes
*
* @param Doctrine_Table $table the table object that owns the plugin
* @return array an array of foreign key definitions
*/
public function generateForeignKeys(Doctrine_Table $table)
{
$fk = array();
foreach ((array) $table->getIdentifier() as $column) {
$def = $table->getDefinitionOf($column);
unset($def['autoincrement']);
unset($def['sequence']);
unset($def['primary']);
$col = $column;
2007-10-13 20:27:47 +04:00
$def['primary'] = true;
$fk[$col] = $def;
}
return $fk;
}
2007-10-13 20:27:47 +04:00
/**
* generates a relation array to given table
*
* this method can be used for generating the relation from the plugin
* table to the owner table
*
* @param Doctrine_Table $table the table object to construct the relation to
* @param array $foreignKeys an array of foreign keys
* @return array the generated relation array
*/
public function generateRelation(Doctrine_Table $table, array $foreignKeys)
{
$local = (count($foreignKeys) > 1) ? array_keys($foreignKeys) : key($foreignKeys);
$relation = array($table->getComponentName() =>
array('local' => $local,
'foreign' => $table->getIdentifier(),
'onDelete' => 'CASCADE',
'onUpdate' => 'CASCADE'));
return $relation;
}
2007-10-13 20:27:47 +04:00
/**
* generates the class definition for plugin class
*
* @param array $options plugin class options, keys representing the option names
* and values as option values
* @param array $columns the plugin class columns, keys representing the column names
* and values as column definitions
* @param array $relations the bound relations of the plugin class
* @return void
*/
2007-10-13 13:01:03 +04:00
public function generateClass($options, $columns, $relations)
{
$builder = new Doctrine_Import_Builder();
if ($this->_options['generateFiles']) {
if (isset($this->_options['generatePath']) && $this->_options['generatePath']) {
$builder->setTargetPath($this->_options['generatePath']);
$builder->buildRecord($options, $columns, $relations);
} else {
throw new Doctrine_Plugin_Exception('If you wish to generate files then you must specify the path to generate the files in.');
}
} else {
$def = $builder->buildDefinition($options, $columns, $relations);
eval($def);
}
}
}