LaravelDoctrine\Fluent\Extensions\Gedmo\TreePath

Complexity

Total Complexity

9

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	enable()	0	6	1
A	startsWithSeparator()	0	6	1
A	endsWithSeparator()	0	6	1
A	__construct()	0	6	1
A	separator()	0	6	1
A	appendId()	0	6	1
A	build()	0	14	2
A	getExtensionName()	0	4	1

<?php

namespace LaravelDoctrine\Fluent\Extensions\Gedmo;

use Gedmo\Exception\InvalidMappingException;
use Gedmo\Tree\Mapping\Driver\Fluent as FluentDriver;
use LaravelDoctrine\Fluent\Buildable;
use LaravelDoctrine\Fluent\Builders\Field;
use LaravelDoctrine\Fluent\Extensions\ExtensibleClassMetadata;

class TreePath implements Buildable
{
    const MACRO_METHOD = 'treePath';

    const DEFAULT_SEPARATOR = '|';

    /**
     * @var ExtensibleClassMetadata
     */
    protected $classMetadata;

    /**
     * @var string
     */
    protected $fieldName;

    /**
     * @var string
     */
    protected $separator = self::DEFAULT_SEPARATOR;

    /**
     * @var bool|null
     */
    protected $appendId = null;

    /**
     * @var bool
     */
    protected $startsWithSeparator = false;

    /**
     * @var bool
     */
    protected $endsWithSeparator = true;

    /**
     * @param ExtensibleClassMetadata $classMetadata
     * @param string                  $fieldName
     * @param string                  $separator
     */
    public function __construct(ExtensibleClassMetadata $classMetadata, $fieldName, $separator = self::DEFAULT_SEPARATOR)
    {
        $this->classMetadata = $classMetadata;
        $this->fieldName     = $fieldName;
        $this->separator     = $separator;
    }

    /**
     * Enable TreePath
     */
    public static function enable()
    {
        Field::macro(self::MACRO_METHOD, function (Field $field, $separator = '|') {
            return new static($field->getClassMetadata(), $field->getName(), $separator);

$field->getClassMetadata() of type object<Doctrine\ORM\Mapping\ClassMetadataInfo> is not a sub-type of object<LaravelDoctrine\Fluent\Extensions\ExtensibleClassMetadata>. It seems like you assume a child class of the class Doctrine\ORM\Mapping\ClassMetadataInfo to be always present.

        });
    }

    /**
     * @param string $separator
     *
     * @return TreePath
     */
    public function separator($separator)
    {
        $this->separator = $separator;

        return $this;
    }

    /**
     * @param bool $shouldIt
     *
     * @return TreePath
     */
    public function appendId($shouldIt = true)
    {
        $this->appendId = $shouldIt;

        return $this;
    }

    /**
     * @param bool $doesIt
     *
     * @return TreePath
     */
    public function startsWithSeparator($doesIt = true)
    {
        $this->startsWithSeparator = $doesIt;

        return $this;
    }

    /**
     * @param bool $doesIt
     *
     * @return TreePath
     */
    public function endsWithSeparator($doesIt = true)
    {
        $this->endsWithSeparator = $doesIt;

        return $this;
    }

    /**
     * Execute the build process
     */
    public function build()
    {
        if (strlen($this->separator) > 1) {
            throw new InvalidMappingException("Tree Path field - [{$this->fieldName}] Separator {$this->separator} is invalid. It must be only one character long.");
        }

        $this->classMetadata->mergeExtension($this->getExtensionName(), [
            'path'                       => $this->fieldName,
            'path_separator'             => $this->separator,
            'path_append_id'             => $this->appendId,
            'path_starts_with_separator' => $this->startsWithSeparator,
            'path_ends_with_separator'   => $this->endsWithSeparator,
        ]);
    }

    /**
     * Return the name of the actual extension.
     *
     * @return string
     */
    protected function getExtensionName()
    {
        return FluentDriver::EXTENSION_NAME;
    }
}