class Route

Annotation class for @Route().

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\Routing\Annotation\Route

Expanded class hierarchy of Route

1 file declares its use of Route
RouteTest.php in drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Tests/Annotation/RouteTest.php
3 classes are annotated with Route
Controller::contactAction in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/Fixtures/Controller.php
Plugin annotation @Route("/contact", name="_demo_contact") @Template()
Controller::helloAction in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/Fixtures/Controller.php
Plugin annotation @Route("/hello/{name}", name="_demo_hello") @Template()
Controller::indexAction in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/Fixtures/Controller.php
Plugin annotation @Route("/", name="_demo") @Template()

File

drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Annotation/Route.php, line 21

Namespace

Symfony\Component\Routing\Annotation
View source
class Route {
  private $path;
  private $name;
  private $requirements;
  private $options;
  private $defaults;
  private $host;
  private $methods;
  private $schemes;

  /**
   * Constructor.
   *
   * @param array $data An array of key/value parameters.
   *
   * @throws \BadMethodCallException
   */
  public function __construct(array $data) {
    $this->requirements = array();
    $this->options = array();
    $this->defaults = array();
    $this->methods = array();
    $this->schemes = array();
    if (isset($data['value'])) {
      $data['path'] = $data['value'];
      unset($data['value']);
    }
    foreach ($data as $key => $value) {
      $method = 'set' . str_replace('_', '', $key);
      if (!method_exists($this, $method)) {
        throw new \BadMethodCallException(sprintf("Unknown property '%s' on annotation '%s'.", $key, get_class($this)));
      }
      $this
        ->{$method}($value);
    }
  }

  /**
   * @deprecated Deprecated in 2.2, to be removed in 3.0. Use setPath instead.
   */
  public function setPattern($pattern) {
    $this->path = $pattern;
  }

  /**
   * @deprecated Deprecated in 2.2, to be removed in 3.0. Use getPath instead.
   */
  public function getPattern() {
    return $this->path;
  }
  public function setPath($path) {
    $this->path = $path;
  }
  public function getPath() {
    return $this->path;
  }
  public function setHost($pattern) {
    $this->host = $pattern;
  }
  public function getHost() {
    return $this->host;
  }
  public function setName($name) {
    $this->name = $name;
  }
  public function getName() {
    return $this->name;
  }
  public function setRequirements($requirements) {
    $this->requirements = $requirements;
  }
  public function getRequirements() {
    return $this->requirements;
  }
  public function setOptions($options) {
    $this->options = $options;
  }
  public function getOptions() {
    return $this->options;
  }
  public function setDefaults($defaults) {
    $this->defaults = $defaults;
  }
  public function getDefaults() {
    return $this->defaults;
  }
  public function setSchemes($schemes) {
    $this->schemes = is_array($schemes) ? $schemes : array(
      $schemes,
    );
  }
  public function getSchemes() {
    return $this->schemes;
  }
  public function setMethods($methods) {
    $this->methods = is_array($methods) ? $methods : array(
      $methods,
    );
  }
  public function getMethods() {
    return $this->methods;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Route::$defaults private property
Route::$host private property
Route::$methods private property
Route::$name private property
Route::$options private property
Route::$path private property
Route::$requirements private property
Route::$schemes private property
Route::getDefaults public function
Route::getHost public function
Route::getMethods public function
Route::getName public function
Route::getOptions public function
Route::getPath public function
Route::getPattern Deprecated public function
Route::getRequirements public function
Route::getSchemes public function
Route::setDefaults public function
Route::setHost public function
Route::setMethods public function
Route::setName public function
Route::setOptions public function
Route::setPath public function
Route::setPattern Deprecated public function
Route::setRequirements public function
Route::setSchemes public function
Route::__construct public function Constructor.