ICanBoogie / ActiveRecord

lib/ActiveRecord/RelationNotDefined.php

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\ActiveRecord;

use ICanBoogie\Accessor\AccessorTrait;
use ICanBoogie\OffsetNotDefined;
use Throwable;

/**
 * Exception thrown in attempt to obtain a relation that is not defined.
 *
 * @property-read string $relation_name Name of the undefined relation.
 * @property-read RelationCollection $collection Relation collection.
 */
class RelationNotDefined extends OffsetNotDefined implements Exception
{
    /**
     * @uses get_relation_name
     * @uses get_collection
     */
    use AccessorTrait;

    /**
     * Name of the undefined relation.
     */
    private string $relation_name;

    private function get_relation_name(): string

The method get_relation_name() is not used, and could be removed.

    {
        return $this->relation_name;
    }

    private RelationCollection $collection;

    private function get_collection(): RelationCollection

The method get_collection() is not used, and could be removed.

    {
        return $this->collection;
    }

    public function __construct(
        string $relation_name,
        RelationCollection $collection,
        Throwable $previous = null
    ) {
        $this->relation_name = $relation_name;

The property relation_name is declared read-only in ICanBoogie\ActiveRecord\RelationNotDefined.

        $this->collection = $collection;

The property collection is declared read-only in ICanBoogie\ActiveRecord\RelationNotDefined.

        parent::__construct([ $relation_name, $collection ], $previous);
    }
}