Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 338752ab0f
Fetching contributors…

Cannot retrieve contributors at this time

5130 lines (4626 sloc) 175.852 kb
<?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Propel\Generator\Builder\Om;
use Propel\Generator\Exception\EngineException;
use Propel\Generator\Model\Column;
use Propel\Generator\Model\ForeignKey;
use Propel\Generator\Model\IdMethod;
use Propel\Generator\Model\PropelTypes;
use Propel\Generator\Platform\MssqlPlatform;
use Propel\Generator\Platform\MysqlPlatform;
use Propel\Generator\Platform\PlatformInterface;
/**
* Generates a PHP5 base Object class for user object model (OM).
*
* This class produces the base object class (e.g. BaseMyTable) which contains
* all the custom-built accessor and setter methods.
*
* @author Hans Lellelid <hans@xmpl.org>
*/
class ObjectBuilder extends AbstractObjectBuilder
{
/**
* Returns the package for the base object classes.
*
* @return string
*/
public function getPackage()
{
return parent::getPackage() . ".Base";
}
/**
* Returns the namespace for the base class.
*
* @return string
* @see Propel\Generator\Builder\Om.AbstractOMBuilder::getNamespace()
*/
public function getNamespace()
{
if ($namespace = parent::getNamespace()) {
return $namespace . '\\Base';
}
return 'Base';
}
/**
* Returns default key type.
*
* If not presented in configuration default will be 'TYPE_PHPNAME'
*
* @return string
*/
public function getDefaultKeyType()
{
$defaultKeyType = $this->getBuildProperty('defaultKeyType') ? $this->getBuildProperty('defaultKeyType') : 'phpName';
return "TYPE_".strtoupper($defaultKeyType);
}
/**
* Returns the name of the current class being built.
*
* @return string
*/
public function getUnprefixedClassName()
{
return $this->getStubObjectBuilder()->getUnprefixedClassName();
}
/**
* Validates the current table to make sure that it won't result in
* generated code that will not parse.
*
* This method may emit warnings for code which may cause problems
* and will throw exceptions for errors that will definitely cause
* problems.
*/
protected function validateModel()
{
parent::validateModel();
$table = $this->getTable();
// Check to see whether any generated foreign key names
// will conflict with column names.
$colPhpNames = array();
$fkPhpNames = array();
foreach ($table->getColumns() as $col) {
$colPhpNames[] = $col->getPhpName();
}
foreach ($table->getForeignKeys() as $fk) {
$fkPhpNames[] = $this->getFKPhpNameAffix($fk, false);
}
$intersect = array_intersect($colPhpNames, $fkPhpNames);
if (!empty($intersect)) {
throw new EngineException("One or more of your column names for [" . $table->getName() . "] table conflict with foreign key names (" . implode(", ", $intersect) . ")");
}
// Check foreign keys to see if there are any foreign keys that
// are also matched with an inversed referencing foreign key
// (this is currently unsupported behavior)
// see: http://propel.phpdb.org/trac/ticket/549
foreach ($table->getForeignKeys() as $fk) {
if ($fk->isMatchedByInverseFK()) {
throw new EngineException(sprintf('The 1:1 relationship expressed by foreign key %s is defined in both directions; Propel does not currently support this (if you must have both foreign key constraints, consider adding this constraint with a custom SQL file.)', $fk->getName()));
}
}
}
/**
* Returns the appropriate formatter (from platform) for a date/time column.
*
* @param Column $column
* @return string
*/
protected function getTemporalFormatter(Column $column)
{
$fmt = null;
if ($column->getType() === PropelTypes::DATE) {
$fmt = $this->getPlatform()->getDateFormatter();
} elseif ($column->getType() === PropelTypes::TIME) {
$fmt = $this->getPlatform()->getTimeFormatter();
} elseif ($column->getType() === PropelTypes::TIMESTAMP) {
$fmt = $this->getPlatform()->getTimestampFormatter();
}
return $fmt;
}
/**
* Returns the type-casted and stringified default value for the specified
* Column. This only works for scalar default values currently.
*
* @param Column $column
* @return string
*/
protected function getDefaultValueString(Column $column)
{
$defaultValue = var_export(null, true);
$val = $column->getPhpDefaultValue();
if (null === $val) {
return $defaultValue;
}
if ($column->isTemporalType()) {
$fmt = $this->getTemporalFormatter($column);
try {
if (!($this->getPlatform() instanceof MysqlPlatform &&
($val === '0000-00-00 00:00:00' || $val === '0000-00-00'))) {
// while technically this is not a default value of NULL,
// this seems to be closest in meaning.
$defDt = new \DateTime($val);
$defaultValue = var_export($defDt->format($fmt), true);
}
} catch (Exception $x) {
// prevent endless loop when timezone is undefined
date_default_timezone_set('America/Los_Angeles');
throw new EngineException(sprintf('Unable to parse default temporal value "%s" for column "%s"', $column->getDefaultValueString(), $column->getFullyQualifiedName()), $x);
}
} elseif ($column->isEnumType()) {
$valueSet = $column->getValueSet();
if (!in_array($val, $valueSet)) {
throw new EngineException(sprintf('Default Value "%s" is not among the enumerated values', $val));
}
$defaultValue = array_search($val, $valueSet);
} elseif ($column->isPhpPrimitiveType()) {
settype($val, $column->getPhpType());
$defaultValue = var_export($val, true);
} elseif ($column->isPhpObjectType()) {
$defaultValue = 'new '.$column->getPhpType().'(' . var_export($val, true) . ')';
} elseif ($column->isPhpArrayType()) {
$defaultValue = var_export($val, true);
} else {
throw new EngineException("Cannot get default value string for " . $column->getFullyQualifiedName());
}
return $defaultValue;
}
/**
* Adds class phpdoc comment and opening of class.
*
* @param string &$script
*/
protected function addClassOpen(&$script)
{
$table = $this->getTable();
$tableName = $table->getName();
$tableDesc = $table->getDescription();
$interface = $this->getInterface();
if (null !== ($parentClass = $this->getBehaviorContent('parentClass')) ||
null !== ($parentClass = ClassTools::classname($this->getBaseClass()))) {
$parentClass = ' extends '.$parentClass;
}
if ($this->getBuildProperty('addClassLevelComment')) {
$script .= "
/**
* Base class that represents a row from the '$tableName' table.
*
* $tableDesc
*";
if ($this->getBuildProperty('addTimeStamp')) {
$now = strftime('%c');
$script .= "
* This class was autogenerated by Propel " . $this->getBuildProperty('version') . " on:
*
* $now
*";
}
$script .= "
* @package propel.generator.".$this->getPackage()."
*/";
}
$script .= "
abstract class ".$this->getUnqualifiedClassName().$parentClass." implements ActiveRecordInterface ";
if ($interface = $this->getInterface()) {
$script .= ", Child" . ClassTools::classname($interface);
if ($interface !== ClassTools::classname($interface)) {
$this->declareClass($interface);
} else {
$this->declareClassFromBuilder($this->getInterfaceBuilder());
}
}
$script .= "
{";
}
/**
* Specifies the methods that are added as part of the basic OM class.
* This can be overridden by subclasses that wish to add more methods.
*
* @param string &$script
* @see ObjectBuilder::addClassBody()
*/
protected function addClassBody(&$script)
{
$this->declareClassFromBuilder($this->getStubObjectBuilder());
$this->declareClassFromBuilder($this->getStubPeerBuilder());
$this->declareClassFromBuilder($this->getStubQueryBuilder());
$this->declareClasses(
'\Exception',
'\PDO',
'\Propel\Runtime\Exception\PropelException',
'\Propel\Runtime\Connection\ConnectionInterface',
'\Propel\Runtime\Collection\Collection',
'\Propel\Runtime\Collection\ObjectCollection',
'\Propel\Runtime\Exception\BadMethodCallException',
'\Propel\Runtime\Exception\PropelException',
'\Propel\Runtime\ActiveQuery\Criteria',
'\Propel\Runtime\ActiveRecord\ActiveRecordInterface',
'\Propel\Runtime\Parser\AbstractParser',
'\Propel\Runtime\Propel',
'\Propel\Runtime\Util\BasePeer'
);
$table = $this->getTable();
if (!$table->isAlias()) {
$this->addConstants($script);
$this->addAttributes($script);
}
if ($table->hasCrossForeignKeys()) {
foreach ($table->getCrossFks() as $fkList) {
list($refFK, $crossFK) = $fkList;
$fkName = $this->getFKPhpNameAffix($crossFK, true);
$this->addScheduledForDeletionAttribute($script, $fkName);
}
}
foreach ($table->getReferrers() as $refFK) {
$fkName = $this->getRefFKPhpNameAffix($refFK, true);
$this->addScheduledForDeletionAttribute($script, $fkName);
}
if ($this->hasDefaultValues()) {
$this->addApplyDefaultValues($script);
}
$this->addConstructor($script);
$this->addBaseObjectMethods($script);
$this->addColumnAccessorMethods($script);
$this->addColumnMutatorMethods($script);
$this->addHasOnlyDefaultValues($script);
$this->addHydrate($script);
$this->addEnsureConsistency($script);
if (!$table->isReadOnly()) {
$this->addManipulationMethods($script);
}
if ($this->isAddGenericAccessors()) {
$this->addGetByName($script);
$this->addGetByPosition($script);
$this->addToArray($script);
}
if ($this->isAddGenericMutators()) {
$this->addSetByName($script);
$this->addSetByPosition($script);
$this->addFromArray($script);
}
$this->addBuildCriteria($script);
$this->addBuildPkeyCriteria($script);
$this->addGetPrimaryKey($script);
$this->addSetPrimaryKey($script);
$this->addIsPrimaryKeyNull($script);
$this->addCopy($script);
if (!$table->isAlias()) {
$this->addGetPeer($script);
}
$this->addFKMethods($script);
$this->addRefFKMethods($script);
$this->addCrossFKMethods($script);
$this->addClear($script);
$this->addClearAllReferences($script);
$this->addPrimaryString($script);
// apply behaviors
$this->applyBehaviorModifier('objectMethods', $script, " ");
if ($this->getGeneratorConfig()->getBuildProperty('addHooks')) {
$this->addHookMethods($script);
}
$this->addMagicCall($script);
}
/**
* Closes class.
*
* @param string &$script
*/
protected function addClassClose(&$script)
{
$script .= "
}
";
$this->applyBehaviorModifier('objectFilter', $script, "");
}
/**
* Adds any constants to the class.
*
* @param string &$script
*/
protected function addConstants(&$script)
{
$script .= "
/**
* Peer class name
*/
const PEER = '" . addslashes($this->getStubPeerBuilder()->getFullyQualifiedClassName()) . "';
";
}
/**
* Adds class attributes.
*
* @param string &$script
*/
protected function addAttributes(&$script)
{
$table = $this->getTable();
$script .= "
/**
* The Peer class.
* Instance provides a convenient way of calling static methods on a class
* that calling code may not be able to identify.
* @var ".$this->getPeerClassName()."
*/
protected static \$peer;
";
$script .= $this->renderTemplate('baseObjectAttributes');
if (!$table->isAlias()) {
$this->addColumnAttributes($script);
}
foreach ($table->getForeignKeys() as $fk) {
$this->addFKAttributes($script, $fk);
}
foreach ($table->getReferrers() as $refFK) {
$this->addRefFKAttributes($script, $refFK);
}
// many-to-many relationships
foreach ($table->getCrossFks() as $fkList) {
$crossFK = $fkList[1];
$this->addCrossFKAttributes($script, $crossFK);
}
$this->addAlreadyInSaveAttribute($script);
// apply behaviors
$this->applyBehaviorModifier('objectAttributes', $script, " ");
}
/**
* Adds variables that store column values.
*
* @param string &$script
*/
protected function addColumnAttributes(&$script)
{
$table = $this->getTable();
foreach ($table->getColumns() as $col) {
$this->addColumnAttributeComment($script, $col);
$this->addColumnAttributeDeclaration($script, $col);
if ($col->isLazyLoad() ) {
$this->addColumnAttributeLoaderComment($script, $col);
$this->addColumnAttributeLoaderDeclaration($script, $col);
}
if ($col->getType() == PropelTypes::OBJECT || $col->getType() == PropelTypes::PHP_ARRAY) {
$this->addColumnAttributeUnserializedComment($script, $col);
$this->addColumnAttributeUnserializedDeclaration($script, $col);
}
}
}
/**
* Adds comment about the attribute (variable) that stores column values.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeComment(&$script, Column $column)
{
$cptype = $column->getPhpType();
$clo = strtolower($column->getName());
$script .= "
/**
* The value for the $clo field.";
if ($column->getDefaultValue()) {
if ($column->getDefaultValue()->isExpression()) {
$script .= "
* Note: this column has a database default value of: (expression) ".$column->getDefaultValue()->getValue();
} else {
$script .= "
* Note: this column has a database default value of: ". $this->getDefaultValueString($column);
}
}
$script .= "
* @var $cptype
*/";
}
/**
* Adds the declaration of a column value storage attribute.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeDeclaration(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
protected \$" . $clo . ";
";
}
/**
* Adds the comment about the attribute keeping track if an attribute value
* has been loaded.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeLoaderComment(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
/**
* Whether the lazy-loaded \$$clo value has been loaded from database.
* This is necessary to avoid repeated lookups if \$$clo column is NULL in the db.
* @var boolean
*/";
}
/**
* Adds the declaration of the attribute keeping track of an attribute
* loaded state.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeLoaderDeclaration(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
protected \$".$clo."_isLoaded = false;
";
}
/**
* Adds the comment about the serialized attribute.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeUnserializedComment(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
/**
* The unserialized \$$clo value - i.e. the persisted object.
* This is necessary to avoid repeated calls to unserialize() at runtime.
* @var object
*/";
}
/**
* Adds the declaration of the serialized attribute.
*
* @param string &$script
* @param Column $column
*/
protected function addColumnAttributeUnserializedDeclaration(&$script, Column $column)
{
$clo = strtolower($column->getName()) . "_unserialized";
$script .= "
protected \$" . $clo . ";
";
}
/**
* Adds the getPeer() method.
*
* This is a convenient, non introspective way of getting the Peer class for
* a particular object.
*
* @param string &$script
*/
protected function addGetPeer(&$script)
{
$this->addGetPeerComment($script);
$this->addGetPeerFunctionOpen($script);
$this->addGetPeerFunctionBody($script);
$this->addGetPeerFunctionClose($script);
}
/**
* Adds the comment for the getPeer method.
*
* @param string &$script
*/
protected function addGetPeerComment(&$script)
{
$script .= "
/**
* Returns a peer instance associated with this om.
*
* Since Peer classes are not to have any instance attributes, this method returns the
* same instance for all member of this class. The method could therefore
* be static, but this would prevent one from overriding the behavior.
*
* @return ".$this->getPeerClassName()."
*/";
}
/**
* Adds the function declaration (function opening) for the getPeer method.
*
* @param string &$script
*/
protected function addGetPeerFunctionOpen(&$script)
{
$script .= "
public function getPeer()
{";
}
/**
* Adds the body of the getPeer method.
*
* @param string &$script
*/
protected function addGetPeerFunctionBody(&$script)
{
$script .= "
if (self::\$peer === null) {
" . $this->buildObjectInstanceCreationCode('self::$peer', $this->getPeerClassName()) . "
}
return self::\$peer;";
}
/**
* Adds the function close for the getPeer method.
*
* Note: this is just a } and the body ends with a return statement, so it's
* quite useless. But it's here anyway for consistency, cause there's a close
* function for all functions and in some other instances, they are useful.
*
* @param string &$script
*/
protected function addGetPeerFunctionClose(&$script)
{
$script .= "
}
";
}
/**
* Adds the constructor for this object.
*
* @param string &$script
*/
protected function addConstructor(&$script)
{
$this->addConstructorComment($script);
$this->addConstructorOpen($script);
if ($this->hasDefaultValues()) {
$this->addConstructorBody($script);
}
$this->addConstructorClose($script);
}
/**
* Adds the comment for the constructor
*
* @param string &$script
*/
protected function addConstructorComment(&$script)
{
$script .= "
/**
* Initializes internal state of ".$this->getQualifiedClassName()." object.";
if ($this->hasDefaultValues()) {
$script .= "
* @see applyDefaults()";
}
$script .= "
*/";
}
/**
* Adds the function declaration for the constructor.
*
* @param string &$script
*/
protected function addConstructorOpen(&$script)
{
$script .= "
public function __construct()
{";
}
/**
* Adds the function body for the constructor.
*
* @param string &$script
*/
protected function addConstructorBody(&$script)
{
$script .= "
\$this->applyDefaultValues();";
}
/**
* Adds the function close for the constructor.
*
* @param string &$script
*/
protected function addConstructorClose(&$script)
{
$script .= "
}
";
}
/**
* Adds the base object functions.
*
* @param string &$script
*/
protected function addBaseObjectMethods(&$script)
{
$script .= $this->renderTemplate('baseObjectMethods', array('className' => $this->getUnqualifiedClassName()));
}
/**
* Adds the base object hook functions.
*
* @param string &$script
*/
protected function addHookMethods(&$script)
{
$hooks = array();
foreach (array('pre', 'post') as $hook) {
foreach (array('Insert', 'Update', 'Save', 'Delete') as $action) {
$hooks[$hook.$action] = false === strpos($script, "function $hook.$action(");
}
}
$script .= $this->renderTemplate('baseObjectMethodHook', $hooks);
}
/**
* Adds the applyDefaults() method, which is called from the constructor.
*
* @param string &$script
*/
protected function addApplyDefaultValues(&$script)
{
$this->addApplyDefaultValuesComment($script);
$this->addApplyDefaultValuesOpen($script);
$this->addApplyDefaultValuesBody($script);
$this->addApplyDefaultValuesClose($script);
}
/**
* Adds the comment for the applyDefaults method.
*
* @param string &$script
*/
protected function addApplyDefaultValuesComment(&$script)
{
$script .= "
/**
* Applies default values to this object.
* This method should be called from the object's constructor (or
* equivalent initialization method).
* @see __construct()
*/";
}
/**
* Adds the function declaration for the applyDefaults method.
*
* @param string &$script
*/
protected function addApplyDefaultValuesOpen(&$script)
{
$script .= "
public function applyDefaultValues()
{";
}
/**
* Adds the function body of the applyDefault method.
*
* @param string &$script
*/
protected function addApplyDefaultValuesBody(&$script)
{
$table = $this->getTable();
// FIXME - Apply support for PHP default expressions here
// see: http://propel.phpdb.org/trac/ticket/378
$colsWithDefaults = array();
foreach ($table->getColumns() as $column) {
$def = $column->getDefaultValue();
if ($def !== null && !$def->isExpression()) {
$colsWithDefaults[] = $column;
}
}
foreach ($colsWithDefaults as $column) {
$clo = strtolower($column->getName());
$defaultValue = $this->getDefaultValueString($column);
if ($column->isTemporalType()) {
$dateTimeClass = $this->getBuildProperty('dateTimeClass');
if (!$dateTimeClass) {
$dateTimeClass = '\DateTime';
}
$script .= "
\$this->".$clo." = PropelDateTime::newInstance($defaultValue, null, '$dateTimeClass');";
} else {
$script .= "
\$this->".$clo." = $defaultValue;";
}
}
}
/**
* Adds the function close for the applyDefaults method.
*
* @param string &$script
*/
protected function addApplyDefaultValuesClose(&$script)
{
$script .= "
}
";
}
/**
* Adds a date/time/timestamp getter method.
*
* @param string &$script
* @param Column $col
*/
protected function addTemporalAccessor(&$script, Column $column)
{
$this->addTemporalAccessorComment($script, $column);
$this->addTemporalAccessorOpen($script, $column);
$this->addTemporalAccessorBody($script, $column);
$this->addTemporalAccessorClose($script);
}
/**
* Adds the comment for a temporal accessor.
*
* @param string &$script
* @param Column $column
*/
public function addTemporalAccessorComment(&$script, Column $column)
{
$clo = strtolower($column->getName());
$dateTimeClass = $this->getBuildProperty('dateTimeClass');
if (!$dateTimeClass) {
$dateTimeClass = '\DateTime';
}
$handleMysqlDate = false;
if ($this->getPlatform() instanceof MysqlPlatform) {
if ($column->getType() === PropelTypes::TIMESTAMP) {
$handleMysqlDate = true;
$mysqlInvalidDateString = '0000-00-00 00:00:00';
} elseif ($column->getType() === PropelTypes::DATE) {
$handleMysqlDate = true;
$mysqlInvalidDateString = '0000-00-00';
}
// 00:00:00 is a valid time, so no need to check for that.
}
$script .= "
/**
* Get the [optionally formatted] temporal [$clo] column value.
* {$column->getDescription()}
*
* @param string \$format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw \DateTime object will be returned.
*
* @return mixed Formatted date/time value as string or $dateTimeClass object (if format is NULL), NULL if column is NULL" .($handleMysqlDate ? ', and 0 if column value is ' . $mysqlInvalidDateString : '')."
*
* @throws PropelException - if unable to parse/validate the date/time value.
*/";
}
/**
* Adds the function declaration for a temporal accessor.
*
* @param string &$script
* @param Column $column
*/
public function addTemporalAccessorOpen(&$script, Column $column)
{
$cfc = $column->getPhpName();
$defaultfmt = null;
$visibility = $column->getAccessorVisibility();
// Default date/time formatter strings are specified in build.properties
if ($column->getType() === PropelTypes::DATE) {
$defaultfmt = $this->getBuildProperty('defaultDateFormat');
} elseif ($column->getType() === PropelTypes::TIME) {
$defaultfmt = $this->getBuildProperty('defaultTimeFormat');
} elseif ($column->getType() === PropelTypes::TIMESTAMP) {
$defaultfmt = $this->getBuildProperty('defaultTimeStampFormat');
}
if (empty($defaultfmt)) { $defaultfmt = null; }
$script .= "
".$visibility." function get$cfc(\$format = ".var_export($defaultfmt, true)."";
if ($column->isLazyLoad()) {
$script .= ", \$con = null";
}
$script .= ")
{";
}
/**
* Gets accessor lazy loaded snippets.
*
* @param Column $column
*/
protected function getAccessorLazyLoadSnippet(Column $column)
{
if ($column->isLazyLoad()) {
$clo = strtolower($column->getName());
$defaultValueString = 'null';
$def = $column->getDefaultValue();
if ($def !== null && !$def->isExpression()) {
$defaultValueString = $this->getDefaultValueString($column);
}
return "
if (!\$this->{$clo}_isLoaded && \$this->{$clo} === {$defaultValueString} && !\$this->isNew()) {
\$this->load{$column->getPhpName()}(\$con);
}
";
}
}
/**
* Adds the body of the temporal accessor.
*
* @param string &$script
* @param Column $column
*/
protected function addTemporalAccessorBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
$dateTimeClass = $this->getBuildProperty('dateTimeClass');
if (!$dateTimeClass) {
$dateTimeClass = '\DateTime';
}
$this->declareClasses($dateTimeClass);
$defaultfmt = null;
// Default date/time formatter strings are specified in build.properties
if ($column->getType() === PropelTypes::DATE) {
$defaultfmt = $this->getBuildProperty('defaultDateFormat');
} elseif ($column->getType() === PropelTypes::TIME) {
$defaultfmt = $this->getBuildProperty('defaultTimeFormat');
} elseif ($column->getType() === PropelTypes::TIMESTAMP) {
$defaultfmt = $this->getBuildProperty('defaultTimeStampFormat');
}
if (empty($defaultfmt)) { $defaultfmt = null; }
if ($column->isLazyLoad()) {
$script .= $this->getAccessorLazyLoadSnippet($column);
}
$script .= "
if (\$format === null) {
return \$this->$clo;
} else {
return \$this->$clo !== null ? \$this->{$clo}->format(\$format) : null;
}";
}
/**
* Adds the body of the temporal accessor.
*
* @param string &$script
*/
protected function addTemporalAccessorClose(&$script)
{
$script .= "
}
";
}
/**
* Adds an object getter method.
*
* @param string &$script
* @param Column $column
*/
protected function addObjectAccessor(&$script, Column $column)
{
$this->addDefaultAccessorComment($script, $column);
$this->addDefaultAccessorOpen($script, $column);
$this->addObjectAccessorBody($script, $column);
$this->addDefaultAccessorClose($script);
}
/**
* Adds the function body for an object accessor method.
*
* @param string &$script
* @param Column $column
*/
protected function addObjectAccessorBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
$cloUnserialized = $clo.'_unserialized';
if ($column->isLazyLoad()) {
$script .= $this->getAccessorLazyLoadSnippet($column);
}
$script .= "
if (null == \$this->$cloUnserialized && null !== \$this->$clo) {
\$this->$cloUnserialized = unserialize(\$this->$clo);
}
return \$this->$cloUnserialized;";
}
/**
* Adds an array getter method.
*
* @param string &$script
* @param Column $column
*/
protected function addArrayAccessor(&$script, Column $column)
{
$this->addDefaultAccessorComment($script, $column);
$this->addDefaultAccessorOpen($script, $column);
$this->addArrayAccessorBody($script, $column);
$this->addDefaultAccessorClose($script);
}
/**
* Adds the function body for an array accessor method.
*
* @param string &$script
* @param Column $column
*/
protected function addArrayAccessorBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
$cloUnserialized = $clo.'_unserialized';
if ($column->isLazyLoad()) {
$script .= $this->getAccessorLazyLoadSnippet($column);
}
$script .= "
if (null === \$this->$cloUnserialized) {
\$this->$cloUnserialized = array();
}
if (!\$this->$cloUnserialized && null !== \$this->$clo) {
\$$cloUnserialized = substr(\$this->$clo, 2, -2);
\$this->$cloUnserialized = \$$cloUnserialized ? explode(' | ', \$$cloUnserialized) : array();
}
return \$this->$cloUnserialized;";
}
/**
* Adds an enum getter method.
*
* @param string &$script
* @param Column $column
*/
protected function addEnumAccessor(&$script, Column $column)
{
$this->addDefaultAccessorComment($script, $column);
$this->addDefaultAccessorOpen($script, $column);
$this->addEnumAccessorBody($script, $column);
$this->addDefaultAccessorClose($script);
}
/**
* Adds the function body for an enum accessor method.
*
* @param string &$script
* @param Column $column
*/
protected function addEnumAccessorBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
if ($column->isLazyLoad()) {
$script .= $this->getAccessorLazyLoadSnippet($column);
}
$script .= "
if (null === \$this->$clo) {
return null;
}
\$valueSet = " . $this->getPeerClassName() . "::getValueSet(" . $this->getColumnConstant($column) . ");
if (!isset(\$valueSet[\$this->$clo])) {
throw new PropelException('Unknown stored enum key: ' . \$this->$clo);
}
return \$valueSet[\$this->$clo];";
}
/**
* Adds a tester method for an array column.
*
* @param string &$script
* @param Column $column
*/
protected function addHasArrayElement(&$script, Column $column)
{
$clo = strtolower($column->getName());
$cfc = $column->getPhpName();
$visibility = $column->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Test the presence of a value in the [$clo] array column value.
* @param mixed \$value
* ".$column->getDescription();
if ($column->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return boolean
*/
$visibility function has$singularPhpName(\$value";
if ($column->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
$script .= ")
{
return in_array(\$value, \$this->get$cfc(";
if ($column->isLazyLoad()) {
$script .= "\$con";
}
$script .= "));
} // has$singularPhpName()
";
}
/**
* Adds a normal (non-temporal) getter method.
*
* @param string &$script
* @param Column $column
*/
protected function addDefaultAccessor(&$script, Column $column)
{
$this->addDefaultAccessorComment($script, $column);
$this->addDefaultAccessorOpen($script, $column);
$this->addDefaultAccessorBody($script, $column);
$this->addDefaultAccessorClose($script);
}
/**
* Add the comment for a default accessor method (a getter).
*
* @param string &$script
* @param Column $column
*/
public function addDefaultAccessorComment(&$script, Column $column)
{
$clo=strtolower($column->getName());
$script .= "
/**
* Get the [$clo] column value.
* ".$column->getDescription();
if ($column->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return ".$column->getPhpType()."
*/";
}
/**
* Adds the function declaration for a default accessor.
*
* @param string &$script
* @param Column $column
*/
public function addDefaultAccessorOpen(&$script, Column $column)
{
$cfc = $column->getPhpName();
$visibility = $column->getAccessorVisibility();
$script .= "
".$visibility." function get$cfc(";
if ($column->isLazyLoad()) {
$script .= "ConnectionInterface \$con = null";
}
$script .= ")
{";
}
/**
* Adds the function body for a default accessor method.
*
* @param string &$script
* @param Column $column
*/
protected function addDefaultAccessorBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
if ($column->isLazyLoad()) {
$script .= $this->getAccessorLazyLoadSnippet($column);
}
$script .= "
return \$this->$clo;";
}
/**
* Adds the function close for a default accessor method.
*
* @param string &$script
*/
protected function addDefaultAccessorClose(&$script)
{
$script .= "
}
";
}
/**
* Adds the lazy loader method.
*
* @param string &$script
* @param Column $column
*/
protected function addLazyLoader(&$script, Column $column)
{
$this->addLazyLoaderComment($script, $column);
$this->addLazyLoaderOpen($script, $column);
$this->addLazyLoaderBody($script, $column);
$this->addLazyLoaderClose($script);
}
/**
* Adds the comment for the lazy loader method.
*
* @param string &$script
* @param Column $column
*/
protected function addLazyLoaderComment(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
/**
* Load the value for the lazy-loaded [$clo] column.
*
* This method performs an additional query to return the value for
* the [$clo] column, since it is not populated by
* the hydrate() method.
*
* @param \$con ConnectionInterface (optional) The ConnectionInterface connection to use.
* @return void
* @throws PropelException - any underlying error will be wrapped and re-thrown.
*/";
}
/**
* Adds the function declaration for the lazy loader method.
*
* @param string &$script
* @param Column $column
*/
protected function addLazyLoaderOpen(&$script, Column $column)
{
$cfc = $column->getPhpName();
$script .= "
protected function load$cfc(ConnectionInterface \$con = null)
{";
}
/**
* Adds the function body for the lazy loader method.
*
* @param string &$script
* @param Column $column
*/
protected function addLazyLoaderBody(&$script, Column $column)
{
$platform = $this->getPlatform();
$clo = strtolower($column->getName());
// pdo_sqlsrv driver requires the use of PDOStatement::bindColumn() or a hex string will be returned
if ($column->getType() === PropelTypes::BLOB && $platform instanceof SqlsrvPlatform) {
$script .= "
\$c = \$this->buildPkeyCriteria();
\$c->addSelectColumn(".$this->getColumnConstant($column).");
try {
\$row = array(0 => null);
\$stmt = ".$this->getPeerClassName()."::doSelectStmt(\$c, \$con);
\$stmt->bindColumn(1, \$row[0], PDO::PARAM_LOB, 0, PDO::SQLSRV_ENCODING_BINARY);
\$stmt->fetch(PDO::FETCH_BOUND);
\$stmt->closeCursor();";
} else {
$script .= "
\$c = \$this->buildPkeyCriteria();
\$c->addSelectColumn(".$this->getColumnConstant($column).");
try {
\$stmt = ".$this->getPeerClassName()."::doSelectStmt(\$c, \$con);
\$row = \$stmt->fetch(PDO::FETCH_NUM);
\$stmt->closeCursor();";
}
if ($column->getType() === PropelTypes::CLOB && $platform instanceof OraclePlatform) {
// PDO_OCI returns a stream for CLOB objects, while other PDO adapters return a string...
$script .= "
\$this->$clo = stream_get_contents(\$row[0]);";
} elseif ($column->isLobType() && !$platform->hasStreamBlobImpl()) {
$script .= "
if (\$row[0] !== null) {
\$this->$clo = fopen('php://memory', 'r+');
fwrite(\$this->$clo, \$row[0]);
rewind(\$this->$clo);
} else {
\$this->$clo = null;
}";
} elseif ($column->isPhpPrimitiveType()) {
$script .= "
\$this->$clo = (\$row[0] !== null) ? (".$column->getPhpType().") \$row[0] : null;";
} elseif ($column->isPhpObjectType()) {
$script .= "
\$this->$clo = (\$row[0] !== null) ? new ".$column->getPhpType()."(\$row[0]) : null;";
} else {
$script .= "
\$this->$clo = \$row[0];";
}
$script .= "
\$this->".$clo."_isLoaded = true;
} catch (Exception \$e) {
throw new PropelException(\"Error loading value for [$clo] column on demand.\", 0, \$e);
}";
}
/**
* Adds the function close for the lazy loader.
*
* @param string &$script
*/
protected function addLazyLoaderClose(&$script)
{
$script .= "
}";
}
/**
* Adds the open of the mutator (setter) method for a column.
*
* @param string &$script
* @param Column $column
*/
protected function addMutatorOpen(&$script, Column $column)
{
$this->addMutatorComment($script, $column);
$this->addMutatorOpenOpen($script, $column);
$this->addMutatorOpenBody($script, $column);
}
/**
* Adds the comment for a mutator.
*
* @param string &$script
* @param Column $column
*/
public function addMutatorComment(&$script, Column $column)
{
$clo = strtolower($column->getName());
$script .= "
/**
* Set the value of [$clo] column.
* ".$column->getDescription()."
* @param ".$column->getPhpType()." \$v new value
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/";
}
/**
* Adds the mutator function declaration.
*
* @param string &$script
* @param Column $column
*/
public function addMutatorOpenOpen(&$script, Column $column)
{
$cfc = $column->getPhpName();
$visibility = $column->getMutatorVisibility();
$script .= "
".$visibility." function set$cfc(\$v)
{";
}
/**
* Adds the mutator open body part.
*
* @param string &$script
* @param Column $column
*/
protected function addMutatorOpenBody(&$script, Column $column)
{
$clo = strtolower($column->getName());
$cfc = $column->getPhpName();
if ($column->isLazyLoad()) {
$script .= "
// explicitly set the is-loaded flag to true for this lazy load col;
// it doesn't matter if the value is actually set or not (logic below) as
// any attempt to set the value means that no db lookup should be performed
// when the get$cfc() method is called.
\$this->".$clo."_isLoaded = true;
";
}
}
/**
* Adds the close of the mutator (setter) method for a column.
*
* @param string &$script
* @param Column $column
*/
protected function addMutatorClose(&$script, Column $column)
{
$this->addMutatorCloseBody($script, $column);
$this->addMutatorCloseClose($script, $column);
}
/**
* Adds the body of the close part of a mutator.
*
* @param string &$script
* @param Column $column
*/
protected function addMutatorCloseBody(&$script, Column $column)
{
$table = $this->getTable();
if ($column->isForeignKey()) {
foreach ($column->getForeignKeys() as $fk) {
$tblFK = $table->getDatabase()->getTable($fk->getForeignTableName());
$colFK = $tblFK->getColumn($fk->getMappedForeignColumn($column->getName()));
$varName = $this->getFKVarName($fk);
$script .= "
if (\$this->$varName !== null && \$this->".$varName."->get".$colFK->getPhpName()."() !== \$v) {
\$this->$varName = null;
}
";
} // foreach fk
} /* if col is foreign key */
foreach ($column->getReferrers() as $refFK) {
$tblFK = $this->getDatabase()->getTable($refFK->getForeignTableName());
if ( $tblFK->getName() != $table->getName() ) {
foreach ($column->getForeignKeys() as $fk) {
$tblFK = $table->getDatabase()->getTable($fk->getForeignTableName());
$colFK = $tblFK->getColumn($fk->getMappedForeignColumn($column->getName()));
if ($refFK->isLocalPrimaryKey()) {
$varName = $this->getPKRefFKVarName($refFK);
$script .= "
// update associated ".$tblFK->getPhpName()."
if (\$this->$varName !== null) {
\$this->{$varName}->set".$colFK->getPhpName()."(\$v);
}
";
} else {
$collName = $this->getRefFKCollVarName($refFK);
$script .= "
// update associated ".$tblFK->getPhpName()."
if (\$this->$collName !== null) {
foreach (\$this->$collName as \$referrerObject) {
\$referrerObject->set".$colFK->getPhpName()."(\$v);
}
}
";
} // if (isLocalPrimaryKey
} // foreach col->getPrimaryKeys()
} // if tablFk != table
} // foreach
}
/**
* Adds the close for the mutator close
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see addMutatorClose()
**/
protected function addMutatorCloseClose(&$script, Column $col)
{
$cfc = $col->getPhpName();
$script .= "
return \$this;
} // set$cfc()
";
}
/**
* Adds a setter for BLOB columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addLobMutator(&$script, Column $col)
{
$this->addMutatorOpen($script, $col);
$clo = strtolower($col->getName());
$script .= "
// Because BLOB columns are streams in PDO we have to assume that they are
// always modified when a new value is passed in. For example, the contents
// of the stream itself may have changed externally.
if (!is_resource(\$v) && \$v !== null) {
\$this->$clo = fopen('php://memory', 'r+');
fwrite(\$this->$clo, \$v);
rewind(\$this->$clo);
} else { // it's already a stream
\$this->$clo = \$v;
}
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
";
$this->addMutatorClose($script, $col);
} // addLobMutatorSnippet
/**
* Adds a setter method for date/time/timestamp columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addTemporalMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$dateTimeClass = $this->getBuildProperty('dateTimeClass');
if (!$dateTimeClass) {
$dateTimeClass = '\DateTime';
}
$this->declareClasses($dateTimeClass, '\Propel\Runtime\Util\PropelDateTime');
$this->addTemporalMutatorComment($script, $col);
$this->addMutatorOpenOpen($script, $col);
$this->addMutatorOpenBody($script, $col);
$fmt = var_export($this->getTemporalFormatter($col), true);
$script .= "
\$dt = PropelDateTime::newInstance(\$v, null, '$dateTimeClass');
if (\$this->$clo !== null || \$dt !== null) {";
if (($def = $col->getDefaultValue()) !== null && !$def->isExpression()) {
$defaultValue = $this->getDefaultValueString($col);
$script .= "
if ( (\$dt != \$this->{$clo}) // normalized values don't match
|| (\$dt->format($fmt) === $defaultValue) // or the entered value matches the default
) {";
} else {
$script .= "
if (\$dt !== \$this->{$clo}) {";
}
$script .= "
\$this->$clo = \$dt;
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
} // if either are not null
";
$this->addMutatorClose($script, $col);
}
public function addTemporalMutatorComment(&$script, Column $col)
{
$clo = strtolower($col->getName());
$script .= "
/**
* Sets the value of [$clo] column to a normalized version of the date/time value specified.
* ".$col->getDescription()."
* @param mixed \$v string, integer (timestamp), or \DateTime value.
* Empty strings are treated as NULL.
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/";
}
/**
* Adds a setter for Object columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addObjectMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$cloUnserialized = $clo.'_unserialized';
$this->addMutatorOpen($script, $col);
$script .= "
if (\$this->$cloUnserialized !== \$v) {
\$this->$cloUnserialized = \$v;
\$this->$clo = serialize(\$v);
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
";
$this->addMutatorClose($script, $col);
}
/**
* Adds a setter for Array columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addArrayMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$cloUnserialized = $clo.'_unserialized';
$this->addMutatorOpen($script, $col);
$script .= "
if (\$this->$cloUnserialized !== \$v) {
\$this->$cloUnserialized = \$v;
\$this->$clo = '| ' . implode(' | ', \$v) . ' |';
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
";
$this->addMutatorClose($script, $col);
}
/**
* Adds a push method for an array column.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
*/
protected function addAddArrayElement(&$script, Column $col)
{
$clo = strtolower($col->getName());
$cfc = $col->getPhpName();
$visibility = $col->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Adds a value to the [$clo] array column value.
* @param mixed \$value
* ".$col->getDescription();
if ($col->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/
$visibility function add$singularPhpName(\$value";
if ($col->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
$script .= ")
{
\$currentArray = \$this->get$cfc(";
if ($col->isLazyLoad()) {
$script .= "\$con";
}
$script .= ");
\$currentArray []= \$value;
\$this->set$cfc(\$currentArray);
return \$this;
} // add$singularPhpName()
";
}
/**
* Adds a remove method for an array column.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
*/
protected function addRemoveArrayElement(&$script, Column $col)
{
$clo = strtolower($col->getName());
$cfc = $col->getPhpName();
$visibility = $col->getAccessorVisibility();
$singularPhpName = rtrim($cfc, 's');
$script .= "
/**
* Removes a value from the [$clo] array column value.
* @param mixed \$value
* ".$col->getDescription();
if ($col->isLazyLoad()) {
$script .= "
* @param ConnectionInterface An optional ConnectionInterface connection to use for fetching this lazy-loaded column.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/
$visibility function remove$singularPhpName(\$value";
if ($col->isLazyLoad()) {
$script .= ", ConnectionInterface \$con = null";
}
// we want to reindex the array, so array_ functions are not the best choice
$script .= ")
{
\$targetArray = array();
foreach (\$this->get$cfc(";
if ($col->isLazyLoad()) {
$script .= "\$con";
}
$script .= ") as \$element) {
if (\$element != \$value) {
\$targetArray []= \$element;
}
}
\$this->set$cfc(\$targetArray);
return \$this;
} // remove$singularPhpName()
";
}
/**
* Adds a setter for Enum columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addEnumMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$this->addMutatorOpen($script, $col);
$script .= "
if (\$v !== null) {
\$valueSet = " . $this->getPeerClassName() . "::getValueSet(" . $this->getColumnConstant($col) . ");
if (!in_array(\$v, \$valueSet)) {
throw new PropelException(sprintf('Value \"%s\" is not accepted in this enumerated column', \$v));
}
\$v = array_search(\$v, \$valueSet);
}
if (\$this->$clo !== \$v) {
\$this->$clo = \$v;
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
";
$this->addMutatorClose($script, $col);
}
/**
* Adds setter method for boolean columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addBooleanMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$this->addBooleanMutatorComment($script, $col);
$this->addMutatorOpenOpen($script, $col);
$this->addMutatorOpenBody($script, $col);
$script .= "
if (\$v !== null) {
if (is_string(\$v)) {
\$v = in_array(strtolower(\$v), array('false', 'off', '-', 'no', 'n', '0', '')) ? false : true;
} else {
\$v = (boolean) \$v;
}
}
if (\$this->$clo !== \$v) {
\$this->$clo = \$v;
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
";
$this->addMutatorClose($script, $col);
}
public function addBooleanMutatorComment(&$script, Column $col)
{
$clo = strtolower($col->getName());
$script .= "
/**
* Sets the value of the [$clo] column.
* Non-boolean arguments are converted using the following rules:
* * 1, '1', 'true', 'on', and 'yes' are converted to boolean true
* * 0, '0', 'false', 'off', and 'no' are converted to boolean false
* Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
* ".$col->getDescription()."
* @param boolean|integer|string \$v The new value
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
*/";
}
/**
* Adds setter method for "normal" columns.
* @param string &$script The script will be modified in this method.
* @param Column $col The current column.
* @see parent::addColumnMutators()
*/
protected function addDefaultMutator(&$script, Column $col)
{
$clo = strtolower($col->getName());
$this->addMutatorOpen($script, $col);
// Perform type-casting to ensure that we can use type-sensitive
// checking in mutators.
if ($col->isPhpPrimitiveType()) {
$script .= "
if (\$v !== null) {
\$v = (".$col->getPhpType().") \$v;
}
";
}
$script .= "
if (\$this->$clo !== \$v) {
\$this->$clo = \$v;
\$this->modifiedColumns[] = ".$this->getColumnConstant($col).";
}
";
$this->addMutatorClose($script, $col);
}
/**
* Adds the hasOnlyDefaultValues() method.
* @param string &$script The script will be modified in this method.
*/
protected function addHasOnlyDefaultValues(&$script)
{
$this->addHasOnlyDefaultValuesComment($script);
$this->addHasOnlyDefaultValuesOpen($script);
$this->addHasOnlyDefaultValuesBody($script);
$this->addHasOnlyDefaultValuesClose($script);
}
/**
* Adds the comment for the hasOnlyDefaultValues method
* @param string &$script The script will be modified in this method.
* @see addHasOnlyDefaultValues
**/
protected function addHasOnlyDefaultValuesComment(&$script)
{
$script .= "
/**
* Indicates whether the columns in this object are only set to default values.
*
* This method can be used in conjunction with isModified() to indicate whether an object is both
* modified _and_ has some values set which are non-default.
*
* @return boolean Whether the columns in this object are only been set with default values.
*/";
}
/**
* Adds the function declaration for the hasOnlyDefaultValues method
* @param string &$script The script will be modified in this method.
* @see addHasOnlyDefaultValues
**/
protected function addHasOnlyDefaultValuesOpen(&$script)
{
$script .= "
public function hasOnlyDefaultValues()
{";
}
/**
* Adds the function body for the hasOnlyDefaultValues method
* @param string &$script The script will be modified in this method.
* @see addHasOnlyDefaultValues
**/
protected function addHasOnlyDefaultValuesBody(&$script)
{
$table = $this->getTable();
$colsWithDefaults = array();
foreach ($table->getColumns() as $col) {
$def = $col->getDefaultValue();
if ($def !== null && !$def->isExpression()) {
$colsWithDefaults[] = $col;
}
}
foreach ($colsWithDefaults as $col) {
$clo = strtolower($col->getName());
$accessor = "\$this->$clo";
if ($col->isTemporalType()) {
$fmt = $this->getTemporalFormatter($col);
$accessor = "\$this->$clo && \$this->{$clo}->format('$fmt')";
}
$script .= "
if ($accessor !== " . $this->getDefaultValueString($col).") {
return false;
}
";
}
}
/**
* Adds the function close for the hasOnlyDefaultValues method
* @param string &$script The script will be modified in this method.
* @see addHasOnlyDefaultValues
**/
protected function addHasOnlyDefaultValuesClose(&$script)
{
$script .= "
// otherwise, everything was equal, so return TRUE
return true;";
$script .= "
} // hasOnlyDefaultValues()
";
}
/**
* Adds the hydrate() method, which sets attributes of the object based on a ResultSet.
* @param string &$script The script will be modified in this method.
*/
protected function addHydrate(&$script)
{
$this->addHydrateComment($script);
$this->addHydrateOpen($script);
$this->addHydrateBody($script);
$this->addHydrateClose($script);
}
/**
* Adds the comment for the hydrate method
* @param string &$script The script will be modified in this method.
* @see addHydrate()
*/
protected function addHydrateComment(&$script)
{
$script .= "
/**
* Hydrates (populates) the object variables with values from the database resultset.
*
* An offset (0-based \"start column\") is specified so that objects can be hydrated
* with a subset of the columns in the resultset rows. This is needed, for example,
* for results of JOIN queries where the resultset row includes columns from two or
* more tables.
*
* @param array \$row The row returned by Statement->fetch(PDO::FETCH_NUM)
* @param int \$startcol 0-based offset column which indicates which restultset column to start with.
* @param boolean \$rehydrate Whether this object is being re-hydrated from the database.
* @return int next starting column
* @throws PropelException - Any caught Exception will be rewrapped as a PropelException.
*/";
}
/**
* Adds the function declaration for the hydrate method
* @param string &$script The script will be modified in this method.
* @see addHydrate()
*/
protected function addHydrateOpen(&$script)
{
$script .= "
public function hydrate(\$row, \$startcol = 0, \$rehydrate = false)
{";
}
/**
* Adds the function body for the hydrate method
* @param string &$script The script will be modified in this method.
* @see addHydrate()
*/
protected function addHydrateBody(&$script)
{
$table = $this->getTable();
$platform = $this->getPlatform();
$script .= "
try {
";
$n = 0;
foreach ($table->getColumns() as $col) {
if (!$col->isLazyLoad()) {
$clo = strtolower($col->getName());
if ($col->getType() === PropelTypes::CLOB_EMU && $this->getPlatform() instanceof OraclePlatform) {
// PDO_OCI returns a stream for CLOB objects, while other PDO adapters return a string...
$script .= "
\$this->$clo = stream_get_contents(\$row[\$startcol + $n]);";
} elseif ($col->isLobType() && !$platform->hasStreamBlobImpl()) {
$script .= "
if (\$row[\$startcol + $n] !== null) {
\$this->$clo = fopen('php://memory', 'r+');
fwrite(\$this->$clo, \$row[\$startcol + $n]);
rewind(\$this->$clo);
} else {
\$this->$clo = null;
}";
} elseif ($col->isTemporalType()) {
$dateTimeClass = $this->getBuildProperty('dateTimeClass');
if (!$dateTimeClass) {
$dateTimeClass = '\DateTime';
}
$handleMysqlDate = false;
if ($this->getPlatform() instanceof MysqlPlatform) {
if ($col->getType() === PropelTypes::TIMESTAMP) {
$handleMysqlDate = true;
$mysqlInvalidDateString = '0000-00-00 00:00:00';
} elseif ($col->getType() === PropelTypes::DATE) {
$handleMysqlDate = true;
$mysqlInvalidDateString = '0000-00-00';
}
// 00:00:00 is a valid time, so no need to check for that.
}
if ($handleMysqlDate) {
$script .= "
if (\$row[\$startcol + $n] === '$mysqlInvalidDateString') {
\$row[\$startcol + $n] = null;
}";
}
$script .= "
\$this->$clo = (\$row[\$startcol + $n] !== null) ? PropelDateTime::newInstance(\$row[\$startcol + $n], null, '$dateTimeClass') : null;";
} elseif ($col->isPhpPrimitiveType()) {
$script .= "
\$this->$clo = (\$row[\$startcol + $n] !== null) ? (".$col->getPhpType().") \$row[\$startcol + $n] : null;";
} elseif ($col->getType() === PropelTypes::OBJECT) {
$script .= "
\$this->$clo = \$row[\$startcol + $n];";
} elseif ($col->getType() === PropelTypes::PHP_ARRAY) {
$cloUnserialized = $clo . '_unserialized';
$script .= "
\$this->$clo = \$row[\$startcol + $n];
\$this->$cloUnserialized = null;";
} elseif ($col->isPhpObjectType()) {
$script .= "
\$this->$clo = (\$row[\$startcol + $n] !== null) ? new ".$col->getPhpType()."(\$row[\$startcol + $n]) : null;";
} else {
$script .= "
\$this->$clo = \$row[\$startcol + $n];";
}
$n++;
} // if col->isLazyLoad()
} /* foreach */
if ($this->getBuildProperty("addSaveMethod")) {
$script .= "
\$this->resetModified();
";
}
$script .= "
\$this->setNew(false);
if (\$rehydrate) {
\$this->ensureConsistency();
}
return \$startcol + $n; // $n = ".$this->getPeerClassName()."::NUM_HYDRATE_COLUMNS.
} catch (Exception \$e) {
throw new PropelException(\"Error populating ".$this->getStubObjectBuilder()->getClassName()." object\", 0, \$e);
}";
}
/**
* Adds the function close for the hydrate method
* @param string &$script The script will be modified in this method.
* @see addHydrate()
*/
protected function addHydrateClose(&$script)
{
$script .= "
}
";
}
/**
* Adds the buildPkeyCriteria method
* @param string &$script The script will be modified in this method.
**/
protected function addBuildPkeyCriteria(&$script)
{
$this->addBuildPkeyCriteriaComment($script);
$this->addBuildPkeyCriteriaOpen($script);
$this->addBuildPkeyCriteriaBody($script);
$this->addBuildPkeyCriteriaClose($script);
}
/**
* Adds the comment for the buildPkeyCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildPkeyCriteria()
**/
protected function addBuildPkeyCriteriaComment(&$script)
{
$script .= "
/**
* Builds a Criteria object containing the primary key for this object.
*
* Unlike buildCriteria() this method includes the primary key values regardless
* of whether or not they have been modified.
*
* @return Criteria The Criteria object containing value(s) for primary key(s).
*/";
}
/**
* Adds the function declaration for the buildPkeyCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildPkeyCriteria()
**/
protected function addBuildPkeyCriteriaOpen(&$script)
{
$script .= "
public function buildPkeyCriteria()
{";
}
/**
* Adds the function body for the buildPkeyCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildPkeyCriteria()
**/
protected function addBuildPkeyCriteriaBody(&$script)
{
$script .= "
\$criteria = new Criteria(".$this->getPeerClassName()."::DATABASE_NAME);";
foreach ($this->getTable()->getPrimaryKey() as $col) {
$clo = strtolower($col->getName());
$script .= "
\$criteria->add(".$this->getColumnConstant($col).", \$this->$clo);";
}
}
/**
* Adds the function close for the buildPkeyCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildPkeyCriteria()
**/
protected function addBuildPkeyCriteriaClose(&$script)
{
$script .= "
return \$criteria;
}
";
}
/**
* Adds the buildCriteria method
* @param string &$script The script will be modified in this method.
**/
protected function addBuildCriteria(&$script)
{
$this->addBuildCriteriaComment($script);
$this->addBuildCriteriaOpen($script);
$this->addBuildCriteriaBody($script);
$this->addBuildCriteriaClose($script);
}
/**
* Adds comment for the buildCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildCriteria()
**/
protected function addBuildCriteriaComment(&$script)
{
$script .= "
/**
* Build a Criteria object containing the values of all modified columns in this object.
*
* @return Criteria The Criteria object containing all modified values.
*/";
}
/**
* Adds the function declaration of the buildCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildCriteria()
**/
protected function addBuildCriteriaOpen(&$script)
{
$script .= "
public function buildCriteria()
{";
}
/**
* Adds the function body of the buildCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildCriteria()
**/
protected function addBuildCriteriaBody(&$script)
{
$script .= "
\$criteria = new Criteria(".$this->getPeerClassName()."::DATABASE_NAME);
";
foreach ($this->getTable()->getColumns() as $col) {
$clo = strtolower($col->getName());
$script .= "
if (\$this->isColumnModified(".$this->getColumnConstant($col).")) \$criteria->add(".$this->getColumnConstant($col).", \$this->$clo);";
}
}
/**
* Adds the function close of the buildCriteria method
* @param string &$script The script will be modified in this method.
* @see addBuildCriteria()
**/
protected function addBuildCriteriaClose(&$script)
{
$script .= "
return \$criteria;
}
";
}
/**
* Adds the toArray method
* @param string &$script The script will be modified in this method.
**/
protected function addToArray(&$script)
{
$fks = $this->getTable()->getForeignKeys();
$referrers = $this->getTable()->getReferrers();
$hasFks = count($fks) > 0 || count($referrers) > 0;
$objectClassName = $this->getUnqualifiedClassName();
$pkGetter = $this->getTable()->hasCompositePrimaryKey() ? 'serialize($this->getPrimaryKey())' : '$this->getPrimaryKey()';
$defaultKeyType = $this->getDefaultKeyType();
$script .= "
/**
* Exports the object as an array.
*
* You can specify the key type of the array by passing one of the class
* type constants.
*
* @param string \$keyType (optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME,
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::$defaultKeyType.
* @param boolean \$includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE.
* @param array \$alreadyDumpedObjects List of objects to skip to avoid recursion";
if ($hasFks) {
$script .= "
* @param boolean \$includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE.";
}
$script .= "
*
* @return array an associative array containing the field names (as keys) and field values
*/
public function toArray(\$keyType = BasePeer::$defaultKeyType, \$includeLazyLoadColumns = true, \$alreadyDumpedObjects = array()" . ($hasFks ? ", \$includeForeignObjects = false" : '') . ")
{
if (isset(\$alreadyDumpedObjects['$objectClassName'][$pkGetter])) {
return '*RECURSION*';
}
\$alreadyDumpedObjects['$objectClassName'][$pkGetter] = true;
\$keys = ".$this->getPeerClassName()."::getFieldNames(\$keyType);
\$result = array(";
foreach ($this->getTable()->getColumns() as $num => $col) {
if ($col->isLazyLoad()) {
$script .= "
\$keys[$num] => (\$includeLazyLoadColumns) ? \$this->get".$col->getPhpName()."() : null,";
} else {
$script .= "
\$keys[$num] => \$this->get".$col->getPhpName()."(),";
}
}
$script .= "
);";
if ($hasFks) {
$script .= "
if (\$includeForeignObjects) {";
foreach ($fks as $fk) {
$script .= "
if (null !== \$this->" . $this->getFKVarName($fk) . ") {
\$result['" . $this->getFKPhpNameAffix($fk, false) . "'] = \$this->" . $this->getFKVarName($fk) . "->toArray(\$keyType, \$includeLazyLoadColumns, \$alreadyDumpedObjects, true);
}";
}
foreach ($referrers as $fk) {
if ($fk->isLocalPrimaryKey()) {
$script .= "
if (null !== \$this->" . $this->getPKRefFKVarName($fk) . ") {
\$result['" . $this->getRefFKPhpNameAffix($fk, false) . "'] = \$this->" . $this->getPKRefFKVarName($fk) . "->toArray(\$keyType, \$includeLazyLoadColumns, \$alreadyDumpedObjects, true);
}";
} else {
$script .= "
if (null !== \$this->" . $this->getRefFKCollVarName($fk) . ") {
\$result['" . $this->getRefFKPhpNameAffix($fk, true) . "'] = \$this->" . $this->getRefFKCollVarName($fk) . "->toArray(null, true, \$keyType, \$includeLazyLoadColumns, \$alreadyDumpedObjects);
}";
}
}
$script .= "
}";
}
$script .= "
return \$result;
}
";
} // addToArray()
/**
* Adds the getByName method
* @param string &$script The script will be modified in this method.
**/
protected function addGetByName(&$script)
{
$this->addGetByNameComment($script);
$this->addGetByNameOpen($script);
$this->addGetByNameBody($script);
$this->addGetByNameClose($script);
}
/**
* Adds the comment for the getByName method
* @param string &$script The script will be modified in this method.
* @see addGetByName
**/
protected function addGetByNameComment(&$script)
{
$defaultKeyType = $this->getDefaultKeyType();
$script .= "
/**
* Retrieves a field from the object by name passed in as a string.
*
* @param string \$name name
* @param string \$type The type of fieldname the \$name is of:
* one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::$defaultKeyType.
* @return mixed Value of field.
*/";
}
/**
* Adds the function declaration for the getByName method
* @param string &$script The script will be modified in this method.
* @see addGetByName
**/
protected function addGetByNameOpen(&$script)
{
$defaultKeyType = $this->getDefaultKeyType();
$script .= "
public function getByName(\$name, \$type = BasePeer::$defaultKeyType)
{";
}
/**
* Adds the function body for the getByName method
* @param string &$script The script will be modified in this method.
* @see addGetByName
**/
protected function addGetByNameBody(&$script)
{
$script .= "
\$pos = ".$this->getPeerClassName()."::translateFieldName(\$name, \$type, BasePeer::TYPE_NUM);
\$field = \$this->getByPosition(\$pos);";
}
/**
* Adds the function close for the getByName method
* @param string &$script The script will be modified in this method.
* @see addGetByName
**/
protected function addGetByNameClose(&$script)
{
$script .= "
return \$field;
}
";
}
/**
* Adds the getByPosition method
* @param string &$script The script will be modified in this method.
**/
protected function addGetByPosition(&$script)
{
$this->addGetByPositionComment($script);
$this->addGetByPositionOpen($script);
$this->addGetByPositionBody($script);
$this->addGetByPositionClose($script);
}
/**
* Adds comment for the getByPosition method
* @param string &$script The script will be modified in this method.
* @see addGetByPosition
**/
protected function addGetByPositionComment(&$script)
{
$script .= "
/**
* Retrieves a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int \$pos position in xml schema
* @return mixed Value of field at \$pos
*/";
}
/**
* Adds the function declaration for the getByPosition method
* @param string &$script The script will be modified in this method.
* @see addGetByPosition
**/
protected function addGetByPositionOpen(&$script)
{
$script .= "
public function getByPosition(\$pos)
{";
}
/**
* Adds the function body for the getByPosition method
* @param string &$script The script will be modified in this method.
* @see addGetByPosition
**/
protected function addGetByPositionBody(&$script)
{
$table = $this->getTable();
$script .= "
switch (\$pos) {";
$i = 0;
foreach ($table->getColumns() as $col) {
$cfc = $col->getPhpName();
$script .= "
case $i:
return \$this->get$cfc();
break;";
$i++;
} /* foreach */
$script .= "
default:
return null;
break;
} // switch()";
}
/**
* Adds the function close for the getByPosition method
* @param string &$script The script will be modified in this method.
* @see addGetByPosition
**/
protected function addGetByPositionClose(&$script)
{
$script .= "
}
";
}
protected function addSetByName(&$script)
{
$defaultKeyType = $this->getDefaultKeyType();
$script .= "
/**
* Sets a field from the object by name passed in as a string.
*
* @param string \$name peer name
* @param mixed \$value field value
* @param string \$type The type of fieldname the \$name is of:
* one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* Defaults to BasePeer::$defaultKeyType.
* @return void
*/
public function setByName(\$name, \$value, \$type = BasePeer::$defaultKeyType)
{
\$pos = ".$this->getPeerClassName()."::translateFieldName(\$name, \$type, BasePeer::TYPE_NUM);
return \$this->setByPosition(\$pos, \$value);
}
";
}
protected function addSetByPosition(&$script)
{
$table = $this->getTable();
$script .= "
/**
* Sets a field from the object by Position as specified in the xml schema.
* Zero-based.
*
* @param int \$pos position in xml schema
* @param mixed \$value field value
* @return void
*/
public function setByPosition(\$pos, \$value)
{
switch (\$pos) {";
$i = 0;
foreach ($table->getColumns() as $col) {
$cfc = $col->getPhpName();
$script .= "
case $i:";
if (PropelTypes::ENUM === $col->getType()) {
$script .= "
\$valueSet = " . $this->getPeerClassName() . "::getValueSet(" . $this->getColumnConstant($col) . ");
if (isset(\$valueSet[\$value])) {
\$value = \$valueSet[\$value];
}";
} elseif (PropelTypes::PHP_ARRAY === $col->getType()) {
$script .= "
if (!is_array(\$value)) {
\$v = trim(substr(\$value, 2, -2));
\$value = \$v ? explode(' | ', \$v) : array();
}";
}
$script .= "
\$this->set$cfc(\$value);
break;";
$i++;
} /* foreach */
$script .= "
} // switch()
}
";
}
protected function addFromArray(&$script)
{
$defaultKeyType = $this->getDefaultKeyType();
$table = $this->getTable();
$script .= "
/**
* Populates the object using an array.
*
* This is particularly useful when populating an object from one of the
* request arrays (e.g. \$_POST). This method goes through the column
* names, checking to see whether a matching key exists in populated
* array. If so the setByName() method is called for that column.
*
* You can specify the key type of the array by additionally passing one
* of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME,
* BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM.
* The default key type is the column's BasePeer::$defaultKeyType.
*
* @param array \$arr An array to populate the object from.
* @param string \$keyType The type of keys the array uses.
* @return void
*/
public function fromArray(\$arr, \$keyType = BasePeer::$defaultKeyType)
{
\$keys = ".$this->getPeerClassName()."::getFieldNames(\$keyType);
";
foreach ($table->getColumns() as $num => $col) {
$cfc = $col->getPhpName();
$script .= "
if (array_key_exists(\$keys[$num], \$arr)) \$this->set$cfc(\$arr[\$keys[$num]]);";
} /* foreach */
$script .= "
}
";
}
/**
* Adds a delete() method to remove the object form the datastore.
* @param string &$script The script will be modified in this method.
*/
protected function addDelete(&$script)
{
$this->addDeleteComment($script);
$this->addDeleteOpen($script);
$this->addDeleteBody($script);
$this->addDeleteClose($script);
}
/**
* Adds the comment for the delete function
* @param string &$script The script will be modified in this method.
* @see addDelete()
**/
protected function addDeleteComment(&$script)
{
$className = $this->getUnqualifiedClassName();
$script .= "
/**
* Removes this object from datastore and sets delete attribute.
*
* @param ConnectionInterface \$con
* @return void
* @throws PropelException
* @see $className::setDeleted()
* @see $className::isDeleted()
*/";
}
/**
* Adds the function declaration for the delete function
* @param string &$script The script will be modified in this method.
* @see addDelete()
**/
protected function addDeleteOpen(&$script)
{
$script .= "
public function delete(ConnectionInterface \$con = null)
{";
}
/**
* Adds the function body for the delete function
* @param string &$script The script will be modified in this method.
* @see addDelete()
**/
protected function addDeleteBody(&$script)
{
$script .= "
if (\$this->isDeleted()) {
throw new PropelException(\"This object has already been deleted.\");
}
if (\$con === null) {
\$con = Propel::getServiceContainer()->getWriteConnection(".$this->getPeerClassName()."::DATABASE_NAME);
}
\$con->beginTransaction();
try {
\$deleteQuery = ".$this->getQueryClassName()."::create()
->filterByPrimaryKey(\$this->getPrimaryKey());";
if ($this->getGeneratorConfig()->getBuildProperty('addHooks')) {
$script .= "
\$ret = \$this->preDelete(\$con);";
// apply behaviors
$this->applyBehaviorModifier('preDelete', $script, " ");
$script .= "
if (\$ret) {
\$deleteQuery->delete(\$con);
\$this->postDelete(\$con);";
// apply behaviors
$this->applyBehaviorModifier('postDelete', $script, " ");
$script .= "
\$con->commit();
\$this->setDeleted(true);
} else {
\$con->commit();
}";
} else {
// apply behaviors
$this->applyBehaviorModifier('preDelete', $script, " ");
$script .= "
\$deleteQuery->delete(\$con);";
// apply behaviors
$this->applyBehaviorModifier('postDelete', $script, " ");
$script .= "
\$con->commit();
\$this->setDeleted(true);";
}
$script .= "
} catch (Exception \$e) {
\$con->rollBack();
throw \$e;
}";
}
/**
* Adds the function close for the delete function
* @param string &$script The script will be modified in this method.
* @see addDelete()
**/
protected function addDeleteClose(&$script)
{
$script .= "
}
";
} // addDelete()
/**
* Adds a reload() method to re-fetch the data for this object from the database.
* @param string &$script The script will be modified in this method.
*/
protected function addReload(&$script)
{
$table = $this->getTable();
$script .= "
/**
* Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
*
* This will only work if the object has been saved and has a valid primary key set.
*
* @param boolean \$deep (optional) Whether to also de-associated any related objects.
* @param ConnectionInterface \$con (optional) The ConnectionInterface connection to use.
* @return void
* @throws PropelException - if this object is deleted, unsaved or doesn't have pk match in db
*/
public function reload(\$deep = false, ConnectionInterface \$con = null)
{
if (\$this->isDeleted()) {
throw new PropelException(\"Cannot reload a deleted object.\");
}
if (\$this->isNew()) {
throw new PropelException(\"Cannot reload an unsaved object.\");
}
if (\$con === null) {
\$con = Propel::getServiceContainer()->getReadConnection(".$this->getPeerClassName()."::DATABASE_NAME);
}
// We don't need to alter the object instance pool; we're just modifying this instance
// already in the pool.
\$stmt = ".$this->getPeerClassName()."::doSelectStmt(\$this->buildPkeyCriteria(), \$con);
\$row = \$stmt->fetch(PDO::FETCH_NUM);
\$stmt->closeCursor();
if (!\$row) {
throw new PropelException('Cannot find matching row in the database to reload object values.');
}
\$this->hydrate(\$row, 0, true); // rehydrate
";
// support for lazy load columns
foreach ($table->getColumns() as $col) {
if ($col->isLazyLoad()) {
$clo = strtolower($col->getName());
$script .= "
// Reset the $clo lazy-load column
\$this->" . $clo . " = null;
\$this->".$clo."_isLoaded = false;
";
}
}
$script .= "
if (\$deep) { // also de-associate any related objects?
";
foreach ($table->getForeignKeys() as $fk) {
$varName = $this->getFKVarName($fk);
$script .= "
\$this->".$varName." = null;";
}
foreach ($table->getReferrers() as $refFK) {
if ($refFK->isLocalPrimaryKey()) {
$script .= "
\$this->".$this->getPKRefFKVarName($refFK)." = null;
";
} else {
$script .= "
\$this->".$this->getRefFKCollVarName($refFK)." = null;
";
}
}
foreach ($table->getCrossFks() as $fkList) {
list($refFK, $crossFK) = $fkList;
$script .= "
\$this->" . $this->getCrossFKVarName($crossFK). " = null;";
}
$script .= "
} // if (deep)
}
";
} // addReload()
/**
* Adds the methods related to refreshing, saving and deleting the object.
* @param string &$script The script will be modified in this method.
*/
protected function addManipulationMethods(&$script)
{
$this->addReload($script);
$this->addDelete($script);
$this->addSave($script);
$this->addDoSave($script);
$script .= $this->addDoInsert();
$script .= $this->addDoUpdate();
}
/**
* Adds the correct getPrimaryKey() method for this object.
* @param string &$script The script will be modified in this method.
*/
protected function addGetPrimaryKey(&$script)
{
$pkeys = $this->getTable()->getPrimaryKey();
if (count($pkeys) == 1) {
$this->addGetPrimaryKey_SinglePK($script);
} elseif (count($pkeys) > 1) {
$this->addGetPrimaryKey_MultiPK($script);
} else {
// no primary key -- this is deprecated, since we don't *need* this method anymore
$this->addGetPrimaryKey_NoPK($script);
}
}
/**
* Adds the getPrimaryKey() method for tables that contain a single-column primary key.
* @param string &$script The script will be modified in this method.
*/
protected function addGetPrimaryKey_SinglePK(&$script)
{
$table = $this->getTable();
$pkeys = $table->getPrimaryKey();
$cptype = $pkeys[0]->getPhpType();
$script .= "
/**
* Returns the primary key for this object (row).
* @return $cptype
*/
public function getPrimaryKey()
{
return \$this->get".$pkeys[0]->getPhpName()."();
}
";
} // addetPrimaryKey_SingleFK
/**
* Adds the setPrimaryKey() method for tables that contain a multi-column primary key.
* @param string &$script The script will be modified in this method.
*/
protected function addGetPrimaryKey_MultiPK(&$script)
{
$script .= "
/**
* Returns the composite primary key for this object.
* The array elements will be in same order as specified in XML.
* @return array
*/
public function getPrimaryKey()
{
\$pks = array();";
$i = 0;
foreach ($this->getTable()->getPrimaryKey() as $pk) {
$script .= "
\$pks[$i] = \$this->get".$pk->getPhpName()."();";
$i++;
} /* foreach */
$script .= "
return \$pks;
}
";
} // addGetPrimaryKey_MultiFK()
/**
* Adds the getPrimaryKey() method for objects that have no primary key.
* This "feature" is deprecated, since the getPrimaryKey() method is not required
* by the Persistent interface (or used by the templates). Hence, this method is also
* deprecated.
* @param string &$script The script will be modified in this method.
* @deprecated
*/
protected function addGetPrimaryKey_NoPK(&$script)
{
$script .= "
/**
* Returns NULL since this table doesn't have a primary key.
* This method exists only for BC and is deprecated!
* @return null
*/
public function getPrimaryKey()
{
return null;
}
";
}
/**
* Adds the correct setPrimaryKey() method for this object.
* @param string &$script The script will be modified in this method.
*/
protected function addSetPrimaryKey(&$script)
{
$pkeys = $this->getTable()->getPrimaryKey();
if (count($pkeys) == 1) {
$this->addSetPrimaryKey_SinglePK($script);
} elseif (count($pkeys) > 1) {
$this->addSetPrimaryKey_MultiPK($script);
} else {
// no primary key -- this is deprecated, since we don't *need* this method anymore
$this->addSetPrimaryKey_NoPK($script);
}
}
/**
* Adds the setPrimaryKey() method for tables that contain a single-column primary key.
* @param string &$script The script will be modified in this method.
*/
protected function addSetPrimaryKey_SinglePK(&$script)
{
$pkeys = $this->getTable()->getPrimaryKey();
$col = $pkeys[0];
$clo=strtolower($col->getName());
$ctype = $col->getPhpType();
$script .= "
/**
* Generic method to set the primary key ($clo column).
*
* @param $ctype \$key Primary key.
* @return void
*/
public function setPrimaryKey(\$key)
{
\$this->set".$col->getPhpName()."(\$key);
}
";
} // addSetPrimaryKey_SinglePK
/**
* Adds the setPrimaryKey() method for tables that contain a multi-columnprimary key.
* @param string &$script The script will be modified in this method.
*/
protected function addSetPrimaryKey_MultiPK(&$script)
{
$script .="
/**
* Set the [composite] primary key.
*
* @param array \$keys The elements of the composite key (order must match the order in XML file).
* @return void
*/
public function setPrimaryKey(\$keys)
{";
$i = 0;
foreach ($this->getTable()->getPrimaryKey() as $pk) {
$script .= "
\$this->set".$pk->getPhpName()."(\$keys[$i]);";
$i++;
}
$script .= "
}
";
}
/**
* Adds the setPrimaryKey() method for objects that have no primary key.
* This "feature" is deprecated, since the setPrimaryKey() method is not required
* by the Persistent interface (or used by the templates). Hence, this method is also
* deprecated.
* @param string &$script The script will be modified in this method.
* @deprecated
*/
protected function addSetPrimaryKey_NoPK(&$script)
{
$script .="
/**
* Dummy primary key setter.
*
* This function only exists to preserve backwards compatibility. It is no longer
* needed or required by the Persistent interface. It will be removed in next BC-breaking
* release of Propel.
*
* @deprecated
*/
public function setPrimaryKey(\$pk)
{
// do nothing, because this object doesn't have any primary keys
}
";
}
/**
* Adds the isPrimaryKeyNull() method
* @param string &$script The script will be modified in this method.
*/
protected function addIsPrimaryKeyNull(&$script)
{
$table = $this->getTable();
$pkeys = $table->getPrimaryKey();
$script .= "
/**
* Returns true if the primary key for this object is null.
* @return boolean
*/
public function isPrimaryKeyNull()
{";
if (count($pkeys) == 1) {
$script .= "
return null === \$this->get" . $pkeys[0]->getPhpName() . "();";
} else {
$tests = array();
foreach ($pkeys as $pkey) {
$tests[]= "(null === \$this->get" . $pkey->getPhpName() . "())";
}
$script .= "
return " . join(' && ', $tests) . ";";
}
$script .= "
}
";
}
/**
* Constructs variable name for fkey-related objects.
* @param ForeignKey $fk
* @return string
*/
public function getFKVarName(ForeignKey $fk)
{
return 'a' . $this->getFKPhpNameAffix($fk, false);
}
/**
* Constructs variable name for objects which referencing current table by specified foreign key.
* @param ForeignKey $fk
* @return string
*/
public function getRefFKCollVarName(ForeignKey $fk)
{
return 'coll' . $this->getRefFKPhpNameAffix($fk, true);
}
/**
* Constructs variable name for single object which references current table by specified foreign key
* which is ALSO a primary key (hence one-to-one relationship).
* @param ForeignKey $fk
* @return string
*/
public function getPKRefFKVarName(ForeignKey $fk)
{
return 'single' . $this->getRefFKPhpNameAffix($fk, false);
}
/**
* Adds the methods that get & set objects related by foreign key to the current object.
* @param string &$script The script will be modified in this method.
*/
protected function addFKMethods(&$script)
{
foreach ($this->getTable()->getForeignKeys() as $fk) {
$this->declareClassFromBuilder($this->getNewStubObjectBuilder($fk->getForeignTable()), 'Child');
$this->declareClassFromBuilder($this->getNewStubQueryBuilder($fk->getForeignTable()));
$this->addFKMutator($script, $fk);
$this->addFKAccessor($script, $fk);
} // foreach fk
}
/**
* Adds the class attributes that are needed to store fkey related objects.
* @param string &$script The script will be modified in this method.
*/
protected function addFKAttributes(&$script, ForeignKey $fk)
{
$className = $this->getForeignTable($fk)->getPhpName();
$varName = $this->getFKVarName($fk);
$script .= "
/**
* @var $className
*/
protected $".$varName.";
";
}
/**
* Adds the mutator (setter) method for setting an fkey related object.
* @param string &$script The script will be modified in this method.
*/
protected function addFKMutator(&$script, ForeignKey $fk)
{
$table = $this->getTable();
$tblFK = $this->getForeignTable($fk);
$joinTableObjectBuilder = $this->getNewObjectBuilder($tblFK);
$className = $joinTableObjectBuilder->getObjectClassName();
$varName = $this->getFKVarName($fk);
$script .= "
/**
* Declares an association between this object and a $className object.
*
* @param $className \$v
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
* @throws PropelException
*/
public function set".$this->getFKPhpNameAffix($fk, false)."($className \$v = null)
{";
foreach ($fk->getLocalColumns() as $columnName) {
$column = $table->getColumn($columnName);
$lfmap = $fk->getLocalForeignMapping();
$colFKName = $lfmap[$columnName];
$colFK = $tblFK->getColumn($colFKName);
$script .= "
if (\$v === null) {
\$this->set".$column->getPhpName()."(".$this->getDefaultValueString($column).");
} else {
\$this->set".$column->getPhpName()."(\$v->get".$colFK->getPhpName()."());
}
";
} /* foreach local col */
$script .= "
\$this->$varName = \$v;
";
// Now add bi-directional relationship binding, taking into account whether this is
// a one-to-one relationship.
if ($fk->isLocalPrimaryKey()) {
$script .= "
// Add binding for other direction of this 1:1 relationship.
if (\$v !== null) {
\$v->set".$this->getRefFKPhpNameAffix($fk, false)."(\$this);
}
";
} else {
$script .= "
// Add binding for other direction of this n:n relationship.
// If this object has already been added to the $className object, it will not be re-added.
if (\$v !== null) {
\$v->add".$this->getRefFKPhpNameAffix($fk, false)."(\$this);
}
";
}
$script .= "
return \$this;
}
";
}
/**
* Adds the accessor (getter) method for getting an fkey related object.
* @param string &$script The script will be modified in this method.
*/
protected function addFKAccessor(&$script, ForeignKey $fk)
{
$table = $this->getTable();
$varName = $this->getFKVarName($fk);
$fkQueryBuilder = $this->getNewStubQueryBuilder($this->getForeignTable($fk));
$fkObjectBuilder = $this->getNewObjectBuilder($this->getForeignTable($fk))->getStubObjectBuilder();
$className = $this->getClassNameFromBuilder($fkObjectBuilder); // get the ClassName that has maybe a prefix
$and = '';
$conditional = '';
$localColumns = array(); // foreign key local attributes names
// If the related columns are a primary key on the foreign table
// then use retrieveByPk() instead of doSelect() to take advantage
// of instance pooling
$useRetrieveByPk = $fk->isForeignPrimaryKey();
foreach ($fk->getLocalColumns() as $columnName) {
$lfmap = $fk->getLocalForeignMapping();
$foreignColumn = $fk->getForeignTable()->getColumn($lfmap[$columnName]);
$column = $table->getColumn($columnName);
$cptype = $column->getPhpType();
$clo = strtolower($column->getName());
$localColumns[$foreignColumn->getPosition()] = '$this->'.$clo;
if ($cptype == "integer" || $cptype == "float" || $cptype == "double") {
$conditional .= $and . "\$this->". $clo ." != 0";
} elseif ($cptype == "string") {
$conditional .= $and . "(\$this->" . $clo ." !== \"\" && \$this->".$clo." !== null)";
} else {
$conditional .= $and . "\$this->" . $clo ." !== null";
}
$and = " && ";
}
ksort($localColumns); // restoring the order of the foreign PK
$localColumns = count($localColumns) > 1 ?
('array('.implode(', ', $localColumns).')') : reset($localColumns);
$script .= "
/**
* Get the associated $className object
*
* @param ConnectionInterface \$con Optional Connection object.
* @return $className The associated $className object.
* @throws PropelException
*/
public function get".$this->getFKPhpNameAffix($fk, false)."(ConnectionInterface \$con = null)
{";
$script .= "
if (\$this->$varName === null && ($conditional)) {";
if ($useRetrieveByPk) {
$script .= "
\$this->$varName = ".$this->getClassNameFromBuilder($fkQueryBuilder)."::create()->findPk($localColumns, \$con);";
} else {
$script .= "
\$this->$varName = ".$this->getClassNameFromBuilder($fkQueryBuilder)."::create()
->filterBy" . $this->getRefFKPhpNameAffix($fk, $plural = false) . "(\$this) // here
->findOne(\$con);";
}
if ($fk->isLocalPrimaryKey()) {
$script .= "
// Because this foreign key represents a one-to-one relationship, we will create a bi-directional association.
\$this->{$varName}->set".$this->getRefFKPhpNameAffix($fk, false)."(\$this);";
} else {
$script .= "
/* The following can be used additionally to
guarantee the related object contains a reference
to this object. This level of coupling may, however, be
undesirable since it could result in an only partially populated collection
in the referenced object.
\$this->{$varName}->add".$this->getRefFKPhpNameAffix($fk, true)."(\$this);
*/";
}
$script .= "
}
return \$this->$varName;
}
";
} // addFKAccessor
/**
* Adds a convenience method for setting a related object by specifying the primary key.
* This can be used in conjunction with the getPrimaryKey() for systems where nothing is known
* about the actual objects being related.
* @param string &$script The script will be modified in this method.
*/
protected function addFKByKeyMutator(&$script, ForeignKey $fk)
{
$table = $this->getTable();
$methodAffix = $this->getFKPhpNameAffix($fk);
$script .= "
/**
* Provides convenient way to set a relationship based on a
* key. e.g.
* <code>\$bar->setFooKey(\$foo->getPrimaryKey())</code>
*";
if (count($fk->getLocalColumns()) > 1) {
$script .= "
* Note: It is important that the xml schema used to create this class
* maintains consistency in the order of related columns between
* ".$table->getName()." and ". $fk->getName().".
* If for some reason this is impossible, this method should be
* overridden in <code>".$table->getPhpName()."</code>.";
}
$script .= "
* @return ".$this->getObjectClassName(true)." The current object (for fluent API support)
* @throws PropelException
*/
public function set".$methodAffix."Key(\$key)
{
";
if (count($fk->getLocalColumns()) > 1) {
$i = 0;
foreach ($fk->getLocalColumns() as $colName) {
$col = $table->getColumn($colName);
$fktype = $col->getPhpType();
$script .= "