drupalmoduleupgrader-8.x-1.5/src/Utility/Path/PathUtilityBase.php

<?php

namespace Drupal\drupalmoduleupgrader\Utility\Path;

use Doctrine\Common\Collections\ArrayCollection;

/**
 * Base class for PathUtilityInterface implementations.
 */
abstract class PathUtilityBase extends ArrayCollection implements PathUtilityInterface {

  /**
   * The next index for getNextWildcard() to slice on.
   *
   * @var int
   */
  protected $_wildcard = 0;

  /**
   * {@inheritdoc}
   */
  public function __construct($path) {
    if (is_array($path)) {
      foreach ($path as $component) {
        $this->add($component);
      }
    }
    elseif (is_string($path)) {
      $this->__construct(explode('/', $path));
    }
    else {
      throw new \InvalidArgumentException();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function add($value) {
    if ($value instanceof PathComponentInterface) {
      parent::add($value);
    }
    elseif (is_scalar($value)) {
      $this->add(static::getComponent($value));
    }
    else {
      throw new \InvalidArgumentException();
    }
  }

  /**
   * Filters the path by a string. The filtered path will only contain
   * components whose string representation is identical to $element.
   *
   * @param string $element
   *   The string to search for.
   *
   * @return static
   */
  public function find($element) {
    return $this
      ->filter(function (PathComponentInterface $component) use ($element) {
        return ($element === $component->__toString());
      });
  }

  /**
   * {@inheritdoc}
   */
  public function contains($element) {
    return (boolean) $this->find($element)->count();
  }

  /**
   * {@inheritdoc}
   */
  public function hasWildcards() {
    return ($this->getWildcards()->count() > 0);
  }

  /**
   * Returns every {wildcard} in the path, keyed by position.
   *
   * @return static
   */
  public function getWildcards() {
    return $this->filter(function (PathComponentInterface $component) {
      return $component->isWildcard();
    });
  }

  /**
   * Returns the next wildcard, if any.
   *
   * @return \Drupal\drupalmoduleupgrader\Utility\Path\PathComponentInterface|null
   */
  public function getNextWildcard() {
    $wildcards = $this->getWildcards()->slice($this->_wildcard, 1);

    if (isset($wildcards[$this->_wildcard])) {
      return $wildcards[$this->_wildcard++];
    }
  }

  /**
   * Returns a copy of the collection with wildcards removed.
   *
   * @return static
   */
  public function deleteWildcards() {
    return $this->filter(function (PathComponentInterface $component) {
      return (!$component->isWildcard());
    });
  }

  /**
   * {@inheritdoc}
   */
  public function getParent() {
    if ($this->count() > 1) {
      return new static($this->slice(0, -1));
    }
    else {
      throw new \LengthException('Cannot get parent a path with one component.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return implode('/', $this->toArray());
  }

  /**
   * Counts the items in this object.
   *
   * PHP 7.2+ fires an E_WARNING if the value is not countable and PHP 8.0
   * modified the count() behaviour. Provide BC for the prior behaviour here.
   *
   * {@inheritdoc}
   */
  public function count() {
    $converted = $this->toArray();
    if (is_countable($converted)) {
      return count($converted);
    }
    elseif (is_null($converted)) {
      return 0;
    }
    return 1;
  }

}