RoutableFragmentRenderer.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpKernel\Fragment;

use Symfony\Component\HttpKernel\Controller\ControllerReference;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\EventListener\FragmentListener;

/**
 * Adds the possibility to generate a fragment URI for a given Controller.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
abstract class RoutableFragmentRenderer implements FragmentRendererInterface {
  private $fragmentPath = '/_fragment';

  /**
   * Sets the fragment path that triggers the fragment listener.
   *
   * @param string $path The path
   *
   * @see FragmentListener
   */
  public function setFragmentPath($path) {
    $this->fragmentPath = $path;
  }

  /**
   * Generates a fragment URI for a given controller.
   *
   * @param ControllerReference  $reference A ControllerReference instance
   * @param Request              $request    A Request instance
   *
   * @return string A fragment URI
   */
  protected function generateFragmentUri(ControllerReference $reference, Request $request) {
    if (!isset($reference->attributes['_format'])) {
      $reference->attributes['_format'] = $request
        ->getRequestFormat();
    }
    $reference->attributes['_controller'] = $reference->controller;
    $reference->query['_path'] = http_build_query($reference->attributes, '', '&');
    return $request
      ->getUriForPath($this->fragmentPath . '?' . http_build_query($reference->query, '', '&'));
  }

}