abstract class RoutableFragmentRenderer in Zircon Profile 8

Adds the possibility to generate a fragment URI for a given Controller.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\Fragment\RoutableFragmentRenderer implements FragmentRendererInterface

File

vendor/symfony/http-kernel/Fragment/RoutableFragmentRenderer.php, line 23

Namespace

Symfony\Component\HttpKernel\Fragment

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
   * @param bool                $absolute  Whether to generate an absolute URL or not
   * @param bool                $strict    Whether to allow non-scalar attributes or not
   *
   * @return string A fragment URI
   */
  protected function generateFragmentUri(ControllerReference $reference, Request $request, $absolute = false, $strict = true) {
    if ($strict) {
      $this
        ->checkNonScalar($reference->attributes);
    }

    // We need to forward the current _format and _locale values as we don't have
    // a proper routing pattern to do the job for us.
    // This makes things inconsistent if you switch from rendering a controller
    // to rendering a route if the route pattern does not contain the special
    // _format and _locale placeholders.
    if (!isset($reference->attributes['_format'])) {
      $reference->attributes['_format'] = $request
        ->getRequestFormat();
    }
    if (!isset($reference->attributes['_locale'])) {
      $reference->attributes['_locale'] = $request
        ->getLocale();
    }
    $reference->attributes['_controller'] = $reference->controller;
    $reference->query['_path'] = http_build_query($reference->attributes, '', '&');
    $path = $this->fragmentPath . '?' . http_build_query($reference->query, '', '&');
    if ($absolute) {
      return $request
        ->getUriForPath($path);
    }
    return $request
      ->getBaseUrl() . $path;
  }
  private function checkNonScalar($values) {
    foreach ($values as $key => $value) {
      if (is_array($value)) {
        $this
          ->checkNonScalar($value);
      }
      elseif (!is_scalar($value) && null !== $value) {
        throw new \LogicException(sprintf('Controller attributes cannot contain non-scalar/non-null values (value for key "%s" is not a scalar or null).', $key));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FragmentRendererInterface::getName	public	function	Gets the name of the strategy.	5
FragmentRendererInterface::render	public	function	Renders a URI and returns the Response content.	4
RoutableFragmentRenderer::$fragmentPath	private	property
RoutableFragmentRenderer::checkNonScalar	private	function
RoutableFragmentRenderer::generateFragmentUri	protected	function	Generates a fragment URI for a given controller.
RoutableFragmentRenderer::setFragmentPath	public	function	Sets the fragment path that triggers the fragment listener.