Enumeration.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Type;
 
use ‪TYPO3\CMS\Core\Type\Exception\InvalidEnumerationDefinitionException;
use ‪TYPO3\CMS\Core\Type\Exception\InvalidEnumerationValueException;
 
abstract class ‪Enumeration implements ‪TypeInterface
{
    protected ‪$value;
 
    protected static ‪$enumConstants;
 
    public function ‪__construct(‪$value = null)
    {
        trigger_error('Class ' . __CLASS__ . ' used by enumeration ' . static::class . ' will be removed in TYPO3 v14.0. Use native enums instead.', E_USER_DEPRECATED);
 
        if (‪$value === null && !defined('static::__default')) {
            throw new ‪InvalidEnumerationValueException(
                sprintf('A value for enumeration "%s" is required if no __default is defined.', static::class),
                1381512753
            );
        }
        if (‪$value === null) {
            ‪$value = static::__default;
        }
        static::loadValues();
        if (!$this->‪isValid(‪$value)) {
            throw new ‪InvalidEnumerationValueException(
                sprintf('Invalid value "%s" for enumeration "%s"', ‪$value, static::class),
                1381512761
            );
        }
        $this->‪setValue(‪$value);
    }
 
    protected static function ‪loadValues()
    {
        $class = static::class;
 
        if (isset(static::$enumConstants[$class])) {
            return;
        }
 
        $reflection = new \ReflectionClass($class);
        $constants = $reflection->getConstants();
        $defaultValue = null;
        if (isset($constants['__default'])) {
            $defaultValue = $constants['__default'];
            unset($constants['__default']);
        }
        if (empty($constants)) {
            throw new ‪InvalidEnumerationValueException(
                sprintf(
                    'No constants defined in enumeration "%s"',
                    $class
                ),
                1381512807
            );
        }
        foreach ($constants as $constant => ‪$value) {
            if (!is_int(‪$value) && !is_string(‪$value)) {
                throw new ‪InvalidEnumerationDefinitionException(
                    sprintf(
                        'Constant value "%s" of enumeration "%s" must be of type integer or string, got "%s" instead',
                        $constant,
                        $class,
                        get_debug_type(‪$value)
                    ),
                    1381512797
                );
            }
        }
        $constantValueCounts = array_count_values($constants);
        arsort($constantValueCounts, SORT_NUMERIC);
        $constantValueCount = current($constantValueCounts);
        $constant = key($constantValueCounts);
        if ($constantValueCount > 1) {
            throw new ‪InvalidEnumerationDefinitionException(
                sprintf(
                    'Constant value "%s" of enumeration "%s" is not unique (defined %d times)',
                    $constant,
                    $class,
                    $constantValueCount
                ),
                1381512859
            );
        }
        if ($defaultValue !== null) {
            $constants['__default'] = $defaultValue;
        }
        static::$enumConstants[$class] = $constants;
    }
 
    protected function ‪setValue(‪$value)
    {
        $enumKey = array_search((string)‪$value, static::$enumConstants[static::class]);
        if ($enumKey === false) {
            throw new ‪InvalidEnumerationValueException(
                sprintf('Invalid value "%s" for enumeration "%s"', ‪$value, __CLASS__),
                1381615295
            );
        }
        $this->value = static::$enumConstants[static::class][$enumKey];
    }
 
    protected function ‪isValid(‪$value)
    {
        ‪$value = (string)‪$value;
        foreach (static::$enumConstants[static::class] as $constantValue) {
            if (‪$value === (string)$constantValue) {
                return true;
            }
        }
        return false;
    }
 
    public static function ‪getConstants($include_default = false)
    {
        static::loadValues();
        ‪$enumConstants = static::$enumConstants[static::class];
        if (!$include_default) {
            unset(‪$enumConstants['__default']);
        }
        return ‪$enumConstants;
    }
 
    public static function ‪cast(‪$value)
    {
        trigger_error('Class ' . __CLASS__ . ' used by enumeration ' . static::class . ' will be removed in TYPO3 v14.0. Use native enums instead.', E_USER_DEPRECATED);
 
        if (!is_object(‪$value) || get_class(‪$value) !== static::class) {
            ‪$value = new static(‪$value);
        }
        return ‪$value;
    }
 
    public function ‪equals(‪$value)
    {
        ‪$value = static::cast(‪$value);
        return $this == ‪$value;
    }
 
    public function ‪__toString()
    {
        return (string)‪$this->value;
    }
 
    public static function ‪getName(‪$value)
    {
        $name = '';
        $constants = array_flip(static::getConstants());
        if (array_key_exists(‪$value, $constants)) {
            $name = $constants[‪$value];
        }
        return $name;
    }
 
    public static function ‪getHumanReadableName(‪$value)
    {
        $name = static::getName(‪$value);
        return ucwords(strtolower(str_replace('_', ' ', $name)));
    }
}