Your IP : 216.73.216.220
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Module\I18n\Dictionary;
/**
* Phrase
*/
class Phrase
{
/**
* Single quote that enclose the phrase
*
* @var string
*/
const QUOTE_SINGLE = "'";
/**
* Double quote that enclose the phrase
*
* @var string
*/
const QUOTE_DOUBLE = '"';
/**
* Phrase
*
* @var string
*/
private $_phrase;
/**
* Translation
*
* @var string
*/
private $_translation;
/**
* Context type
*
* @var string
*/
private $_contextType;
/**
* Context value
*
* @var array
*/
private $_contextValue = [];
/**
* Quote type that enclose the phrase, single or double
*
* @var string
*/
private $_quote;
/**
* Phrase construct
*
* @param string $phrase
* @param string $translation
* @param string|null $contextType
* @param string|array|null $contextValue
* @param string|null $quote
*/
public function __construct($phrase, $translation, $contextType = null, $contextValue = null, $quote = null)
{
$this->setPhrase($phrase);
$this->setTranslation($translation);
$this->setContextType($contextType);
$this->setContextValue($contextValue);
$this->setQuote($quote);
}
/**
* Set phrase
*
* @param string $phrase
* @return void
* @throws \DomainException
*/
public function setPhrase($phrase)
{
if (!$phrase) {
throw new \DomainException('Missed phrase');
}
$this->_phrase = $phrase;
}
/**
* Get phrase
*
* @return string
*/
public function getPhrase()
{
return $this->_phrase;
}
/**
* Set quote type
*
* @param string $quote
* @return void
*/
public function setQuote($quote)
{
if (in_array($quote, [self::QUOTE_SINGLE, self::QUOTE_DOUBLE])) {
$this->_quote = $quote;
}
}
/**
* Get quote type
*
* @return string
*/
public function getQuote()
{
return $this->_quote;
}
/**
* Set translation
*
* @param string $translation
* @return void
* @throws \DomainException
*/
public function setTranslation($translation)
{
if (!$translation) {
throw new \DomainException('Missed translation');
}
$this->_translation = $translation;
}
/**
* Get translation
*
* @return string
*/
public function getTranslation()
{
return $this->_translation;
}
/**
* Set context type
*
* @param string $contextType
* @return void
*/
public function setContextType($contextType)
{
$this->_contextType = $contextType;
}
/**
* Get context type
*
* @return string
*/
public function getContextType()
{
return $this->_contextType;
}
/**
* Add context value
*
* @param string $contextValue
* @return void
* @throws \DomainException
*/
public function addContextValue($contextValue)
{
if (empty($contextValue)) {
throw new \DomainException('Context value is empty');
}
if (!in_array($contextValue, $this->_contextValue)) {
$this->_contextValue[] = $contextValue;
}
}
/**
* Set context type
*
* @param string $contextValue
* @return void
* @throws \DomainException
*/
public function setContextValue($contextValue)
{
if (is_string($contextValue)) {
$contextValue = explode(',', $contextValue);
} elseif (null == $contextValue) {
$contextValue = [];
} elseif (!is_array($contextValue)) {
throw new \DomainException('Wrong context type');
}
$this->_contextValue = $contextValue;
}
/**
* Get context value
*
* @return array
*/
public function getContextValue()
{
return $this->_contextValue;
}
/**
* Get context value as string
*
* @param string $separator
* @return string
*/
public function getContextValueAsString($separator = ',')
{
return implode($separator, $this->_contextValue);
}
/**
* Get VO identifier key
*
* @return string
*/
public function getKey()
{
return $this->getPhrase() . '::' . $this->getContextType();
}
/**
* Compile PHP string based on quotes type it enclosed with
*
* @return string
*/
public function getCompiledPhrase()
{
return $this->getCompiledString($this->getPhrase());
}
/**
* Compile PHP string based on quotes type it enclosed with
*
* @return string
*/
public function getCompiledTranslation()
{
return $this->getCompiledString($this->getTranslation());
}
/**
* Compile PHP string (escaping unescaped quotes and processing concatenation)
*
* @param string $string
* @return string
*/
private function getCompiledString($string)
{
$encloseQuote = $this->getQuote() == Phrase::QUOTE_DOUBLE ? Phrase::QUOTE_DOUBLE : Phrase::QUOTE_SINGLE;
/* Find all occurrences of ' and ", with no \ before it for concatenation */
preg_match_all('/[^\\\\]' . $encloseQuote . '|' . $encloseQuote . '[^\\\\]/', $string, $matches);
if (count($matches[0])) {
$string = preg_replace('/([^\\\\])' . $encloseQuote . ' ?\. ?' . $encloseQuote . '/', '$1', $string);
}
/* Remove all occurrences of escaped quotes because it is not desirable in csv file.
Translation for such phrases will use translation for phrase without escaped quote. */
$string = str_replace('\"', '"', $string);
$string = str_replace("\\'", "'", $string);
return $string;
}
}