Astrotomic\Stancy\Models\Page

Complexity

Total Complexity

22

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	2

14 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	3	2
A	render()	0	7	2
A	view()	0	5	1
A	toHtml()	0	3	1
A	toResponse()	0	7	2
A	page()	0	13	3
A	make()	0	5	1
A	data()	0	7	1
A	makeFromSheet()	0	9	2
A	parse()	0	9	2
A	toJson()	0	3	1
A	__construct()	0	5	1
A	jsonSerialize()	0	3	1
A	toFeedItem()	0	7	2

<?php

namespace Astrotomic\Stancy\Models;

use Exception;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Htmlable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Contracts\Support\Renderable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Contracts\View\Factory as ViewFactory;
use Illuminate\Contracts\View\View;
use JsonSerializable;
use Spatie\Feed\Feedable;
use Spatie\Feed\FeedItem;
use Spatie\Sheets\Facades\Sheets;
use Symfony\Component\HttpFoundation\Response;

class Page implements Htmlable, Renderable, Responsable, Arrayable, Jsonable, JsonSerializable, Feedable
{
    /** @var string|null */
    protected $view;

    /** @var string|null */
    protected $page;

    /** @var PageData|array */

@var annotation of property \Astrotomic\Stancy\Models\Page::$data does not specify type hint for its items.

    protected $data = [];

    /** @var ViewFactory */
    protected $viewFactory;

    public function __construct(ViewFactory $viewFactory, array $data = [], ?string $page = null)

Method \Astrotomic\Stancy\Models\Page::__construct() does not have @param annotation for its traversable parameter $data.

    {
        $this->viewFactory = $viewFactory;
        $this->data($data);
        $this->page($page);
    }

    public static function make(array $data = [], ?string $page = null): self

Method \Astrotomic\Stancy\Models\Page::make() does not have @param annotation for its traversable parameter $data.

    {
        return app(static::class, [

The expression return app(static::class, array('data' => $data, 'page' => $page)) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return Astrotomic\Stancy\Models\Page. Consider adding an additional type-check to rule them out.

            'data' => $data,
            'page' => $page,
        ]);
    }

    public static function makeFromSheet(string $collection, string $name, ?string $page = null): self
    {
        $sheet = Sheets::collection($collection)->get($name);

        if ($sheet === null) {
            throw new Exception(sprintf('No sheet found in collection [%s] with name [%s].', $collection, $name));
        }

        return static::make($sheet->toArray(), $page);
    }

    public function page(?string $page): self
    {
        if (is_string($page)) {
            if (! is_subclass_of($page, PageData::class, true)) {
                throw new Exception(sprintf('The page data class [%s] has to extend %s.', $page, PageData::class));
            }
        }

        $this->page = $page;

        $this->parse();

        return $this;
    }

    public function data(array $data): self

Method \Astrotomic\Stancy\Models\Page::data() does not have @param annotation for its traversable parameter $data.

    {
        $this->data = $data;

        $this->parse();

        return $this;
    }

    public function view(string $view): self
    {
        $this->view = $view;

        return $this;
    }

    public function render(): View
    {
        if (empty($this->view)) {
            throw new Exception('You have to define a view before the page can render.');
        }

        return $this->viewFactory->make($this->view, $this->data);
    }

    public function toHtml(): string
    {
        return $this->render()->render();

The expression return $this->render()->render() could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function toArray(): array

Method \Astrotomic\Stancy\Models\Page::toArray() does not have @return annotation for its traversable return value.

    {
        return is_array($this->data) ? $this->data : $this->data->toArray();
    }

    public function jsonSerialize(): array

Method \Astrotomic\Stancy\Models\Page::jsonSerialize() does not have @return annotation for its traversable return value.

    {
        return $this->toArray();
    }

    /** {@inheritdoc} */
    public function toJson($options = 0): string
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /** {@inheritdoc} */
    public function toResponse($request): Response
    {
        if ($request->wantsJson()) {
            return response()->json($this->jsonSerialize());
        }

        return response($this->render());
    }

    public function toFeedItem(): FeedItem
    {
        if (! ($this->data instanceof PageData)) {
            throw new Exception(sprintf('The page data has to extend %s to allow transformation to %s.', PageData::class, FeedItem::class));
        }

        return $this->data->toFeedItem();
    }

    protected function parse(): void
    {
        if ($this->page === null) {
            return;
        }

        $this->data = forward_static_call(
            [$this->page, 'make'],
            $this->toArray()
        );
    }
}