ComponentHelper.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\Component;
 
use ILIAS\UI\Component\Signal;
 
trait ComponentHelper
{
    private $canonical_name = null;
 
    public function getCanonicalName()
    {
        if ($this->canonical_name === null) {
            $this->canonical_name = $this->getCanonicalNameByFullyQualifiedName();
        }
        return $this->canonical_name;
    }
 
    protected function getCanonicalNameByFullyQualifiedName()
    {
        $cls = explode("\\", get_class($this));
        $name = [];
        $cur = array_pop($cls);
        while ($cur !== "Component" && count($cls) > 0) {
            $name[] = preg_replace("%([a-z])([A-Z])%", "$1 $2", $cur);
            $cur = array_pop($cls);
        }
        return implode(" ", $name);
    }
 
    protected function checkArg($which, $check, $message)
    {
        assert(is_string($which));
        assert(is_bool($check));
        assert(is_string($message));
        if (!$check) {
            throw new \InvalidArgumentException("Argument '$which': $message");
        }
    }
 
    protected function checkIntArg($which, $value)
    {
        $this->checkArg($which, is_int($value), $this->wrongTypeMessage("integer", $value));
    }
 
    protected function checkStringArg($which, $value)
    {
        $this->checkArg($which, is_string($value), $this->wrongTypeMessage("string", $value));
    }
 
    protected function checkStringOrSignalArg($which, $value)
    {
        $this->checkArg(
            $which,
            is_string($value) || $value instanceof Signal,
            $this->wrongTypeMessage("string or Signal", gettype($value))
        );
    }
 
    protected function checkFloatArg($which, $value)
    {
        $this->checkArg($which, is_float($value), $this->wrongTypeMessage("float", $value));
    }
 
    protected function checkBoolArg($which, $value)
    {
        $this->checkArg($which, is_bool($value), $this->wrongTypeMessage("bool", $value));
    }
 
    protected function checkArgInstanceOf($which, $value, $class)
    {
        $this->checkArg($which, $value instanceof $class, $this->wrongTypeMessage($class, $value));
    }
 
    protected function checkArgIsElement($which, $value, $array, $name)
    {
        if (!is_object($value)) {
            $message = "expected $name, got '$value'";
        } else {
            $message = "expected $name, got object.";
        }
        $message =
        $this->checkArg($which, in_array($value, $array), $message);
    }
 
    protected function checkArgList($which, array &$values, \Closure $check, \Closure $message)
    {
        $failed_k = null;
        $failed_v = null;
        foreach ($values as $key => $value) {
            $ok = $check($key, $value);
            if (!$ok) {
                $failed_k = $key;
                $failed_v = $value;
                break;
            }
        }
 
        if ($failed_k !== null) {
            $m = $message($failed_k, $failed_v);
        } else {
            $m = "";
        }
 
        $this->checkArg($which, $failed_k === null, $m);
    }
 
    protected function checkArgListElements($which, array &$values, $classes)
    {
        $classes = $this->toArray($classes);
        $this->checkArgList($which, $values, function ($_, $value) use (&$classes) {
            foreach ($classes as $cls) {
                if ($cls === "string" && is_string($value)) {
                    return true;
                }
                if ($cls === "int" && is_int($value)) {
                    return true;
                } elseif ($value instanceof $cls) {
                    return true;
                }
            }
            return false;
        }, function ($_, $failed) use (&$classes) {
            return $this->wrongTypeMessage(implode(", ", $classes), $failed);
        });
    }
 
    protected function toArray($value)
    {
        if (is_array($value)) {
            return $value;
        }
        return array($value);
    }
 
    protected function wrongTypeMessage($expected, $value)
    {
        $type = gettype($value);
        if (!is_object($value) && !is_array($value)) {
            return "expected $expected, got $type '$value'";
        } else {
            if (is_object($value)) {
                $type = get_class($value);
            }
            return "expected $expected, got $type";
        }
    }
}