class FacetApiPrettyPathsCoderDefault in Facet API Pretty Paths 7

Default FacetApiPrettyPathsCoder.

Hierarchy

• class \FacetApiPrettyPathsCoderDefault

1 string reference to 'FacetApiPrettyPathsCoderDefault'

facetapi_pretty_paths_facetapi_pretty_paths_coders in ./facetapi_pretty_paths.module

Implements hook_facetapi_pretty_paths_coders().

File

plugins/coders/facetapi_pretty_paths_coder_default.inc, line 11

A default coder for pretty paths.

class FacetApiPrettyPathsCoderDefault {

  /**
   * Encode a path segment in order to output it as part of a pretty path.
   *
   * @param array $args An associative array containing:
   * - segment: The path segment to encode.
   * - facet: The facet that triggered the segment.
   */
  public function encodePathSegment(array $args) {

    // Default: <alias>/<value>
    $args['segment']['value'] = str_replace('/', '%2F', $args['segment']['value']);
    $args['segment']['value'] = str_replace('.', '%2E', $args['segment']['value']);
    $args['segment']['alias'] = rawurlencode($args['segment']['alias']);
  }

  /**
   * Decode the alias part of a path segment in order
   * to interpret it from a given pretty path.
   *
   * @param array $args An associative array containing:
   * - alias: The alias to decode.
   */
  public function decodePathSegmentAlias(array $args) {
    $alias = $args['alias'];

    // We need to decode path aliases twice.
    $alias = rawurldecode($alias);
    $alias = rawurldecode($alias);
    return $alias;
  }

  /**
   * Decode the value part of a path segment in order
   * to interpret it from a given pretty path.
   *
   * @param array $args An associative array containing:
   * - segment: The path segment to decode.
   * - facet: The facet that is related to the path segment.
   */
  public function decodePathSegmentValue(array $args) {
    $value = $args['value'];
    $value = str_replace('%2F', '/', rawurldecode($value));
    $value = str_replace('%2E', '.', rawurldecode($value));
    return $value;
  }

  /**
   * Convert a given text to a pretty path using pathauto, if available.
   */
  protected function prettyPath($text) {

    // @todo: Make this pluggable?
    if (module_exists('pathauto')) {

      // Needed, as of http://drupal.org/node/907578#comment-5564008
      require_once drupal_get_path('module', 'pathauto') . '/pathauto.inc';
      return pathauto_cleanstring($text);
    }
    return $text;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetApiPrettyPathsCoderDefault::decodePathSegmentAlias	public	function	Decode the alias part of a path segment in order to interpret it from a given pretty path.
FacetApiPrettyPathsCoderDefault::decodePathSegmentValue	public	function	Decode the value part of a path segment in order to interpret it from a given pretty path.	2
FacetApiPrettyPathsCoderDefault::encodePathSegment	public	function	Encode a path segment in order to output it as part of a pretty path.	2
FacetApiPrettyPathsCoderDefault::prettyPath	protected	function	Convert a given text to a pretty path using pathauto, if available.