icingaweb2/library/Icinga/Web/Dashboard/Common/BaseDashboard.php

<?php

/* Icinga Web 2 | (c) 2022 Icinga GmbH | GPLv2+ */

namespace Icinga\Web\Dashboard\Common;

/**
 * Base class for all dashboard widget types
 *
 * All Icinga Web dashboard widgets should extend this class
 */
abstract class BaseDashboard implements DashboardEntry
{
    /**
     * Not translatable name of this widget
     *
     * @var string
     */
    protected $name;

    /**
     * The title of this widget
     *
     * @var string
     */
    protected $title;

    /**
     * Unique identifier of this widget
     *
     * @var int|string
     */
    protected $uuid;

    /**
     * The widget's description
     *
     * @var string
     */
    protected $description;

    /**
     * The priority order of this widget
     *
     * @var int
     */
    protected $order = 0;

    /**
     * Name of the owner/creator of this widget
     *
     * @var string
     */
    protected $owner;

    /**
     * Create a new widget
     *
     * @param string $name
     * @param array $properties
     */
    public function __construct(string $name, array $properties = [])
    {
        $this->name = $name;
        $this->title = $name;

        if (! empty($properties)) {
            $this->setProperties($properties);
        }
    }

    /**
     * Set this widget's unique identifier
     *
     * @param int|string $uuid
     *
     * @return $this
     */
    public function setUuid($uuid): self
    {
        $this->uuid = $uuid;

        return $this;
    }

    /**
     * Get this widget's unique identifier
     *
     * @return string|int
     */
    public function getUuid()
    {
        return $this->uuid;
    }

    /**
     * Set the name of this widget
     *
     * @param string $name
     *
     * @return $this
     */
    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Returns the name of this widget
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

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

        return $this;
    }

    /**
     * Returns the title of this widget
     *
     * @return string
     */
    public function getTitle(): string
    {
        return $this->title !== null ? $this->title : $this->getName();
    }

    /**
     * Set the owner of this widget
     *
     * @param string $owner
     *
     * @return $this
     */
    public function setOwner(string $owner): self
    {
        $this->owner = $owner;

        return $this;
    }

    /**
     * Get owner of this widget
     *
     * @return ?string
     */
    public function getOwner()
    {
        return $this->owner;
    }

    /**
     * Get the widget's description
     *
     * @return ?string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Set the widget's description
     *
     * @param ?string $description
     *
     * @return  $this
     */
    public function setDescription(string $description = null): self
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Set the priority order of this widget
     *
     * @param int $order
     *
     * @return $this
     */
    public function setPriority(int $order): self
    {
        $this->order = $order;

        return $this;
    }

    /**
     * Get the priority order of this widget
     *
     * @return int
     */
    public function getPriority(): int
    {
        return $this->order;
    }

    /**
     * Set properties from the given list (no matching setter) are ignored
     *
     * @param array $data
     *
     * @return $this
     */
    public function setProperties(array $data): self
    {
        foreach ($data as $name => $value) {
            $func = 'set' . ucfirst($name);
            if (method_exists($this, $func)) {
                $this->$func($value);
            }
        }

        return $this;
    }

    /**
     * Get this class's structure as array
     *
     * Stringifies the attrs or set to null if it doesn't have a value, when $stringify is true
     *
     * @param bool $stringify Whether, the attributes should be returned unmodified
     *
     * @return array
     */
    public function toArray(bool $stringify = true): array
    {
        return [];
    }

    public function hasEntries()
    {
    }

    public function getEntry(string $name)
    {
    }

    public function hasEntry(string $name)
    {
    }

    public function getEntries()
    {
    }

    public function setEntries(array $entries)
    {
    }

    public function addEntry(BaseDashboard $dashboard)
    {
    }

    public function createEntry(string $name, $url = null)
    {
    }

    public function getEntryKeyTitleArr()
    {
    }

    public function removeEntry($entry)
    {
    }

    public function removeEntries(array $entries = [])
    {
    }

    public function manageEntry($entry, BaseDashboard $origin = null, bool $manageRecursive = false)
    {
    }

    public function loadDashboardEntries(string $name = '')
    {
    }

    public function rewindEntries()
    {
    }
}