PersonalGalaxy\Files\Entity\Folder

Complexity

Total Complexity

16

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Test Coverage

Coverage

97.78%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	3	1
A	identity()	0	3	1
A	restore()	0	10	2
A	parent()	0	3	1
A	trashed()	0	3	1
A	add()	0	9	1
A	__construct()	0	8	1
A	rename()	0	10	2
A	moveTo()	0	10	2
A	trash()	0	10	2
A	remove()	0	7	2

<?php
declare(strict_types = 1);

namespace PersonalGalaxy\Files\Entity;

use PersonalGalaxy\Files\{
    Entity\Folder\Identity,
    Entity\Folder\Name,
    Event\FolderWasAdded,
    Event\FolderWasTrashed,
    Event\FolderWasRestored,
    Event\FolderWasRemoved,
    Event\FolderWasRenamed,
    Event\FolderWasMovedToADifferentParent,
    Exception\LogicException,
};
use Innmind\EventBus\{
    ContainsRecordedEventsInterface,
    EventRecorder,
};

final class Folder implements ContainsRecordedEventsInterface
{
    use EventRecorder;

    private $identity;
    private $name;
    private $parent;
    private $trashed = false;

    private function __construct(
        Identity $identity,
        Name $name,
        Identity $parent
    ) {
        $this->identity = $identity;
        $this->name = $name;
        $this->parent = $parent;
    }

    public static function add(
        Identity $identity,
        Name $name,
        Identity $parent
    ): self {
        $self = new self($identity, $name, $parent);
        $self->record(new FolderWasAdded($identity, $name, $parent));

        return $self;
    }

    public function identity(): Identity
    {
        return $this->identity;
    }

    public function name(): Name
    {
        return $this->name;
    }

    public function parent(): Identity
    {
        return $this->parent;
    }

    public function trashed(): bool
    {
        return $this->trashed;
    }

    public function rename(Name $name): self
    {
        if ($name->equals($this->name)) {
            return $this;
        }

        $this->name = $name;
        $this->record(new FolderWasRenamed($this->identity, $name));

        return $this;
    }

    public function moveTo(Identity $parent): self
    {
        if ($parent->equals($this->parent)) {
            return $this;
        }

        $this->parent = $parent;
        $this->record(new FolderWasMovedToADifferentParent($this->identity, $parent));

        return $this;
    }

    public function trash(): self
    {
        if ($this->trashed) {
            return $this;
        }

        $this->trashed = true;
        $this->record(new FolderWasTrashed($this->identity));

        return $this;
    }

    public function restore(): self
    {
        if (!$this->trashed) {
            return $this;
        }

        $this->trashed = false;
        $this->record(new FolderWasRestored($this->identity));

        return $this;
    }

    /**
     * Last method that can be called, here only to record the event
     */
    public function remove(): void
    {
        if (!$this->trashed) {
            throw new LogicException;
        }

        $this->record(new FolderWasRemoved($this->identity));
    }
}