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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 <?php
/**
* @author @jenschude <jens.schulze@commercetools.de>
*/
namespace Commercetools\Core\Model\Common;
use Commercetools\Core\Helper\CurrencyFormatterInterface;
use Psr\Log\LoggerInterface;
use Commercetools\Core\Helper\CurrencyFormatter;
/**
* @description
* ## Usage
*
* The context will be set at ContextAware objects like JsonObject and Collection. By adding a context to the client
* config the context will be set to all request, responses and other ContextAware objects. Besides that you can always
* set a new context to every ContextAware object at any time.
*
* ```php
* $context = Context::of();
* ```
*
* For production environments it's advised to set the graceful flag to prevent Exceptions by toString conversions()
*
* ```php
* $context->setGraceful(true);
* ```
* ### Languages and Locales
*
* For automatic fallback string conversion e.g. with LocalizedString you can set the available languages. The
* LocalizedString will try to resolve a string in the given order. It's strongly advised to set the locale in
* the Context as it is used for example by the CurrencyFormatter. If no locale is set, the default locale given
* by php config will be used.
*
* ```php
* $context->setLanguages(['de', 'en'])->setLocale('de_DE');
* ```
*
* ### CurrencyFormatter
*
* The context provides a builtin CurrencyFormatter. The default currency formatter will format a currency with
* the help of the intl extension and the locale set.
*
* Example for custom currency formatter:
* ```php
* $currencyFormatter = new CurrencyFormatter();
* $currencyFormatter->setFormatCallback(function($centAmount, $currency)) {
* $amount = $centAmount / 100;
* $currency = mb_strtoupper($currency);
* $locale = $this->context->getLocale();
*
* $formatter = new \NumberFormatter($locale, \NumberFormatter::CURRENCY);
* return $formatter->formatCurrency($amount, $currency);
* }
* $context->setCurrencyFormatter($currencyFormatter);
* ```
*
* @package Commercetools\Core\Model\Common
*/
class Context implements \ArrayAccess
{
/**
* @var bool
*/
private $graceful = false;
/**
* @var array
*/
private $languages = [];
/**
* @var CurrencyFormatterInterface
*/
private $currencyFormatter;
/**
* @var string
*/
private $locale;
/**
* @var LoggerInterface
*/
private $logger;
const GRACEFUL = 'graceful';
const LANGUAGES = 'languages';
const CURRENCY_FORMATTER = 'currencyFormatter';
const LOCALE = 'locale';
const LOGGER = 'logger';
public function __construct()
{
$context = $this;
$this->currencyFormatter = new CurrencyFormatter($context);
$this->locale = null;
if (extension_loaded('intl')) {
$this->locale = \Locale::getDefault();
}
$this->logger = null;
}
/**
* @return boolean
*/
public function isGraceful()
{
return $this->graceful;
}
/**
* @param boolean $graceful
* @return Context
*/
public function setGraceful($graceful)
{
$this->graceful = $graceful;
return $this;
}
/**
* @return array
*/
public function getLanguages()
{
return $this->languages;
}
/**
* @param array $languages
* @return Context
*/
public function setLanguages(array $languages)
{
$this->languages = $languages;
return $this;
}
/**
* @return CurrencyFormatterInterface
*/
public function getCurrencyFormatter()
{
return $this->currencyFormatter;
}
/**
* @param CurrencyFormatterInterface $currencyFormatter
* @return Context
*/
public function setCurrencyFormatter($currencyFormatter)
{
$this->currencyFormatter = $currencyFormatter;
return $this;
}
/**
* @return string
*/
public function getLocale()
{
return $this->locale;
}
/**
* @param string $locale
* @return Context
*/
public function setLocale($locale)
{
$this->locale = $locale;
return $this;
}
/**
* @return LoggerInterface
*/
public function getLogger()
{
return $this->logger;
}
/**
* @param LoggerInterface $logger
* @return Context
*/
public function setLogger($logger)
{
$this->logger = $logger;
return $this;
}
public static function of()
{
return new static();
}
#[\ReturnTypeWillChange]
/**
* @inheritDoc
*/
public function offsetExists($offset)
{
return isset($this->$offset);
}
#[\ReturnTypeWillChange]
/**
* @inheritDoc
*/
public function offsetGet($offset)
{
if ($this->offsetExists($offset)) {
$method = 'get'.ucfirst($offset);
return $this->$method();
}
return null;
}
#[\ReturnTypeWillChange]
/**
* @inheritDoc
*/
public function offsetSet($offset, $value)
{
if (property_exists($this, $offset)) {
$method = 'set'.ucfirst($offset);
$this->$method($value);
}
}
#[\ReturnTypeWillChange]
/**
* @inheritDoc
*/
public function offsetUnset($offset)
{
if ($this->offsetExists($offset)) {
$method = 'set'.ucfirst($offset);
$this->$method(null);
}
}
}