AbstractComponentRenderer.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2016 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

namespace ILIAS\UI\Implementation\Render;

use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\JavaScriptBindable;
use ILIAS\UI\Factory;

abstract class AbstractComponentRenderer implements ComponentRenderer {
        private $ui_factory;

        private $tpl_factory;

        private $lng;

        private $js_binding;

        final public function __construct(Factory $ui_factory, TemplateFactory $tpl_factory, \ilLanguage $lng, JavaScriptBinding $js_binding) {
                $this->ui_factory = $ui_factory;
                $this->tpl_factory = $tpl_factory;
                $this->lng = $lng;
                $this->js_binding = $js_binding;
        }

        public function registerResources(ResourceRegistry $registry) {
        }

        final protected function getUIFactory() {
                return $this->ui_factory;
        }

        final public function txt($id) {
                return $this->lng->txt($id);
        }

        final protected function getTemplate($name, $purge_unfilled_vars, $purge_unused_blocks) {
                $component = $this->getMyComponent();
                $path = "src/UI/templates/default/$component/$name";
                return $this->tpl_factory->getTemplate($path, $purge_unfilled_vars, $purge_unused_blocks);
        }

        final protected function bindJavaScript(JavaScriptBindable $component) {
                $binder = $component->getOnLoadCode();
                if ($binder === null) {
                        return null;
                }
                $id = $this->js_binding->createId();
                $on_load_code = $binder($id);
                if (!is_string($on_load_code)) {
                        throw new \LogicException(
                                "Expected JavaScript binder to return string".
                                " (used component: ".get_class($component).")");
                }
                $this->js_binding->addOnLoadCode($on_load_code);
                return $id;
        }


        final protected function checkComponent(Component $component) {
                $interfaces = $this->getComponentInterfaceName();
                if(!is_array($interfaces)){
                        throw new \LogicException(
                                        "Expected array, found '".(string)(null)."' when rendering.");
                }

                foreach ($interfaces as $interface) {
                        if ($component instanceof $interface) {
                                return;
                        }
                }
                $ifs = implode(", ", $interfaces);
                throw new \LogicException(
                        "Expected $ifs, found '".get_class($component)."' when rendering.");
        }

        abstract protected function getComponentInterfaceName();

        // TODO: We might want to cache this.
        private function getMyComponent() {
                $class = get_class($this);
                $matches = array();
                // Extract component
                $re = "%ILIAS\\\\UI\\\\Implementation\\\\Component\\\\(\\w+)\\\\(\\w+)%";
                if (preg_match($re, $class, $matches) !== 1) {
                        throw new \LogicException(
                                "The Renderer needs to be located in ILIAS\\UI\\Implementation\\Component\\*.");
                }
                return $matches[1];
        }
}