interface purl_processor in Persistent URL 7

Processors can inspect and manipulate various parts of a request's URI.

Hierarchy

• interface \purl_processor

1 string reference to 'purl_processor'

purl_purl_processor in ./purl.module

Implements hook_purl_processor().

File

includes/purl_processor.inc, line 6

interface purl_processor {

  /**
   * Return the method the processor users.
   *
   * @return string, machine name of the method.
   */
  public function method();

  /**
   * Allow extension of the admin setup form.
   */
  public function admin_form(&$form, $id);

  /**
   * Provide a description of processor for the end user
   *
   * @return string description.
   */
  public function description();

  /**
   * Detect the the processor value for the current page request
   *
   * @return value that can be pased to the parse step.
   */
  public function detect($q);

  /**
   * Detects processor in the passed 'value'.
   *
   * @param $valid_values
   * @param $value
   * @return an array of purl_path_element objects
   */
  public function parse($valid_values, $value);

  /**
   * Used to provide compatibility with the path alias system.
   *
   * @param $value.
   *   detected value, by reference so that processors that can remove
   *   themselves is a method can have more than on value.
   * @param $element.
   *   purl_path_element
   * @param $q.
   *   the Drupal path being modified by custom_url_rewrite_inbound().
   *   Processors modifying $_GET['q'] should modify this instead of
   *   altering the $_GET or $_REQUEST values directly.
   */
  public function adjust(&$value, $element, &$q);

  /**
   * Responsible for rewriting outgoing links. Note: it's this functions
   * job to make sure it doesn't alter a link that has already been
   * treated.
   *
   * This must also check $options['purl']['disabled'] and
   * $options['purl']['remove']. The _purl_skip() method is helpful for this.
   *
   * @param $path
   *   string, by-reference the path to modify.
   * @param $options
   *   See url() docs
   * @param $element
   *   The element to add to the path.
   */
  public function rewrite(&$path, &$options, $element);

}

Members

Name	Modifiers	Type	Description	Overrides
purl_processor::adjust	public	function	Used to provide compatibility with the path alias system.	6
purl_processor::admin_form	public	function	Allow extension of the admin setup form.	6
purl_processor::description	public	function	Provide a description of processor for the end user	6
purl_processor::detect	public	function	Detect the the processor value for the current page request	6
purl_processor::method	public	function	Return the method the processor users.	6
purl_processor::parse	public	function	Detects processor in the passed 'value'.	6
purl_processor::rewrite	public	function	Responsible for rewriting outgoing links. Note: it's this functions job to make sure it doesn't alter a link that has already been treated.	6