* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Behat\Mink\Selector; use Behat\Mink\Selector\Xpath\Escaper; /** * Named selectors engine. Uses registered XPath selectors to create new expressions. * * @author Konstantin Kudryashov */ class NamedSelector implements SelectorInterface { /** * @var array */ private $replacements = array( // simple replacements '%lowercaseType%' => "translate(./@type, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')", '%lowercaseRole%' => "translate(./@role, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')", '%tagTextMatch%' => 'contains(normalize-space(string(.)), %locator%)', '%labelTextMatch%' => './@id = //label[%tagTextMatch%]/@for', '%idMatch%' => './@id = %locator%', '%valueMatch%' => 'contains(./@value, %locator%)', '%idOrValueMatch%' => '(%idMatch% or %valueMatch%)', '%idOrNameMatch%' => '(%idMatch% or ./@name = %locator%)', '%placeholderMatch%' => './@placeholder = %locator%', '%titleMatch%' => 'contains(./@title, %locator%)', '%altMatch%' => 'contains(./@alt, %locator%)', '%relMatch%' => 'contains(./@rel, %locator%)', '%labelAttributeMatch%' => 'contains(./@label, %locator%)', // complex replacements '%inputTypeWithoutPlaceholderFilter%' => "%lowercaseType% = 'radio' or %lowercaseType% = 'checkbox' or %lowercaseType% = 'file'", '%fieldFilterWithPlaceholder%' => 'self::input[not(%inputTypeWithoutPlaceholderFilter%)] | self::textarea', '%fieldMatchWithPlaceholder%' => '(%idOrNameMatch% or %labelTextMatch% or %placeholderMatch%)', '%fieldMatchWithoutPlaceholder%' => '(%idOrNameMatch% or %labelTextMatch%)', '%fieldFilterWithoutPlaceholder%' => 'self::input[%inputTypeWithoutPlaceholderFilter%] | self::select', '%buttonTypeFilter%' => "%lowercaseType% = 'submit' or %lowercaseType% = 'image' or %lowercaseType% = 'button' or %lowercaseType% = 'reset'", '%notFieldTypeFilter%' => "not(%buttonTypeFilter% or %lowercaseType% = 'hidden')", '%buttonMatch%' => '%idOrNameMatch% or %valueMatch% or %titleMatch%', '%linkMatch%' => '(%idMatch% or %tagTextMatch% or %titleMatch% or %relMatch%)', '%imgAltMatch%' => './/img[%altMatch%]', ); /** * @var array */ private $selectors = array( 'fieldset' => << << << << << << << << << << << << << << <<xpathEscaper = new Escaper(); foreach ($this->replacements as $from => $to) { $this->registerReplacement($from, $to); } foreach ($this->selectors as $alias => $selector) { $this->registerNamedXpath($alias, $selector); } } /** * Registers new XPath selector with specified name. * * @param string $name name for selector * @param string $xpath xpath expression * * @return void */ public function registerNamedXpath(string $name, string $xpath) { $this->selectors[$name] = strtr($xpath, $this->replacements); } /** * Translates provided locator into XPath. * * @param string|array $locator selector name or array of (selector_name, locator) * * @return string * * @throws \InvalidArgumentException */ public function translateToXPath($locator) { if (\is_array($locator)) { if (2 !== \count($locator)) { throw new \InvalidArgumentException('NamedSelector expects array(name, locator) as argument'); } $selector = $locator[0]; $locator = $locator[1]; } else { $selector = (string) $locator; $locator = null; } if (!isset($this->selectors[$selector])) { throw new \InvalidArgumentException(sprintf( 'Unknown named selector provided: "%s". Expected one of (%s)', $selector, implode(', ', array_keys($this->selectors)) )); } $xpath = $this->selectors[$selector]; if (null !== $locator) { $xpath = strtr($xpath, array('%locator%' => $this->escapeLocator($locator))); } return $xpath; } /** * Register a string replacement used to reduce duplication and increase readability in a Named XPath selector. * * Replacements can make use of other replacements but any consumed replacement must have already been defined * beforehand. * * For example you may have the following translations: * * %idMatch% => ./@id = %locator% * %idOrNameMatch% => (%idMatch% or ./@name = %locator%) * * Because the %idOrNameMatch% replacement consumes the %idMatch% replacement, it must be defined afterwards. * * You may then use this in a Named XPath: * * .//fieldset[%idOrNameMatch%] * * And it would be translated to: * * .//fieldset[(./@id = %locator% or /@name = %locator%)] * * @param string $from The source, typically a string wrapped in % markers * @param string $to The translation * * @return void */ public function registerReplacement(string $from, string $to) { $this->replacements[$from] = strtr($to, $this->replacements); } private function escapeLocator(string $locator): string { // If the locator looks like an escaped one, don't escape it again for BC reasons. if ( preg_match('/^\'[^\']*+\'$/', $locator) || (false !== strpos($locator, '\'') && preg_match('/^"[^"]*+"$/', $locator)) || ((8 < $length = strlen($locator)) && 'concat(' === substr($locator, 0, 7) && ')' === $locator[$length - 1]) ) { @trigger_error( 'Passing an escaped locator to the named selector is deprecated as of 1.7 and will be removed in 2.0.' .' Pass the raw value instead.', E_USER_DEPRECATED ); return $locator; } return $this->xpathEscaper->escapeLiteral($locator); } }