Skip to content

Commit

Permalink
Merge pull request #4 from vemaeg/feature/adding-actas-columns-to-the…
Browse files Browse the repository at this point in the history 
…-docblock

Adding columns defined in actAs-templates to the docblock of the generated model class.
  • Loading branch information
@thirsch
thirsch authored Dec 15, 2022
2 parents 7d448d9 + 7b31a16 commit 636155c
Showing 1 changed file with 60 additions and 11 deletions.
71 changes: 60 additions & 11 deletions lib/Doctrine/Import/Builder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ public function buildTableDefinition(array $definition)
* @param array $relations
* @return string
*/
public function buildSetUp(array $definition)
public function buildSetUp(array &$definition)
{
$ret = array();
$i = 0;
Expand Down Expand Up @@ -482,7 +482,7 @@ public function buildSetUp(array $definition)
}

if (isset($definition['actAs']) && is_array($definition['actAs']) && !empty($definition['actAs'])) {
$ret[$i] = $this->buildActAs($definition['actAs']);
$ret[$i] = $this->buildActAs($definition['actAs'], $definition);
$i++;
}

Expand Down Expand Up @@ -864,7 +864,7 @@ public function buildPhpDocs(array $definition)
* @param string $option
* @return string assignation code
*/
private function emitAssign($level, $name, $option)
private function emitAssign($level, $name, $option, &$classname)
{
// find class matching $name
$classname = $name;
Expand Down Expand Up @@ -904,10 +904,10 @@ private function emitActAs($level, $name)
* buildActAs: builds a complete actAs code. It supports hierarchy of plugins
* @param array $actAs array of plugin definitions and options
*/
public function buildActAs($actAs)
public function buildActAs($actAs, &$definition)
{
$emittedActAs = array();
$build = $this->innerBuildActAs($actAs, 0, null, $emittedActAs);
$build = $this->innerBuildActAs($actAs, 0, null, $emittedActAs, $definition);
foreach($emittedActAs as $str) {
$build .= $str;
}
Expand All @@ -923,7 +923,7 @@ public function buildActAs($actAs)
* @param array $emittedActAs contains on output an array of actAs command to be appended to output
* @return string actAs full definition
*/
private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emittedActAs = array())
private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emittedActAs = array(), array &$definition = array())
{
// rewrite special case of actAs: [Behavior] which gave [0] => Behavior
if (is_array($actAs) && isset($actAs[0]) && !is_array($actAs[0])) {
Expand All @@ -944,7 +944,7 @@ private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emi
foreach($actAs as $template => $options) {
if ($template == 'actAs') {
// found another actAs
$build .= $this->innerBuildActAs($options, $level + 1, $parent, $emittedActAs);
$build .= $this->innerBuildActAs($options, $level + 1, $parent, $emittedActAs, $definition);
} else if (is_array($options)) {
// remove actAs from options
$realOptions = array();
Expand All @@ -958,17 +958,19 @@ private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emi
}

$optionPHP = $this->varExport($realOptions);
$build .= $this->emitAssign($level, $template, $optionPHP);
$build .= $this->emitAssign($level, $template, $optionPHP, $className);
$this->addActAsColumnsToDefinition($className, $realOptions, $definition);
if ($level == 0) {
$emittedActAs[] = $this->emitActAs($level, $template);
} else {
$build .= $this->emitAddChild($level, $currentParent, $template);
}
// descend for the remainings actAs
$parent = $template;
$build .= $this->innerBuildActAs($leftActAs, $level, $template, $emittedActAs);
$build .= $this->innerBuildActAs($leftActAs, $level, $template, $emittedActAs, $definition);
} else {
$build .= $this->emitAssign($level, $template, null);
$build .= $this->emitAssign($level, $template, null, $className);
$this->addActAsColumnsToDefinition($className, array($options), $definition);
if ($level == 0) {
$emittedActAs[] = $this->emitActAs($level, $template);
} else {
Expand All @@ -978,7 +980,8 @@ private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emi
}
}
} else {
$build .= $this->emitAssign($level, $actAs, null);
$build .= $this->emitAssign($level, $actAs, null, $className);
$this->addActAsColumnsToDefinition($className, array(), $definition);
if ($level == 0) {
$emittedActAs[] = $this->emitActAs($level, $actAs);
} else {
Expand All @@ -989,6 +992,52 @@ private function innerBuildActAs($actAs, $level = 0, $parent = null, array &$emi
return $build;
}

/**
* Adds the columns of the used actAs behaviors to the comment block.
*
* @param string $className
* @param array $instanceOptions
* @param array $definition
*
* @throws Doctrine_Import_Builder_Exception
*/
private function addActAsColumnsToDefinition($className, $instanceOptions, &$definition)
{
if ($className && class_exists($className)) {
$actAsInstance = new $className($instanceOptions);
$options = $actAsInstance->getOptions();

if (count($options) == 0) {
return;
}

// Some behaviors do not contain an array of columns, e.g. SoftDelete.
if (!is_array(reset($options))) {
$options = [$options];
}

foreach ($options as $name => $column) {
if (!is_array($column) || !array_key_exists('name', $column) || !array_key_exists('type', $column)) {
// 'name' or 'type' not found. Unfortunately there is no logger. What is the best way to abort here?
continue;
}

if (array_key_exists('disabled', $column) && $column['disabled']) {
// Column has been disabled.
continue;
}

// Add field, if it does not exist already.
if (!array_key_exists($name, $definition['columns']) && !array_key_exists($column['name'], $definition['columns'])) {
$definition['columns'][$name] = $column;
}
}
} else {
throw new Doctrine_Import_Builder_Exception('Missing class for actAs ' . $className . '.');
}
}


/**
* Build php code for adding record listeners
*
Expand Down

0 comments on commit 636155c

Please sign in to comment.