Class Route

A route.

ICanBoogie\Routing\Route uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\Routing
Located at Route.php

Methods summary


				
				 public static
				
				

				from( array $definition )
				

				: ICanBoogie\Routing\Route

Creates a new ICanBoogie\Routing\Route instance from a route definition.


				
				 protected 
				
				

				get_pattern( void )


				
				 protected 
				
				

				get_controller( void )


				
				 protected 
				
				

				get_action( void )


				
				 protected 
				
				

				get_id( void )


				
				 protected 
				
				

				get_location( void )


				
				 protected 
				
				

				get_via( void )


				
				 protected 
				
				

				get_formatting_value( void )
				

				: mixed

Returns the formatting value.


				
				 protected 
				
				

				get_has_formatting_value( void )
				

				: boolean

Whether the route has a formatting value.


				
				 protected 
				
				

				get_url( void )
				

				: string

Returns relative URL.


				
				 protected 
				
				

				get_absolute_url( void )
				

				: string

Returns absolute URL.


				
				 public 
				
				

				__construct( string $pattern, array $properties )

Initializes the $pattern property and the properties provided.


				
				 public 
				
				

				__clone( void )


				
				 public 
				
				

				__toString( void )
				

				: string

Formats a route into a relative URL using its formatting value.


				
				 protected 
				
				

				assert_properties_are_valid( array $properties, array $invalid )

Asserts that properties are valid.


				
				 public 
				
				

				format( object|array|null $values = null )
				

				: ICanBoogie\Routing\FormattedRoute

Formats the route with the specified values.


				
				 public 
				
				

				assign( mixed $formatting_value )
				

				: ICanBoogie\Routing\Route

Assigns a formatting value to a route.


				
				protected static 
				

				
$invalid_construct_properties				

				: array

[ 'formatting_value', 'url', 'absolute_url' ]


				
				public  read-only
				

				
$pattern				

				: ICanBoogie\Routing\Pattern

The pattern of the route.


				
				public  read-only
				

				
$controller				

				: string

The class name of the controller.


				
				public  read-only
				

				
$action				

				: string|null

Controller action.


				
				public  read-only
				

				
$id				

				: string

Route identifier.


				
				public  read-only
				

				
$location				

				: string|null

Redirection destination.


				
				public  read-only
				

				
$via				

				: string|array|null

The supported HTTP methods.


				
				public  read-only
				

				
$url				

				: string

The contextualized URL of the route.


				
				public  read-only
				

				
$absolute_url				

				: string

The contextualized absolute URL of the route.


				
				public  read-only
				

				
$formatting_value				

				: mixed

The value used to format the route.


				
				public  read-only
				

				
$has_formatting_value				

				: boolean

true if the route has a formatting value, false otherwise.