Class Pattern

Representation of a route pattern.

<?php

use ICanBoogie\Routing\Pattern;

$pattern = Pattern::from("/blog/<year:\d{4}>-<month:\d{2}>-:slug.html");
echo $pattern;       // "/blog/<year:\d{4}>-<month:\d{2}>-:slug.html"

$pathname = $pattern->format([ 'year' => "2013", 'month' => "07", 'slug' => "test-is-a-test" ]);
echo $pathname;      // "/blog/2013-07-this-is-a-test.html"

$matching = $pattern->match($pathname, $captured);

var_dump($matching); // true
var_dump($captured); // [ 'year' => "2013", 'month' => "07", 'slug' => "test-is-a-test" ]

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

Namespace: ICanBoogie\Routing
Located at Pattern.php

Methods summary


				
				 protected static
				
				

				read_value_from_array( array $container, string $key )
				

				: mixed

Reads an offset from an array.


				
				 protected static
				
				

				read_value_from_object( object $container, string $key )
				

				: mixed

Reads a property from an object.


				
				 public static
				
				

				is_pattern( string $pattern )
				

				: boolean

Checks if the given string is a route pattern.


				
				 public static
				
				

				from( mixed $pattern )
				

				: ICanBoogie\Routing\Pattern

Creates a ICanBoogie\Routing\Pattern instance from the specified pattern.


				
				 protected 
				
				

				get_pattern( void )


				
				 protected 
				
				

				get_interleaved( void )


				
				 protected 
				
				

				get_params( void )


				
				 protected 
				
				

				get_regex( void )


				
				 protected 
				
				

				__construct( string $pattern )

Initializes the $pattern, $interleaved, $params and $regex properties.


				
				 public 
				
				

				__toString( void )
				

				: string

Returns the route pattern specified during construct.


				
				 public 
				
				

				format( array|object $values = null )
				

				: string

Formats a pattern with the specified values.

Parameters

$values: The values to format the pattern, either as an array or an object. If value is an instance of ICanBoogie\Routing\ToSlug the to_slug() method is used to transform the instance into a URL component.

Returns

string

Throws

ICanBoogie\Routing\PatternRequiresValues

in attempt to format a pattern requiring values without providing any.


				
				 public 
				
				

				match( string $pathname, array & $captured = null )
				

				: boolean

Checks if a pathname matches the pattern.

Properties summary


				
				protected static 
				

				
$extended_character_classes				

				: array

[

    '{:uuid:}' => '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}',
    '{:sha1:}' => '[a-f0-9]{40}'

]

Magic properties


				
				public  read-only
				

				
$pattern				

				: string

The pattern.


				
				public  read-only
				

				
$interleaved				

				: array

The interleaved parts of the pattern.


				
				public  read-only
				

				
$params				

				: array

The names of the pattern params.


				
				public  read-only
				

				
$regex				

				: string

The regex of the pattern.