ClassVisitor.php

<?php

/*
 * © 2016 IRSTEA
 * Guillaume Perréal <guillaume.perreal@irstea.fr>
 * Tous droits réservés.
 */

namespace Irstea\PlantUmlBundle\Model;

use Irstea\PlantUmlBundle\Model\Decorator\NullDecorator;
use Irstea\PlantUmlBundle\Model\Filter\AcceptAllFilter;
use Irstea\PlantUmlBundle\Model\Namespace_\RootNamespace;
use Irstea\PlantUmlBundle\Model\Node\Class_;
use Irstea\PlantUmlBundle\Model\Node\Interface_;
use Irstea\PlantUmlBundle\Model\Node\Trait_;
use Irstea\PlantUmlBundle\Writer\WritableInterface;
use Irstea\PlantUmlBundle\Writer\WritableNodeInterface;
use Irstea\PlantUmlBundle\Writer\WriterInterface;
use ReflectionClass;

/**
 * Description of Visitor
 *
 * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
 */
class ClassVisitor implements ClassVisitorInterface, WritableInterface
{
    /**
     * @var RootNamespace
     */
    protected $rootNamespace;

    /**
     * @var ClassFilterInterface
     */
    protected $filter;

    /**
     * @var DecoratorInterface
     */
    protected $decorator;

    public function __construct(DecoratorInterface $decorator = null, ClassFilterInterface $filter = null)
    {
        $this->rootNamespace = new RootNamespace();
        $this->filter = $filter ?: AcceptAllFilter::instance();
        $this->decorator = $decorator ?: NullDecorator::instance();
    }

    /**
     * @param ClassFilterInterface $filter
     * @return self
     */
    public function setClassFilter(ClassFilterInterface $filter)
    {
        $this->filter = $filter;
        return $this;
    }

    /**
     * @param DecoratorInterface $decorator
     * @return self
     */
    public function setDecorator(DecoratorInterface $decorator)
    {
        $this->decorator = $decorator;
        return $this;
    }

    public function visitClass($className)
    {
        assert('is_string($className)', $className);
        if (isset($this->nodes[$className])) {
            return $this->nodes[$className];
        }

        $class = new ReflectionClass($className);

        if (!$this->filter->accept($class)) {
            return $this->nodes[$className] = false;
        }

        $namespace = $this->rootNamespace->getNamespace($class->getNamespaceName());
        $node = $this->nodes[$className] = $this->createNode($namespace, $class);
        $namespace->addNode($node);

        $this->decorator->decorate($class, $node, $this);

        return $node;
    }

    /**
     *
     * @param NamespaceInterface $namespace
     * @param ReflectionClass $class
     * @return NodeInterface
     */
    protected function createNode(NamespaceInterface $namespace, ReflectionClass $class)
    {
        if ($class->isTrait()) {
            return new Trait_($namespace, $class->getName());
        }

        if ($class->isInterface()) {
            return new Interface_($namespace, $class->getName());
        }

        return new Class_($namespace, $class->getName(), $class->isAbstract(), $class->isFinal());
    }

    public function outputTo(WriterInterface $writer)
    {
        return $this->rootNamespace->outputTo($writer);
    }
}