NewsContext.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\News\Data;
 
final class NewsContext
{
    public function __construct(
        private readonly int $ref_id,
        private ?int $obj_id = null,
        private ?string $obj_type = null,
        private ?int $parent_ref_id = null,
        private int $level = 0,
    ) {
    }
 
    /*
        Getters & Setters
     */
 
    public function getRefId(): int
    {
        return $this->ref_id;
    }
 
    public function getObjId(): ?int
    {
        return $this->obj_id;
    }
 
    public function getObjType(): ?string
    {
        return $this->obj_type;
    }
 
    public function getParentRefId(): ?int
    {
        return $this->parent_ref_id;
    }
 
    public function setObjId(int $obj_id): self
    {
        $this->obj_id = $obj_id;
        return $this;
    }
 
    public function setObjType(string $obj_type): self
    {
        $this->obj_type = $obj_type;
        return $this;
    }
 
    public function setParentRefId(?int $parent_ref_id): self
    {
        $this->parent_ref_id = $parent_ref_id;
        return $this;
    }
 
    public function setLevel(int $level): self
    {
        $this->level = $level;
        return $this;
    }
 
    public function getLevel(): int
    {
        return $this->level;
    }
 
    /*
        Accessor Methods
     */
 
    public function isChildOf(NewsContext $parent_context): bool
    {
        return $this->parent_ref_id === $parent_context->getRefId();
    }
 
    public function isParentOf(NewsContext $child_context): bool
    {
        return $child_context->getParentRefId() === $this->ref_id;
    }
 
    public function isRoot(): bool
    {
        return $this->parent_ref_id === null;
    }
 
    /*
        Optimized Serializing
     */
 
    public function normalize(): array
    {
        $vars = get_object_vars($this);
        return array_filter($vars);
    }
 
    public static function denormalize(array $raw): self
    {
        return new self(
            $raw['ref_id'],
            $raw['obj_id'] ?? null,
            $raw['obj_type'] ?? null,
            $raw['parent_ref_id'] ?? null,
            $raw['level'] ?? 0,
        );
    }
}