<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Helper;
use Cake\Utility\Text;
/**
* A trait that provides id generating methods to be
* used in various widget classes.
*/
trait IdGeneratorTrait
{
/**
* Prefix for id attribute.
*
* @var string|null
*/
protected $_idPrefix;
/**
* A list of id suffixes used in the current rendering.
*
* @var string[]
*/
protected $_idSuffixes = [];
/**
* Clear the stored ID suffixes.
*
* @return void
*/
protected function _clearIds()
{
$this->_idSuffixes = [];
}
/**
* Generate an ID attribute for an element.
*
* Ensures that id's for a given set of fields are unique.
*
* @param string $name The ID attribute name.
* @param string $val The ID attribute value.
* @return string Generated id.
*/
protected function _id($name, $val)
{
$name = $this->_domId($name);
$suffix = $this->_idSuffix($val);
return trim($name . '-' . $suffix, '-');
}
/**
* Generate an ID suffix.
*
* Ensures that id's for a given set of fields are unique.
*
* @param string $val The ID attribute value.
* @return string Generated id suffix.
*/
protected function _idSuffix($val)
{
$idSuffix = mb_strtolower(str_replace(['/', '@', '<', '>', ' ', '"', '\''], '-', $val));
$count = 1;
$check = $idSuffix;
while (in_array($check, $this->_idSuffixes)) {
$check = $idSuffix . $count++;
}
$this->_idSuffixes[] = $check;
return $check;
}
/**
* Generate an ID suitable for use in an ID attribute.
*
* @param string $value The value to convert into an ID.
* @return string The generated id.
*/
protected function _domId($value)
{
$domId = mb_strtolower(Text::slug($value, '-'));
if ($this->_idPrefix) {
$domId = $this->_idPrefix . '-' . $domId;
}
return $domId;
}
}