class purl_querystring in Persistent URL 6

Querystring processor.

Hierarchy

• class \purl_querystring implements purl_processor

1 string reference to 'purl_querystring'

purl_purl_processor in ./purl.module

Implementation of hook_purl_processor().

File

includes/purl_querystring.inc, line 6

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

    // Note that while this form element's key includes the method ("pair"),
    // it will eventually save to the variable purl_method_[id]_key. See
    // element validator for how this occurs.
    $form[$id]['extra']["purl_method_querystring_{$id}_key"] = array(
      '#title' => t('Key'),
      '#type' => 'textfield',
      '#size' => 12,
      '#default_value' => variable_get("purl_method_{$id}_key", ''),
      '#element_validate' => array(
        'purl_admin_form_key_validate',
      ),
      '#provider_id' => $id,
    );
  }

  /**
   * Detect a default value for in the GET request, ignore elements drupal uses
   * already.
   */
  public function detect($q) {
    return drupal_query_string_encode($_GET, array(
      'q',
      'sort',
      'order',
      'page',
      'pass',
    ));
  }
  public function description() {
    return t('Choose a querystring. 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, $qs) {
    $elements = array();
    parse_str($qs, $elements);
    $parsed = array();
    foreach ($elements as $k => $v) {
      if (isset($valid_values[$k])) {
        $parsed[$k] = $valid_values[$k];
        $parsed[$k]['id'] = $v;
      }
    }
    return purl_path_elements($this, $parsed);
  }

  /**
   * No need to do nothing at all.
   */
  public function adjust(&$value, $item, &$q) {
  }

  /**
   * Removes specific modifier from a query string.
   *
   * @param $qs
   *   The current querystring.
   * @param $element
   *   a purl_path_element object
   * @return querystring with the modifier removed.
   */
  function remove($value, $element) {
    $qs = array();
    parse_str($value, $qs);
    unset($qs[$element->id]);
    return drupal_query_string_encode($qs);
  }

  /**
   * Just need to add the value to the front of the path.
   */
  public function rewrite(&$path, &$options, $element) {
    if (!_purl_skip($element, $options)) {
      $qs = array();
      parse_str($options['query'], $qs);
      $qs[$element->value] = $element->id;
      $options['query'] = drupal_query_string_encode($qs);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
purl_querystring::adjust	public	function	No need to do nothing at all. Overrides purl_processor::adjust
purl_querystring::admin_form	public	function	Allow extension of the admin setup form. Overrides purl_processor::admin_form
purl_querystring::description	public	function	Provide a description of processor for the end user Overrides purl_processor::description
purl_querystring::detect	public	function	Detect a default value for in the GET request, ignore elements drupal uses already. Overrides purl_processor::detect
purl_querystring::method	public	function	Return the method the processor users. Overrides purl_processor::method
purl_querystring::parse	public	function	Tear apart the path and iterate thought it looking for valid values. Overrides purl_processor::parse
purl_querystring::remove		function	Removes specific modifier from a query string.
purl_querystring::rewrite	public	function	Just need to add the value to the front of the path. Overrides purl_processor::rewrite