AbstractLayoutModification.php

Go to the documentation of this file.

<?php namespace ILIAS\GlobalScreen\Scope\Layout\Factory;

use Closure;
use LogicException;
use ReflectionFunction;

abstract class AbstractLayoutModification implements LayoutModification
{

    private $priority;
    private $modification = null;


    public function isFinal() : bool
    {
        return false;
    }


    public function getPriority() : int
    {
        return $this->priority ?? LayoutModification::PRIORITY_LOW;
    }


    final public function withPriority(int $priority) : LayoutModification
    {
        if ((self::PRIORITY_LOW > $priority) || ($priority > self::PRIORITY_HIGH)) {
            throw new LogicException("\$priority MUST be between LayoutModification::PRIORITY_LOW, LayoutModification::PRIORITY_MEDIUM or LayoutModification::PRIORITY_HIGH");
        }
        $clone = clone $this;
        $clone->priority = $priority;

        return $clone;
    }


    final public function withHighPriority() : LayoutModification
    {
        $clone = clone $this;
        $clone->priority = LayoutModification::PRIORITY_HIGH;

        return $clone;
    }


    final public function withLowPriority() : LayoutModification
    {
        $clone = clone $this;
        $clone->priority = LayoutModification::PRIORITY_LOW;

        return $clone;
    }


    final public function withModification(Closure $closure) : LayoutModification
    {
        $clone = clone $this;
        $clone->modification = $closure;

        return $clone;
    }


    final public function getModification() : Closure
    {
        return $this->modification;
    }


    final public function hasValidModification() : bool
    {
        return ($this->modification instanceof Closure && $this->checkClosure());
    }


    private function checkClosure() : bool
    {
        $closure = $this->modification;
        $return_type = $this->getClosureReturnType();

        try {
            $r = new ReflectionFunction($closure);
            // First Argument
            if (!$this->firstArgumentAllowsNull()) {
                $first_argument_type = $this->getClosureFirstArgumentType();
                if (!isset($r->getParameters()[0])
                    || !$r->getParameters()[0]->hasType()
                    || ($r->getParameters()[0]->getType()->getName() !== $first_argument_type)
                ) {
                    return false;
                }
            }

            // Return type
            if (!$this->returnTypeAllowsNull()) {
                if (!$r->hasReturnType()
                    || ($r->getReturnType()->getName() !== $return_type)
                ) {
                    return false;
                }
            }
        } catch (\ReflectionException $e) {
            return false;
        }

        return true;
    }
}