Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

MapQueryParameter.php

Namespace

Symfony\Component\HttpKernel\Attribute

File

vendor/symfony/http-kernel/Attribute/MapQueryParameter.php

View source
<?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\Attribute;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;

/**
 * Can be used to pass a query parameter to a controller argument.
 *
 * @author Ruud Kamphuis <ruud@ticketswap.com>
 * @author Ionut Enache <i.ovidiuenache@yahoo.com>
 */
final class MapQueryParameter extends ValueResolver {
    
    /**
     * @see https://php.net/filter.filters.validate for filter, flags and options
     *
     * @param string|null                                         $name     The name of the query parameter; if null, the name of the argument in the controller will be used
     * @param (FILTER_VALIDATE_*)|(FILTER_SANITIZE_*)|null        $filter   The filter to pass to "filter_var()"
     * @param int-mask-of<(FILTER_FLAG_*)|FILTER_NULL_ON_FAILURE> $flags    The flags to pass to "filter_var()"
     * @param array                                               $options  The options to pass to "filter_var()"
     * @param class-string<ValueResolverInterface>|string         $resolver The name of the resolver to use
     */
    public function __construct(?string $name = null, ?int $filter = null, int $flags = 0, array $options = [], string $resolver = QueryParameterValueResolver::class, int $validationFailedStatusCode = Response::HTTP_NOT_FOUND) {
        parent::__construct($resolver);
    }

}

Classes

Title Deprecated Summary
MapQueryParameter Can be used to pass a query parameter to a controller argument.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal