Osnova\Services\Timeline\Traits\TimelineService

Complexity

Total Complexity

5

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTimelineSearchResults()	0	3	1
A	getTimelineEntries()	0	6	1
A	getTimelineService()	0	7	2
A	getTimelineEntry()	0	3	1

<?php

namespace Osnova\Services\Timeline\Traits;

use Osnova\Api\ApiProvider;
use Osnova\Services\Timeline\Entry;
use Osnova\Services\Timeline\Interfaces\TimelineOwnerInterface;
use Osnova\Services\Timeline\Requests\TimelineRequest;
use Osnova\Services\Timeline\Timeline;

trait TimelineService
{
    /** @var Timeline|null */
    private $timeline;

    /**
     * Get the resource API Provider instance.
     *
     * @return ApiProvider
     */
    abstract public function getApiProvider();

    /**
     * Get the timeline service instance.
     *
     * @return Timeline
     */
    public function getTimelineService()
    {
        if (is_null($this->timeline)) {
            return $this->timeline = new Timeline($this->getApiProvider());
        }

        return $this->timeline;
    }

    /**
     * Get timeline entries list.
     * This is a proxy method for Timeline::getTimeline().
     *
     * @param TimelineOwnerInterface $owner   Timeline owner.
     * @param TimelineRequest        $request = null Timeline request parameters.
     *
     * @see Timeline::getTimeline()
     *
     * @return array|Entry[]
     */
    public function getTimelineEntries(TimelineOwnerInterface $owner, TimelineRequest $request = null)
    {
        return $this->getTimelineService()->getTimeline(
            $owner,
            $request ?? new TimelineRequest(),
            $this

$this of type Osnova\Services\Timeline\Traits\TimelineService is incompatible with the type Osnova\OsnovaResource|null expected by parameter $resource of Osnova\Services\Timeline\Timeline::getTimeline().

        );
    }

    /**
     * Get timeline search results.
     * This is a proxy method for Timeline::getTimelineSearchResults().
     *
     * @param string $query   Query string.
     * @param string $orderBy Ordering method (`relevant` or `date`).
     * @param int    $page    = 1 Results page.
     *
     * @see Timeline::getTimelineSearchResults()
     *
     * @return array|Entry[]
     */
    public function getTimelineSearchResults(string $query, string $orderBy = 'relevant', int $page = 1)
    {
        return $this->getTimelineService()->getTimelineSearchResults($query, $orderBy, $page, $this);

$this of type Osnova\Services\Timeline\Traits\TimelineService is incompatible with the type Osnova\OsnovaResource|null expected by parameter $resource of Osnova\Services\Timeline\Timeline::getTimelineSearchResults().

    }

    /**
     * Get timeline entry by ID.
     * This is a proxy method for Timeline::getTimelineEntry().
     *
     * @param int $id Entry ID.
     *
     * @see Timeline::getTimeline()
     *
     * @return Entry|null
     */
    public function getTimelineEntry($id)
    {
        return $this->getTimelineService()->getTimelineEntry($id, $this);

$this of type Osnova\Services\Timeline\Traits\TimelineService is incompatible with the type Osnova\OsnovaResource|null expected by parameter $resource of Osnova\Services\Timeline\Timeline::getTimelineEntry().

    }
}