class purl_path in Persistent URL 6

Path prefixer.

Hierarchy

• class \purl_path implements purl_processor

1 string reference to 'purl_path'

purl_purl_processor in ./purl.module

Implementation of hook_purl_processor().

File

includes/purl_path.inc, line 6

class purl_path implements purl_processor {
  public function method() {
    return 'path';
  }
  public function admin_form(&$form, $id) {
  }

  /**
   * Detect a default value for 'q' when created.
   */
  public function detect($q) {
    return $q;
  }
  public function description() {
    return t('Choose a path. May contain only lowercase letters, numbers, dashes and underscores. e.g. "my-value"');
  }

  /**
   * Tear apart the path and iterate thought it looking for valid values.
   */
  public function parse($valid_values, $q) {
    $parsed = array();
    $args = explode('/', $q);
    $arg = current($args);
    while (isset($valid_values[$arg])) {
      $parsed[$arg] = $valid_values[$arg];
      array_shift($args);
      $arg = current($args);
      if (in_array($arg, $parsed)) {
        break;
      }
    }
    return purl_path_elements($this, $parsed);
  }

  /**
   * Rewrite the query string. Note that this is being passed through
   * the custom_url_rewrite_inbound() stack and may *not* directly
   * affect $_GET['q']. See purl_init() for how $_GET['q'] is affected
   * by processors.
   */
  public function adjust(&$value, $item, &$q) {
    $q = $this
      ->remove($q, $item);
    $value = $this
      ->remove($value, $item);
  }

  /**
   * Removes specific modifier from a query string.
   *
   * @param $q
   *   The current path.
   * @param $element
   *   a purl_path_element object
   * @return path string with the modifier removed.
   */
  public function remove($q, $element) {
    $args = explode('/', $q);

    // Remove the value from the front of the query string
    if (current($args) === (string) $element->value) {
      array_shift($args);
    }
    return implode('/', $args);
  }

  /**
   * Just need to add the value to the front of the path.
   */
  public function rewrite(&$path, &$options, $element) {

    // We attempt to remove the prefix from the path as a way to detect it's
    // presence. If the processor can remove itself than we're on a path alias
    // that contains our prefix. Then $alt will not be the same as the $path
    // and we won't do any rewriting.
    $alt = $this
      ->remove($path, $element);
    if ($alt == $path && !_purl_skip($element, $options)) {
      $items = empty($path) ? array() : explode('/', $path);
      array_unshift($items, $element->value);
      $path = implode('/', $items);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
purl_path::adjust	public	function	Rewrite the query string. Note that this is being passed through the custom_url_rewrite_inbound() stack and may *not* directly affect $_GET['q']. See purl_init() for how $_GET['q'] is affected by processors. Overrides purl_processor::adjust
purl_path::admin_form	public	function	Allow extension of the admin setup form. Overrides purl_processor::admin_form	1
purl_path::description	public	function	Provide a description of processor for the end user Overrides purl_processor::description
purl_path::detect	public	function	Detect a default value for 'q' when created. Overrides purl_processor::detect
purl_path::method	public	function	Return the method the processor users. Overrides purl_processor::method	1
purl_path::parse	public	function	Tear apart the path and iterate thought it looking for valid values. Overrides purl_processor::parse	1
purl_path::remove	public	function	Removes specific modifier from a query string.	1
purl_path::rewrite	public	function	Just need to add the value to the front of the path. Overrides purl_processor::rewrite	1