Mouf\Database\TDBM\Utils\ScalarBeanPropertyDescriptor

Complexity

Total Complexity

18

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	7
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getForeignKey()	0	4	1
A	getParamAnnotation()	0	9	2
A	getUpperCamelCaseName()	0	4	1
A	getClassName()	0	4	1
A	isCompulsory()	0	4	3
A	hasDefault()	0	4	1
A	assignToDefaultCode()	0	14	2
A	isPrimaryKey()	0	4	1
A	getGetterSetterCode()	0	53	2
A	getJsonSerializeCode()	0	11	2
A	getColumnName()	0	4	1

<?php

namespace Mouf\Database\TDBM\Utils;

use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Schema\ForeignKeyConstraint;

/**
 * This class represent a property in a bean (a property has a getter, a setter, etc...).
 */
class ScalarBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor
{
    /**
     * @var Column
     */
    private $column;

    public function __construct(Table $table, Column $column)
    {
        parent::__construct($table);
        $this->table = $table;
        $this->column = $column;
    }

    /**
     * Returns the foreign-key the column is part of, if any. null otherwise.
     *
     * @return ForeignKeyConstraint|null
     */
    public function getForeignKey()
    {
        return false;
    }

    /**
     * Returns the param annotation for this property (useful for constructor).
     *
     * @return string
     */
    public function getParamAnnotation()
    {
        $className = $this->getClassName();
        $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType());

        $str = '     * @param %s %s';

        return sprintf($str, $paramType, $this->getVariableName());
    }

    public function getUpperCamelCaseName()
    {
        return TDBMDaoGenerator::toCamelCase($this->column->getName());
    }

    /**
     * Returns the name of the class linked to this property or null if this is not a foreign key.
     *
     * @return null|string
     */
    public function getClassName()
    {
        return;
    }

    /**
     * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
     *
     * @return bool
     */
    public function isCompulsory()
    {
        return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null;
    }

    /**
     * Returns true if the property has a default value.
     *
     * @return bool
     */
    public function hasDefault()
    {
        return $this->column->getDefault() !== null;
    }

    /**
     * Returns the code that assigns a value to its default value.
     *
     * @return string
     */
    public function assignToDefaultCode()
    {
        $str = '        $this->%s(%s);';

        $default = $this->column->getDefault();

        if (strtoupper($default) === 'CURRENT_TIMESTAMP') {
            $defaultCode = 'new \DateTimeImmutable()';
        } else {
            $defaultCode = var_export($this->column->getDefault(), true);
        }

        return sprintf($str, $this->getSetterName(), $defaultCode);
    }

    /**
     * Returns true if the property is the primary key.
     *
     * @return bool
     */
    public function isPrimaryKey()
    {
        return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns());
    }

    /**
     * Returns the PHP code for getters and setters.
     *
     * @return string
     */
    public function getGetterSetterCode()
    {
        $type = $this->column->getType();
        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);

        $columnGetterName = $this->getGetterName();
        $columnSetterName = $this->getSetterName();

        if ($normalizedType == '\\DateTimeInterface') {
            $castTo = '\\DateTimeInterface ';
        } else {
            $castTo = '';
        }

        $getterAndSetterCode = '    /**
     * The getter for the "%s" column.
     *
     * @return %s
     */
    public function %s() {
        return $this->get(%s, %s);
    }

    /**
     * The setter for the "%s" column.
     *
     * @param %s $%s
     */
    public function %s(%s$%s) {
        $this->set(%s, $%s, %s);
    }

';

        return sprintf($getterAndSetterCode,
            // Getter
            $this->column->getName(),
            $normalizedType,
            $columnGetterName,
            var_export($this->column->getName(), true),
            var_export($this->table->getName(), true),
            // Setter
            $this->column->getName(),
            $normalizedType,
            $this->column->getName(),
            $columnSetterName,
            $castTo,
            $this->column->getName(),
            var_export($this->column->getName(), true),
            $this->column->getName(),
            var_export($this->table->getName(), true)
        );
    }

    /**
     * Returns the part of code useful when doing json serialization.
     *
     * @return string
     */
    public function getJsonSerializeCode()
    {
        $type = $this->column->getType();
        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);

        if ($normalizedType == '\\DateTimeInterface') {
            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null)?null:$this->'.$this->getGetterName()."()->format('c');\n";
        } else {
            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n";
        }
    }

    /**
     * Returns the column name.
     *
     * @return string
     */
    public function getColumnName()
    {
        return $this->column->getName();
    }
}