CloudPlayDev / confluence-php-client

src/Entity/AbstractContent.php

<?php
declare(strict_types=1);

namespace CloudPlayDev\ConfluenceClient\Entity;


use CloudPlayDev\ConfluenceClient\Api\Content;
use CloudPlayDev\ConfluenceClient\Exception\HydrationException;
use Webmozart\Assert\Assert;

abstract class AbstractContent implements Hydratable
{
    private ?int $id = null;
    private ?string $title = null;
    private ?string $space = null;

    private ?string $content = null;

    /**
     * @var int[]
     */
    private array $ancestors = [];

    private int $version = 1;
    /**
     * @var array<string, string> $children
     */
    private array $children = [];
    private ?string $url = null;
    protected string $type = Content::CONTENT_TYPE_GLOBAL;

    private ?int $containerId = null;
    private string $containerType = Content::CONTENT_TYPE_PAGE;

    private bool $isLatest = true;

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return self
     */
    public function setType(string $type): self
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return int|null
     */
    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * @param int $id
     * @return self
     */
    public function setId(int $id): self
    {
        $this->id = $id;
        return $this;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    /**
     * @param string $title
     * @return self
     */
    public function setTitle(string $title): self
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getSpace(): ?string
    {
        return $this->space;
    }

    /**
     * @param string|null $space
     * @return self
     */
    public function setSpace(?string $space): self
    {
        $this->space = $space;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getContent(): ?string
    {
        return $this->content;
    }

    /**
     * @param string $content
     * @return self
     */
    public function setContent(string $content): self
    {
        $this->content = $content;
        return $this;
    }

    /**
     * @return int
     */
    public function getVersion(): int
    {
        return $this->version;
    }

    /**
     * @param int $version
     * @return self
     */
    public function setVersion(int $version): self
    {
        $this->version = $version;
        return $this;
    }

    /**
     * @return array<string, string>
     */
    public function getChildren(): array
    {
        return $this->children;
    }

    /**
     * @param array<string, string> $children
     * @return self
     */
    public function setChildren(array $children): self
    {
        $this->children = $children;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getUrl(): ?string
    {
        return $this->url;
    }

    /**
     * @param string $url
     * @return self
     */
    public function setUrl(string $url): self
    {
        $this->url = $url;
        return $this;
    }

    /**
     * @param string $comment
     * @return ContentComment
     */
    public function createComment(string $comment): ContentComment
    {
        $contentComment = new ContentComment();
        $contentComment->setContainerId($this->getId());
        $contentComment->setContainerType($this->getType());
        $contentComment->setContent($comment);
        $contentComment->setSpace($this->getSpace());
        return $contentComment;
    }

    /**
     * @param string $title
     * @param string $body
     * @return ContentPage
     */
    public function createSubpage(string $title, string $body): ContentPage
    {
        $contentPage = new ContentPage();
        $contentPage->setContent($body);
        $contentPage->setTitle($title);
        $contentPage->setSpace($this->getSpace());
        if ($this->id) {

The expression $this->id of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $contentPage->addAncestor($this->id);
        }
        return $contentPage;
    }

    /**
     * @return int|null
     */
    public function getContainerId(): ?int
    {
        return $this->containerId;
    }

    /**
     * @param int|null $containerId
     */
    public function setContainerId(?int $containerId): void
    {
        $this->containerId = $containerId;
    }

    /**
     * @return string
     */
    public function getContainerType(): string
    {
        return $this->containerType;
    }

    /**
     * @param string $containerType
     */
    public function setContainerType(string $containerType): void
    {
        $this->containerType = $containerType;
    }

    /**
     * @return int[]
     */
    public function getAncestors(): array
    {
        return $this->ancestors;
    }

    /**
     * @param int[] $ancestors
     * @return self
     */
    public function setAncestors(array $ancestors): self
    {
        $this->ancestors = $ancestors;
        return $this;
    }

    /**
     * @param int $id
     * @return self
     */
    public function addAncestor(int $id): self
    {
        $this->ancestors[] = $id;
        return $this;
    }

    /**
     * @param mixed[] $data
     * @return AbstractContent|ContentPage|ContentComment
     * @throws HydrationException
     */
    public static function load(array $data): ContentComment|AbstractContent|ContentPage
    {
        /* handle older content versions */
        if(isset($data['content'], $data['when'])) {
            return self::load($data['content']);
        }

        Assert::true(isset($data['id'],
            $data['type'],
            $data['title'],
            $data['_links']['self']));
        Assert::string($data['type']);

        $content = match ($data['type']) {
            Content::CONTENT_TYPE_PAGE => new ContentPage(),
            Content::CONTENT_TYPE_COMMENT => new ContentComment(),
            default => throw new HydrationException('Invalid content type: ' . $data['type']),
        };

        $content->setId((int)$data['id']);
        $content->setTitle((string)$data['title']);
        $content->setUrl((string)$data['_links']['self']);
        if (isset($data['space']['key'])) {
            $content->setSpace((string)$data['space']['key']);
        }
        if (isset($data['version']['number'])) {
            $content->setVersion((int)$data['version']['number']);
        }
        if (isset($data['body']['storage']['value'])) {
            Assert::isArray($data['body']['storage']);
            $content->setContent((string)$data['body']['storage']['value']);
        }

        if(isset($data['status'])) {
            Assert::string($data['status']);
            $content->setLatest($data['status'] === 'current');
        }

        return $content;
    }

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

    protected function setLatest(bool $isLatest): AbstractContent
    {
        $this->isLatest = $isLatest;
        return $this;
    }


}