| Current File : /home/pacjaorg/public_html/kmm/libraries/src/Language/Text.php |
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2007 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Language;
use Joomla\CMS\Factory;
use Joomla\CMS\HTML\HTMLHelper;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Text handling class.
*
* @since 1.7.0
*/
class Text
{
/**
* JavaScript strings
*
* @var array
* @since 1.7.0
*/
protected static $strings = [];
/**
* Translates a string into the current language.
*
* Examples:
* `<script>alert(Joomla.Text._('<?php echo Text::_("JDEFAULT", array("script"=>true)); ?>'));</script>`
* will generate an alert message containing 'Default'
* `<?php echo Text::_("JDEFAULT"); ?>` will generate a 'Default' string
*
* @param string $string The string to translate.
* @param mixed $jsSafe Boolean: Make the result javascript safe.
* @param boolean $interpretBackSlashes To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
* @param boolean $script To indicate that the string will be push in the javascript language store
*
* @return string The translated string or the key if $script is true
*
* @since 1.7.0
*/
public static function _($string, $jsSafe = false, $interpretBackSlashes = true, $script = false)
{
if (\is_array($jsSafe)) {
if (\array_key_exists('interpretBackSlashes', $jsSafe)) {
$interpretBackSlashes = (bool) $jsSafe['interpretBackSlashes'];
}
if (\array_key_exists('script', $jsSafe)) {
$script = (bool) $jsSafe['script'];
}
$jsSafe = \array_key_exists('jsSafe', $jsSafe) ? (bool) $jsSafe['jsSafe'] : false;
}
if (self::passSprintf($string, $jsSafe, $interpretBackSlashes, $script)) {
return $string;
}
$lang = Factory::getLanguage();
if ($script) {
static::$strings[$string] = $lang->_($string, $jsSafe, $interpretBackSlashes);
return $string;
}
return $lang->_($string, $jsSafe, $interpretBackSlashes);
}
/**
* Checks the string if it should be interpreted as sprintf and runs sprintf over it.
*
* @param string &$string The string to translate.
* @param mixed $jsSafe Boolean: Make the result javascript safe.
* @param boolean $interpretBackSlashes To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
* @param boolean $script To indicate that the string will be push in the javascript language store
*
* @return boolean Whether the string be interpreted as sprintf
*
* @since 3.4.4
*/
private static function passSprintf(&$string, $jsSafe = false, $interpretBackSlashes = true, $script = false)
{
// Check if string contains a comma
if (empty($string) || strpos($string, ',') === false) {
return false;
}
$lang = Factory::getLanguage();
$string_parts = explode(',', $string);
// Pass all parts through the Text translator
foreach ($string_parts as $i => $str) {
$string_parts[$i] = $lang->_($str, $jsSafe, $interpretBackSlashes);
}
$first_part = array_shift($string_parts);
// Replace custom named placeholders with sprintf style placeholders
$first_part = preg_replace('/\[\[%([0-9]+):[^\]]*\]\]/', '%\1$s', $first_part);
// Check if string contains sprintf placeholders
if (!preg_match('/%([0-9]+\$)?s/', $first_part)) {
return false;
}
$final_string = vsprintf($first_part, $string_parts);
// Return false if string hasn't changed
if ($first_part === $final_string) {
return false;
}
$string = $final_string;
if ($script) {
foreach ($string_parts as $i => $str) {
static::$strings[$str] = $string_parts[$i];
}
}
return true;
}
/**
* Translates a string into the current language.
*
* Examples:
* `<?php echo Text::alt('JALL', 'language'); ?>` will generate a 'All' string in English but a "Toutes" string in French
* `<?php echo Text::alt('JALL', 'module'); ?>` will generate a 'All' string in English but a "Tous" string in French
*
* @param string $string The string to translate.
* @param string $alt The alternate option for global string
* @param mixed $jsSafe Boolean: Make the result javascript safe.
* @param boolean $interpretBackSlashes To interpret backslashes (\\=\, \n=carriage return, \t=tabulation)
* @param boolean $script To indicate that the string will be pushed in the javascript language store
*
* @return string The translated string or the key if $script is true
*
* @since 1.7.0
*/
public static function alt($string, $alt, $jsSafe = false, $interpretBackSlashes = true, $script = false)
{
if (Factory::getLanguage()->hasKey($string . '_' . $alt)) {
$string .= '_' . $alt;
}
return static::_($string, $jsSafe, $interpretBackSlashes, $script);
}
/**
* Like Text::sprintf but tries to pluralise the string.
*
* Note that this method can take a mixed number of arguments as for the sprintf function.
*
* The last argument can take an array of options:
*
* array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean)
*
* where:
*
* jsSafe is a boolean to generate a javascript safe strings.
* interpretBackSlashes is a boolean to interpret backslashes \\->\, \n->new line, \t->tabulation.
* script is a boolean to indicate that the string will be push in the javascript language store.
*
* Examples:
* `<script>alert(Joomla.Text._('<?php echo Text::plural("COM_PLUGINS_N_ITEMS_UNPUBLISHED", 1, array("script"=>true)); ?>'));</script>`
* will generate an alert message containing '1 plugin successfully disabled'
* `<?php echo Text::plural('COM_PLUGINS_N_ITEMS_UNPUBLISHED', 1); ?>` will generate a '1 plugin successfully disabled' string
*
* @param string $string The format string.
* @param integer $n The number of items
*
* @return string The translated strings or the key if 'script' is true in the array of options
*
* @since 1.7.0
*/
public static function plural($string, $n)
{
$lang = Factory::getLanguage();
$args = \func_get_args();
$count = \count($args);
// Try the key from the language plural potential suffixes
$found = false;
$suffixes = $lang->getPluralSuffixes((int) $n);
// Add the count as possible suffix to allow for eg "a dozen" with suffix _12.
// Only do that if it is a real plural (more than one) to avoid issues with languages. See https://github.com/joomla/joomla-cms/pull/29029
if ($n != 1) {
array_unshift($suffixes, (int) $n);
}
foreach ($suffixes as $suffix) {
$key = $string . '_' . $suffix;
if ($lang->hasKey($key)) {
$found = true;
break;
}
}
// Not found so revert to the original.
$key = !$found ? $string : $key;
if (\is_array($args[$count - 1])) {
$args[0] = $lang->_(
$key,
\array_key_exists('jsSafe', $args[$count - 1]) ? $args[$count - 1]['jsSafe'] : false,
\array_key_exists('interpretBackSlashes', $args[$count - 1]) ? $args[$count - 1]['interpretBackSlashes'] : true
);
if (\array_key_exists('script', $args[$count - 1]) && $args[$count - 1]['script']) {
static::$strings[$key] = \call_user_func_array('sprintf', $args);
return $key;
}
} else {
$args[0] = $lang->_($key);
}
return \call_user_func_array('sprintf', $args);
}
/**
* Passes a string thru a sprintf.
*
* Note that this method can take a mixed number of arguments as for the sprintf function.
*
* The last argument can take an array of options:
*
* array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean)
*
* where:
*
* jsSafe is a boolean to generate a javascript safe strings.
* interpretBackSlashes is a boolean to interpret backslashes \\->\, \n->new line, \t->tabulation.
* script is a boolean to indicate that the string will be push in the javascript language store.
*
* @param string $string The format string.
*
* @return string The translated strings or the key if 'script' is true in the array of options.
*
* @since 1.7.0
*/
public static function sprintf($string)
{
$lang = Factory::getLanguage();
$args = \func_get_args();
$count = \count($args);
if (\is_array($args[$count - 1])) {
$args[0] = $lang->_(
$string,
\array_key_exists('jsSafe', $args[$count - 1]) ? $args[$count - 1]['jsSafe'] : false,
\array_key_exists('interpretBackSlashes', $args[$count - 1]) ? $args[$count - 1]['interpretBackSlashes'] : true
);
if (\array_key_exists('script', $args[$count - 1]) && $args[$count - 1]['script']) {
static::$strings[$string] = \call_user_func_array('sprintf', $args);
return $string;
}
} else {
$args[0] = $lang->_($string);
}
// Replace custom named placeholders with sprintf style placeholders
$args[0] = preg_replace('/\[\[%([0-9]+):[^\]]*\]\]/', '%\1$s', $args[0]);
return \call_user_func_array('sprintf', $args);
}
/**
* Passes a string through a printf.
*
* Note that this method can take a mixed number of arguments as for the sprintf function.
*
* @param string $string The format string.
*
* @return mixed
*
* @since 1.7.0
*/
public static function printf($string)
{
$lang = Factory::getLanguage();
$args = \func_get_args();
$count = \count($args);
if (\is_array($args[$count - 1])) {
$args[0] = $lang->_(
$string,
\array_key_exists('jsSafe', $args[$count - 1]) ? $args[$count - 1]['jsSafe'] : false,
\array_key_exists('interpretBackSlashes', $args[$count - 1]) ? $args[$count - 1]['interpretBackSlashes'] : true
);
} else {
$args[0] = $lang->_($string);
}
return \call_user_func_array('printf', $args);
}
/**
* Translate a string into the current language and stores it in the JavaScript language store.
*
* @param string $string The Text key.
* @param boolean $jsSafe Legacy parameter to add slashes to the string.
* Set it as "false" because the method encodes the string as JSON with json_encode().
* @param boolean $interpretBackSlashes Interpret \t and \n.
*
* @return array
*
* @since 1.7.0
*/
public static function script($string = null, $jsSafe = false, $interpretBackSlashes = true)
{
if ($string === null) {
@trigger_error(
sprintf(
'As of 3.7.0, passing a null value for the first argument of %1$s() is deprecated and will not be supported in 4.0.'
. ' Use the %2$s::getScriptStrings() method to get the strings from the JavaScript language store instead.',
__METHOD__,
__CLASS__
),
E_USER_DEPRECATED
);
}
if (\is_array($jsSafe)) {
if (\array_key_exists('interpretBackSlashes', $jsSafe)) {
$interpretBackSlashes = (bool) $jsSafe['interpretBackSlashes'];
}
if (\array_key_exists('jsSafe', $jsSafe)) {
$jsSafe = (bool) $jsSafe['jsSafe'];
} else {
$jsSafe = false;
}
}
// Add the string to the array if not null.
if ($string !== null) {
$doc = Factory::getDocument();
// Get previously added strings
$strings = $doc->getScriptOptions('joomla.jtext');
// Normalize the key and translate the string.
$key = strtoupper($string);
$strings[$key] = Factory::getLanguage()->_($string, $jsSafe, $interpretBackSlashes);
static::$strings[$key] = $strings[$key];
// Load core.js dependency
HTMLHelper::_('behavior.core');
// Update Joomla.Text script options
$doc->addScriptOptions('joomla.jtext', $strings, false);
}
return static::getScriptStrings();
}
/**
* Get the strings that have been loaded to the JavaScript language store.
*
* @return array
*
* @since 3.7.0
*/
public static function getScriptStrings()
{
return static::$strings;
}
}