Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Translator.php

class Translator

Same name in this branch
  1. 11.1.x vendor/php-tuf/composer-stager/src/Internal/Translation/Service/Translator.php \PhpTuf\ComposerStager\Internal\Translation\Service\Translator

XPath expression translator interface.

This component is a port of the Python cssselect library, which is copyright Ian Bicking, @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>

@internal

Hierarchy

  • class \Symfony\Component\CssSelector\XPath\Translator implements \Symfony\Component\CssSelector\XPath\TranslatorInterface

Expanded class hierarchy of Translator

See also

https://github.com/SimonSapin/cssselect.

5 files declare their use of Translator
AttributeMatchingExtension.php in vendor/symfony/css-selector/XPath/Extension/AttributeMatchingExtension.php
CssSelectorConverter.php in vendor/symfony/css-selector/CssSelectorConverter.php
FunctionExtension.php in vendor/symfony/css-selector/XPath/Extension/FunctionExtension.php
HtmlExtension.php in vendor/symfony/css-selector/XPath/Extension/HtmlExtension.php
NodeExtension.php in vendor/symfony/css-selector/XPath/Extension/NodeExtension.php

File

vendor/symfony/css-selector/XPath/Translator.php, line 31

Namespace

Symfony\Component\CssSelector\XPath
View source
class Translator implements TranslatorInterface {
    private ParserInterface $mainParser;
    
    /**
     * @var ParserInterface[]
     */
    private array $shortcutParsers = [];
    
    /**
     * @var Extension\ExtensionInterface[]
     */
    private array $extensions = [];
    private array $nodeTranslators = [];
    private array $combinationTranslators = [];
    private array $functionTranslators = [];
    private array $pseudoClassTranslators = [];
    private array $attributeMatchingTranslators = [];
    public function __construct(?ParserInterface $parser = null) {
        $this->mainParser = $parser ?? new Parser();
        $this->registerExtension(new Extension\NodeExtension())
            ->registerExtension(new Extension\CombinationExtension())
            ->registerExtension(new Extension\FunctionExtension())
            ->registerExtension(new Extension\PseudoClassExtension())
            ->registerExtension(new Extension\AttributeMatchingExtension());
    }
    public static function getXpathLiteral(string $element) : string {
        if (!str_contains($element, "'")) {
            return "'" . $element . "'";
        }
        if (!str_contains($element, '"')) {
            return '"' . $element . '"';
        }
        $string = $element;
        $parts = [];
        while (true) {
            if (false !== ($pos = strpos($string, "'"))) {
                $parts[] = \sprintf("'%s'", substr($string, 0, $pos));
                $parts[] = "\"'\"";
                $string = substr($string, $pos + 1);
            }
            else {
                $parts[] = "'{$string}'";
                break;
            }
        }
        return \sprintf('concat(%s)', implode(', ', $parts));
    }
    public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::') : string {
        $selectors = $this->parseSelectors($cssExpr);
        
        /** @var SelectorNode $selector */
        foreach ($selectors as $index => $selector) {
            if (null !== $selector->getPseudoElement()) {
                throw new ExpressionErrorException('Pseudo-elements are not supported.');
            }
            $selectors[$index] = $this->selectorToXPath($selector, $prefix);
        }
        return implode(' | ', $selectors);
    }
    public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::') : string {
        return ($prefix ?: '') . $this->nodeToXPath($selector);
    }
    
    /**
     * @return $this
     */
    public function registerExtension(Extension\ExtensionInterface $extension) : static {
        $this->extensions[$extension->getName()] = $extension;
        $this->nodeTranslators = array_merge($this->nodeTranslators, $extension->getNodeTranslators());
        $this->combinationTranslators = array_merge($this->combinationTranslators, $extension->getCombinationTranslators());
        $this->functionTranslators = array_merge($this->functionTranslators, $extension->getFunctionTranslators());
        $this->pseudoClassTranslators = array_merge($this->pseudoClassTranslators, $extension->getPseudoClassTranslators());
        $this->attributeMatchingTranslators = array_merge($this->attributeMatchingTranslators, $extension->getAttributeMatchingTranslators());
        return $this;
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function getExtension(string $name) : Extension\ExtensionInterface {
        if (!isset($this->extensions[$name])) {
            throw new ExpressionErrorException(\sprintf('Extension "%s" not registered.', $name));
        }
        return $this->extensions[$name];
    }
    
    /**
     * @return $this
     */
    public function registerParserShortcut(ParserInterface $shortcut) : static {
        $this->shortcutParsers[] = $shortcut;
        return $this;
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function nodeToXPath(NodeInterface $node) : XPathExpr {
        if (!isset($this->nodeTranslators[$node->getNodeName()])) {
            throw new ExpressionErrorException(\sprintf('Node "%s" not supported.', $node->getNodeName()));
        }
        return $this->nodeTranslators[$node->getNodeName()]($node, $this);
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function addCombination(string $combiner, NodeInterface $xpath, NodeInterface $combinedXpath) : XPathExpr {
        if (!isset($this->combinationTranslators[$combiner])) {
            throw new ExpressionErrorException(\sprintf('Combiner "%s" not supported.', $combiner));
        }
        return $this->combinationTranslators[$combiner]($this->nodeToXPath($xpath), $this->nodeToXPath($combinedXpath));
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function addFunction(XPathExpr $xpath, FunctionNode $function) : XPathExpr {
        if (!isset($this->functionTranslators[$function->getName()])) {
            throw new ExpressionErrorException(\sprintf('Function "%s" not supported.', $function->getName()));
        }
        return $this->functionTranslators[$function->getName()]($xpath, $function);
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function addPseudoClass(XPathExpr $xpath, string $pseudoClass) : XPathExpr {
        if (!isset($this->pseudoClassTranslators[$pseudoClass])) {
            throw new ExpressionErrorException(\sprintf('Pseudo-class "%s" not supported.', $pseudoClass));
        }
        return $this->pseudoClassTranslators[$pseudoClass]($xpath);
    }
    
    /**
     * @throws ExpressionErrorException
     */
    public function addAttributeMatching(XPathExpr $xpath, string $operator, string $attribute, ?string $value) : XPathExpr {
        if (!isset($this->attributeMatchingTranslators[$operator])) {
            throw new ExpressionErrorException(\sprintf('Attribute matcher operator "%s" not supported.', $operator));
        }
        return $this->attributeMatchingTranslators[$operator]($xpath, $attribute, $value);
    }
    
    /**
     * @return SelectorNode[]
     */
    private function parseSelectors(string $css) : array {
        foreach ($this->shortcutParsers as $shortcut) {
            $tokens = $shortcut->parse($css);
            if ($tokens) {
                return $tokens;
            }
        }
        return $this->mainParser
            ->parse($css);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Translator::$attributeMatchingTranslators private property
Translator::$combinationTranslators private property
Translator::$extensions private property
Translator::$functionTranslators private property
Translator::$mainParser private property
Translator::$nodeTranslators private property
Translator::$pseudoClassTranslators private property
Translator::$shortcutParsers private property
Translator::addAttributeMatching public function
Translator::addCombination public function
Translator::addFunction public function
Translator::addPseudoClass public function
Translator::cssToXPath public function Translates a CSS selector to an XPath expression. Overrides TranslatorInterface::cssToXPath
Translator::getExtension public function
Translator::getXpathLiteral public static function
Translator::nodeToXPath public function
Translator::parseSelectors private function
Translator::registerExtension public function
Translator::registerParserShortcut public function
Translator::selectorToXPath public function Translates a parsed selector node to an XPath expression. Overrides TranslatorInterface::selectorToXPath
Translator::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal