Gorynych\Resource\AbstractResource

Complexity

Total Complexity

2

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getOperations()	0	3	1
A	addOperation()	0	4	1

<?php
/**
 * Copyright (c) 2020.
 * @author Paweł Antosiak <contact@pawelantosiak.com>
 */

declare(strict_types=1);

namespace Gorynych\Resource;

use Cake\Collection\Collection;
use Gorynych\Operation\ResourceOperationInterface;

abstract class AbstractResource
{
    public const NUMERIC_ID = '(?P<id>[\d]+)';
    public const ALNUM_ID = '(?P<id>[\w]+)';

    public ?string $id;

    /** @var ResourceOperationInterface[] */
    protected array $operations = [];

    /**
     * Returns path of the resource
     *
     * @return string
     * @example '/resources/'
     * @example '/resources/' . $this->id ?? self::NUMERIC_ID
     */
    abstract public function getPath(): string;

    /**
     * Adds given operation to the resource
     *
     * @param ResourceOperationInterface $operation
     */
    public function addOperation(ResourceOperationInterface $operation): void
    {
        $operation->setResource($this);
        $this->operations[] = $operation;
    }

    /**
     * @return ResourceOperationInterface[]|Collection
     */
    public function getOperations(): Collection
    {
        return new Collection($this->operations);
    }
}