class.ilPageComponentPlugin.php

Go to the documentation of this file.

<?php

abstract class ilPageComponentPlugin extends ilPlugin
{
    public const TXT_CMD_INSERT = "cmd_insert";
    public const CMD_INSERT = "insert";
    public const CMD_EDIT = "edit";

    private ?ilPageObject $page_obj = null;
    protected string $mode;

    abstract public function isValidParentType(string $a_type): bool;

    public function getJavascriptFiles(string $a_mode): array
    {
        return array();
    }

    public function getCssFiles(string $a_mode): array
    {
        return array();
    }

    final public function setMode(string $a_mode): void
    {
        $this->mode = $a_mode;
    }

    final public function getMode(): string
    {
        return $this->mode;
    }

    public function getUIClassInstance(): ilPageComponentPluginGUI
    {
        $class = "il" . $this->getPluginName() . "PluginGUI";
        $obj = new $class();
        $obj->setPlugin($this);
        return $obj;
    }

    public function setPageObj(ilPageObject $a_page_obj): void
    {
        $this->page_obj = $a_page_obj;
    }

    public function getPageId(): int
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getId();
        }
        return 0;
    }

    public function getParentId(): int
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentId();
        }
        return 0;
    }

    public function getParentType(): string
    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentType();
        }
        return '';
    }

    public function onClone(
        array &$a_properties,
        string $a_plugin_version
    ): void {
    }

    public function afterRepositoryCopy(
        array &$a_properties,
        array $mapping,
        int $source_ref_id,
        string $a_plugin_version
    ): void {
    }

    public function onDelete(
        array $a_properties,
        string $a_plugin_version,
        bool $move_operation = false
    ): void {
    }
}