410 lines
11 KiB
PHP
410 lines
11 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* $Id: OMBuilder.php 536 2007-01-10 14:30:38Z heltem $
|
||
|
|
*
|
||
|
|
* 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 please see
|
||
|
|
* <http://propel.phpdb.org>.
|
||
|
|
*/
|
||
|
|
|
||
|
|
require_once 'propel/engine/builder/DataModelBuilder.php';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Baseclass for OM-building classes.
|
||
|
|
*
|
||
|
|
* OM-building classes are those that build a PHP (or other) class to service
|
||
|
|
* a single table. This includes Peer classes, Entity classes, Map classes,
|
||
|
|
* Node classes, etc.
|
||
|
|
*
|
||
|
|
* @author Hans Lellelid <hans@xmpl.org>
|
||
|
|
* @package propel.engine.builder.om
|
||
|
|
*/
|
||
|
|
abstract class OMBuilder extends DataModelBuilder {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Peer builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $peerBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub Peer builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $stubPeerBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Object builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $objectBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub Object builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $stubObjectBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* MapBuilder builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $mapBuilderBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub Interface builder class for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $interfaceBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub child object for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $multiExtendObjectBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Node object builder for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $nodeBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Node peer builder for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $nodePeerBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub node object builder for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $stubNodeBuilder;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stub node peer builder for current table.
|
||
|
|
* @var DataModelBuilder
|
||
|
|
*/
|
||
|
|
private $stubNodePeerBuilder;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing Peer builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getPeerBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->peerBuilder)) {
|
||
|
|
$this->peerBuilder = DataModelBuilder::builderFactory($this->getTable(), 'peer');
|
||
|
|
}
|
||
|
|
return $this->peerBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub Peer builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getStubPeerBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->stubPeerBuilder)) {
|
||
|
|
$this->stubPeerBuilder = DataModelBuilder::builderFactory($this->getTable(), 'peerstub');
|
||
|
|
}
|
||
|
|
return $this->stubPeerBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing Object builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getObjectBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->objectBuilder)) {
|
||
|
|
$this->objectBuilder = DataModelBuilder::builderFactory($this->getTable(), 'object');
|
||
|
|
}
|
||
|
|
return $this->objectBuilder;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub Object builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getStubObjectBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->stubObjectBuilder)) {
|
||
|
|
$this->stubObjectBuilder = DataModelBuilder::builderFactory($this->getTable(), 'objectstub');
|
||
|
|
}
|
||
|
|
return $this->stubObjectBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing MapBuilder builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getMapBuilderBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->mapBuilderBuilder)) {
|
||
|
|
$this->mapBuilderBuilder = DataModelBuilder::builderFactory($this->getTable(), 'mapbuilder');
|
||
|
|
}
|
||
|
|
return $this->mapBuilderBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub Interface builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getInterfaceBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->interfaceBuilder)) {
|
||
|
|
$this->interfaceBuilder = DataModelBuilder::builderFactory($this->getTable(), 'interface');
|
||
|
|
}
|
||
|
|
return $this->interfaceBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub child object builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getMultiExtendObjectBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->multiExtendObjectBuilder)) {
|
||
|
|
$this->multiExtendObjectBuilder = DataModelBuilder::builderFactory($this->getTable(), 'objectmultiextend');
|
||
|
|
}
|
||
|
|
return $this->multiExtendObjectBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing node Object builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getNodeBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->nodeBuilder)) {
|
||
|
|
$this->nodeBuilder = DataModelBuilder::builderFactory($this->getTable(), 'node');
|
||
|
|
}
|
||
|
|
return $this->nodeBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing node Peer builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getNodePeerBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->nodePeerBuilder)) {
|
||
|
|
$this->nodePeerBuilder = DataModelBuilder::builderFactory($this->getTable(), 'nodepeer');
|
||
|
|
}
|
||
|
|
return $this->nodePeerBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub node Object builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getStubNodeBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->stubNodeBuilder)) {
|
||
|
|
$this->stubNodeBuilder = DataModelBuilder::builderFactory($this->getTable(), 'nodestub');
|
||
|
|
}
|
||
|
|
return $this->stubNodeBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns new or existing stub node Peer builder class for this table.
|
||
|
|
* @return DataModelBuilder
|
||
|
|
*/
|
||
|
|
public function getStubNodePeerBuilder()
|
||
|
|
{
|
||
|
|
if (!isset($this->stubNodePeerBuilder)) {
|
||
|
|
$this->stubNodePeerBuilder = DataModelBuilder::builderFactory($this->getTable(), 'nodepeerstub');
|
||
|
|
}
|
||
|
|
return $this->stubNodePeerBuilder;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Convenience method to return a NEW Peer class builder instance.
|
||
|
|
* This is used very frequently from the peer and object builders to get
|
||
|
|
* a peer builder for a RELATED table.
|
||
|
|
* @param Table $table
|
||
|
|
* @return PeerBuilder
|
||
|
|
*/
|
||
|
|
public static function getNewPeerBuilder(Table $table)
|
||
|
|
{
|
||
|
|
return DataModelBuilder::builderFactory($table, 'peer');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Convenience method to return a NEW Object class builder instance.
|
||
|
|
* This is used very frequently from the peer and object builders to get
|
||
|
|
* an object builder for a RELATED table.
|
||
|
|
* @param Table $table
|
||
|
|
* @return ObjectBuilder
|
||
|
|
*/
|
||
|
|
public static function getNewObjectBuilder(Table $table)
|
||
|
|
{
|
||
|
|
return DataModelBuilder::builderFactory($table, 'object');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Builds the PHP source for current class and returns it as a string.
|
||
|
|
*
|
||
|
|
* This is the main entry point and defines a basic structure that classes should follow.
|
||
|
|
* In most cases this method will not need to be overridden by subclasses. This method
|
||
|
|
* does assume that the output language is PHP code, so it will need to be overridden if
|
||
|
|
* this is not the case.
|
||
|
|
*
|
||
|
|
* @return string The resulting PHP sourcecode.
|
||
|
|
*/
|
||
|
|
public function build()
|
||
|
|
{
|
||
|
|
$script = "<" . "?php\n"; // intentional concatenation
|
||
|
|
$this->addIncludes($script);
|
||
|
|
$this->addClassOpen($script);
|
||
|
|
$this->addClassBody($script);
|
||
|
|
$this->addClassClose($script);
|
||
|
|
return $script;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the name of the current class being built.
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
abstract public function getClassname();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the dot-path representation of current class being built.
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getClasspath()
|
||
|
|
{
|
||
|
|
if ($this->getPackage()) {
|
||
|
|
$path = $this->getPackage() . '.' . $this->getClassname();
|
||
|
|
} else {
|
||
|
|
$path = $this->getClassname();
|
||
|
|
}
|
||
|
|
return $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the full path to the file for the current class.
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getClassFilePath()
|
||
|
|
{
|
||
|
|
return parent::getFilePath($this->getPackage(), $this->getClassname());
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets package name for this table.
|
||
|
|
* This is overridden by child classes that have different packages.
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getPackage()
|
||
|
|
{
|
||
|
|
$pkg = ($this->getTable()->getPackage() ? $this->getTable()->getPackage() : $this->getDatabase()->getPackage());
|
||
|
|
if (!$pkg) {
|
||
|
|
$pkg = $this->getBuildProperty('targetPackage');
|
||
|
|
}
|
||
|
|
return $pkg;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns filesystem path for current package.
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getPackagePath()
|
||
|
|
{
|
||
|
|
return strtr($this->getPackage(), '.', '/');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Shortcut method to return the [stub] peer classname for current table.
|
||
|
|
* This is the classname that is used whenever object or peer classes want
|
||
|
|
* to invoke methods of the peer classes.
|
||
|
|
* @return string (e.g. 'MyPeer')
|
||
|
|
* @see StubPeerBuilder::getClassname()
|
||
|
|
*/
|
||
|
|
public function getPeerClassname() {
|
||
|
|
return $this->getStubPeerBuilder()->getClassname();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the object classname for current table.
|
||
|
|
* This is the classname that is used whenever object or peer classes want
|
||
|
|
* to invoke methods of the object classes.
|
||
|
|
* @return string (e.g. 'My')
|
||
|
|
* @see StubPeerBuilder::getClassname()
|
||
|
|
*/
|
||
|
|
public function getObjectClassname() {
|
||
|
|
return $this->getStubObjectBuilder()->getClassname();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the column constant name (e.g. PeerName::COLUMN_NAME).
|
||
|
|
*
|
||
|
|
* @param Column $col The column we need a name for.
|
||
|
|
* @param string $phpName The PHP Name of the peer class. The 'Peer' is appended automatically.
|
||
|
|
*
|
||
|
|
* @return string If $phpName is provided, then will return {$phpName}Peer::COLUMN_NAME; if not, then uses current table COLUMN_NAME.
|
||
|
|
*/
|
||
|
|
public function getColumnConstant($col, $phpName = null)
|
||
|
|
{
|
||
|
|
if ($col === null) {
|
||
|
|
$e = new Exception("No col specified.");
|
||
|
|
print $e;
|
||
|
|
throw $e;
|
||
|
|
}
|
||
|
|
$classname = $this->getPeerClassname($phpName);
|
||
|
|
|
||
|
|
// was it overridden in schema.xml ?
|
||
|
|
if ($col->getPeerName()) {
|
||
|
|
$const = strtoupper($col->getPeerName());
|
||
|
|
} else {
|
||
|
|
$const = strtoupper($col->getName());
|
||
|
|
}
|
||
|
|
return $classname.'::'.$const;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets just classname, given a dot-path to class.
|
||
|
|
* @param string $qualifiedName
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function classname($qualifiedName)
|
||
|
|
{
|
||
|
|
$pos = strrpos($qualifiedName, '.');
|
||
|
|
if ($pos === false) {
|
||
|
|
return $qualifiedName; // there is no '.' in the qualifed name
|
||
|
|
} else {
|
||
|
|
return substr($qualifiedName, $pos + 1); // start just after '.'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the basePeer path if specified for table/db.
|
||
|
|
* If not, will return 'propel.util.BasePeer'
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getBasePeer(Table $table) {
|
||
|
|
$class = $table->getBasePeer();
|
||
|
|
if ($class === null) {
|
||
|
|
$class = "propel.util.BasePeer";
|
||
|
|
}
|
||
|
|
return $class;
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|