CTP SDK : File Core/Model/Common/LocalizedString.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 26.01.15, 15:19
 */

namespace Commercetools\Core\Model\Common;

use Commercetools\Core\Error\Message;
use Commercetools\Core\Error\InvalidArgumentException;

/**
 * @package Commercetools\Core\Model\Type
 * @link https://docs.commercetools.com/http-api-types.html#localizedstring
 * @example
 * ```php
 * LocalizedString::fromArray(['en' => 'Hello World', 'de' => 'Hallo Welt'])->add('fr', 'Bonjour le monde');
 * ```
 */
class LocalizedString implements \JsonSerializable, JsonDeserializeInterface
{
    use ContextTrait;

    /**
     * @var array
     */
    protected $values = [];

    /**
     * @param array $values
     * @param Context|callable $context
     */
    public function __construct(array $values, $context = null)
    {
        $this->setContext($context);
        foreach ($values as $locale => $value) {
            $this->add($locale, $value);
        }
    }

    /**
     * @param $locale
     * @return string
     */
    public function __get($locale)
    {
        $context = new Context();
        $context->setLanguages([$locale])->setGraceful($this->getContext()->isGraceful());
        return $this->get($context);
    }

    /**
     * @param Context $context
     * @return string
     */
    public function getLocalized(Context $context = null)
    {
        return $this->get($context);
    }
    /**
     * @param Context $context
     * @return string
     */
    protected function getLanguage(Context $context)
    {
        $locale = null;
        foreach ($context->getLanguages() as $locale) {
            $locale = \Locale::canonicalize($locale);
            if (isset($this->values[$locale])) {
                return $locale;
            }
            $language = \Locale::getPrimaryLanguage($locale);
            if ($locale == $language) {
                continue;
            }
            if (isset($this->values[$language])) {
                return $language;
            }
        }
        return $locale;
    }

    /**
     * @param Context $context
     * @return string
     */
    public function get(Context $context = null)
    {
        if (is_null($context)) {
            $context = $this->getContext();
        }
        $locale = $this->getLanguage($context);
        if (!isset($this->values[$locale])) {
            if (!$context->isGraceful()) {
                throw new InvalidArgumentException(Message::NO_VALUE_FOR_LOCALE);
            }
            return '';
        }
        return $this->values[$locale];
    }

    /**
     * @param string $locale
     * @param string $value
     * @return $this
     */
    public function add($locale, $value)
    {
        $locale = \Locale::canonicalize($locale);
        $this->values[$locale] = $value;

        return $this;
    }

    public function merge(LocalizedString $localizedString)
    {
        $this->values = array_merge($this->values, $localizedString->toArray());
    }

    public function __toString()
    {
        return $this->get();
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $values = $this->values;

        $data = [];
        foreach ($values as $key => $value) {
            $data[str_replace('_', '-', $key)] = $value;
        }
        return $data;
    }

    #[\ReturnTypeWillChange]
    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * @param Context|callable $context
     * @return $this
     */
    public static function of($context = null)
    {
        return new static([], $context);
    }

    /**
     * @param array $data
     * @param Context|callable $context
     * @return static
     */
    public static function fromArray(array $data, $context = null)
    {
        return new static($data, $context);
    }

    /**
     * @param string $language
     * @param string $text
     * @param Context|callable $context
     * @return LocalizedString
     */
    public static function ofLangAndText($language, $text, $context = null)
    {
        return new static([$language => $text], $context);
    }
}

Namespaces

Classes

Interfaces

Traits