class HtmlExtension in Zircon Profile 8

XPath expression translator HTML extension.

This component is a port of the Python cssselect library, which is copyright Ian Bicking, @author Jean-François Simon <[e-mail]>

Hierarchy

• class \Symfony\Component\CssSelector\XPath\Extension\AbstractExtension implements ExtensionInterface
  • class \Symfony\Component\CssSelector\XPath\Extension\HtmlExtension

See also

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

2 files declare their use of HtmlExtension

CssSelector.php in vendor/symfony/css-selector/CssSelector.php

TranslatorTest.php in vendor/symfony/css-selector/Tests/XPath/TranslatorTest.php

File

vendor/symfony/css-selector/XPath/Extension/HtmlExtension.php, line 27

Namespace

Symfony\Component\CssSelector\XPath\Extension

class HtmlExtension extends AbstractExtension {

  /**
   * Constructor.
   *
   * @param Translator $translator
   */
  public function __construct(Translator $translator) {
    $translator
      ->getExtension('node')
      ->setFlag(NodeExtension::ELEMENT_NAME_IN_LOWER_CASE, true)
      ->setFlag(NodeExtension::ATTRIBUTE_NAME_IN_LOWER_CASE, true);
  }

  /**
   * {@inheritdoc}
   */
  public function getPseudoClassTranslators() {
    return array(
      'checked' => array(
        $this,
        'translateChecked',
      ),
      'link' => array(
        $this,
        'translateLink',
      ),
      'disabled' => array(
        $this,
        'translateDisabled',
      ),
      'enabled' => array(
        $this,
        'translateEnabled',
      ),
      'selected' => array(
        $this,
        'translateSelected',
      ),
      'invalid' => array(
        $this,
        'translateInvalid',
      ),
      'hover' => array(
        $this,
        'translateHover',
      ),
      'visited' => array(
        $this,
        'translateVisited',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getFunctionTranslators() {
    return array(
      'lang' => array(
        $this,
        'translateLang',
      ),
    );
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateChecked(XPathExpr $xpath) {
    return $xpath
      ->addCondition('(@checked ' . "and (name(.) = 'input' or name(.) = 'command')" . "and (@type = 'checkbox' or @type = 'radio'))");
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateLink(XPathExpr $xpath) {
    return $xpath
      ->addCondition("@href and (name(.) = 'a' or name(.) = 'link' or name(.) = 'area')");
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateDisabled(XPathExpr $xpath) {
    return $xpath
      ->addCondition('(' . '@disabled and' . '(' . "(name(.) = 'input' and @type != 'hidden')" . " or name(.) = 'button'" . " or name(.) = 'select'" . " or name(.) = 'textarea'" . " or name(.) = 'command'" . " or name(.) = 'fieldset'" . " or name(.) = 'optgroup'" . " or name(.) = 'option'" . ')' . ') or (' . "(name(.) = 'input' and @type != 'hidden')" . " or name(.) = 'button'" . " or name(.) = 'select'" . " or name(.) = 'textarea'" . ')' . ' and ancestor::fieldset[@disabled]');

    // todo: in the second half, add "and is not a descendant of that fieldset element's first legend element child, if any."
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateEnabled(XPathExpr $xpath) {
    return $xpath
      ->addCondition('(' . '@href and (' . "name(.) = 'a'" . " or name(.) = 'link'" . " or name(.) = 'area'" . ')' . ') or (' . '(' . "name(.) = 'command'" . " or name(.) = 'fieldset'" . " or name(.) = 'optgroup'" . ')' . ' and not(@disabled)' . ') or (' . '(' . "(name(.) = 'input' and @type != 'hidden')" . " or name(.) = 'button'" . " or name(.) = 'select'" . " or name(.) = 'textarea'" . " or name(.) = 'keygen'" . ')' . ' and not (@disabled or ancestor::fieldset[@disabled])' . ') or (' . "name(.) = 'option' and not(" . '@disabled or ancestor::optgroup[@disabled]' . ')' . ')');
  }

  /**
   * @param XPathExpr    $xpath
   * @param FunctionNode $function
   *
   * @return XPathExpr
   *
   * @throws ExpressionErrorException
   */
  public function translateLang(XPathExpr $xpath, FunctionNode $function) {
    $arguments = $function
      ->getArguments();
    foreach ($arguments as $token) {
      if (!($token
        ->isString() || $token
        ->isIdentifier())) {
        throw new ExpressionErrorException('Expected a single string or identifier for :lang(), got ' . implode(', ', $arguments));
      }
    }
    return $xpath
      ->addCondition(sprintf('ancestor-or-self::*[@lang][1][starts-with(concat(' . "translate(@%s, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'), '-')" . ', %s)]', 'lang', Translator::getXpathLiteral(strtolower($arguments[0]
      ->getValue()) . '-')));
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateSelected(XPathExpr $xpath) {
    return $xpath
      ->addCondition("(@selected and name(.) = 'option')");
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateInvalid(XPathExpr $xpath) {
    return $xpath
      ->addCondition('0');
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateHover(XPathExpr $xpath) {
    return $xpath
      ->addCondition('0');
  }

  /**
   * @param XPathExpr $xpath
   *
   * @return XPathExpr
   */
  public function translateVisited(XPathExpr $xpath) {
    return $xpath
      ->addCondition('0');
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return 'html';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractExtension::getAttributeMatchingTranslators	public	function	Returns attribute operation translators. Overrides ExtensionInterface::getAttributeMatchingTranslators	1
AbstractExtension::getCombinationTranslators	public	function	Returns combination translators. Overrides ExtensionInterface::getCombinationTranslators	1
AbstractExtension::getNodeTranslators	public	function	Returns node translators. Overrides ExtensionInterface::getNodeTranslators	1
HtmlExtension::getFunctionTranslators	public	function	Returns function translators. Overrides AbstractExtension::getFunctionTranslators
HtmlExtension::getName	public	function	Returns extension name. Overrides ExtensionInterface::getName
HtmlExtension::getPseudoClassTranslators	public	function	Returns pseudo-class translators. Overrides AbstractExtension::getPseudoClassTranslators
HtmlExtension::translateChecked	public	function
HtmlExtension::translateDisabled	public	function
HtmlExtension::translateEnabled	public	function
HtmlExtension::translateHover	public	function
HtmlExtension::translateInvalid	public	function
HtmlExtension::translateLang	public	function
HtmlExtension::translateLink	public	function
HtmlExtension::translateSelected	public	function
HtmlExtension::translateVisited	public	function
HtmlExtension::__construct	public	function	Constructor.