ProdigyView Documentation
Back to top  

PVRouter

Extends \PVStaticObject

PVRouter is responsible for parsing the URL setting up the ability for routing within your application.

Applications, especially with Frontend Controller Design Pattern, may require routing to get a user to their destination correctly. This class can take rules, route and correctly navigate the user to their destination.

package

network

Methods

Uses the magic method __call and executes a closure/anonymous function that has been added to the classes $_methods using the addMethod() method.

__callStatic(string $method, mixed $args = array()) : mixed
inherited static
access

public

Arguments

$method

string

The key/name assigned to the method when added

$args

mixed

Arguements to pass to the annoymous function. The function is called using call_user_func_array.

Response

mixed

$value The value returned is the value the stored function returns

Apply a fitler if filter is set.

_applyFilter(string $class, string $method, mixed $data, array $options = array()) : mixed
inherited static
access

protected

Arguments

$class

string

The name of the class the filter is in

$method

string

The method the filter is in

$data

mixed

The data that is being passed to the filter

$options

array

options to be passed to the filter. Passed options we be passed to the function. -'default_return' mixed: If no filter is return, the data passed in by default will be return. Can be overriden -'event' string: An event to associate with the filter. Default is null

Response

mixed

$data The data the function returns

Calls an adapter for this class. The easiest way of implementing an adapter is by placing the adapter at the top of the function that it is being called in. An infinite amout of parameters can be passed to the adapter BUT the parameters should be the same as the parents.

_callAdapter(string $class, string $method) : mixed
inherited static
access

protected

Arguments

$class

string

The name of the class the adapter is in

$method

string

THe name of the method the class is being called from.

Response

mixed

$value A value that the adapter returns

Checks if an adapter is set for the function.

_hasAdapter( $class, string $method) : \boolea
inherited static
access

protected

Arguments

$class

$method

string

The associated method

Response

\boolea

$hasAdapter Returns true if it has an adapter or false if it doesn not

Checks if a filter has been set.

_hasFilter(string $class, string $method)
inherited static

Arguments

$class

string

The class the filter is in

$method

string

The method of the class that the filter is in

Calls a methods that is an instance of an class. This method is generally faster than using user_call_func_array.

_invokeMethod(string $class, string $method, array $args) : mixed
inherited static
access

protected

Arguments

$class

string

The name of the class to be called

$method

string

The name of the method in the class to be called

$args

array

An array of arguements. Arguements have to be embedded in an array to be called.

Response

mixed

$data Data returned by the function called

Calls a methods that is a static method of a class. This method is generally faster than using user_call_func_array.

_invokeStaticMethod(string $class, string $method, array $args) : mixed
inherited static
access

protected

Arguments

$class

string

The name of the class to be called

$method

string

The name of the method in the class to be called

$args

array

An array of arguements. Arguements have to be embedded in an array to be called.

Response

mixed

$data Data returned by the function called

Write out the contents of adapters used to a log

_logAdapter(array $data) : void
inherited static
access

private

Arguments

$data

array

The data in the adapter

Write out the contents of a filter used to a log

_logFilter(array $data) : void
inherited static
access

private

Arguments

$data

array

The data in the filter

Write out the contents of an observer to a log.

_logObserver(array $data) : void
inherited static
access

private

Arguments

$data

array

The data in the observer

Calls any functions that have been added to the observer if the event is present in the observers array.

_notify(string $event) : void
inherited static
access

protected

Arguments

$event

string

The name of the even that occured that will trigger notifies

Breaks down the data to be logged from an adapter, filter or observer.

_prepareLogData(array $data) : string
inherited static
access

private

Arguments

$data

array

Response

string

$message JSON encode message of information about the data

Checks the HTTPS is currently on. If its not then nothiing is done, else it will redirect to an SSL connection.

activateSSL(string $url = '') : void
static
access

public

Arguments

$url

string

An Optional parameter to be redirected to.

Adapters allows a method to be completely overwritten by calling a different class with the same method name. Adapters can also be used with closures. The adapter uses a strategy/adapter design pattern.

addAdapter(string $trigger_class, string $trigger_method, string $call_class, array $options = array()) : void
inherited static
access

public
todo

add ability to adapt singleton class

Arguments

$trigger_class

string

The class that contains the function the adapter will respond too

$trigger_method

string

The method called that will have the adapter to be called.

$call_class

string

The new class to be called that has the same method name

$options

array

An array of options that be called -'object' string : Assumes that default method in the class to be called is static. If called object needs to be instantiated, change to object to 'instance' and one will be created before the adapter calls the function -'call_method' string: By default the method to be called to override the current one should be the same name. But this can be ovveridden to call a different method. -'type' string: The type of method being called. Default is class_method but if the method is a closure, set the type to be 'closure' and make the $trigger_method the closure

Will add an adapter for every method in the trigger_class to another class. The method will only be adapted to another class if the method in the trigger class has an adapter. This functionality can be very similiar to DI.

addClassAdapter(mixed $trigger_class, string $call_class, array $options = array()) : void
inherited static
access

public
todo

Add ability to use singleton classes

Arguments

$trigger_class

mixed

This can either be the name of the class or an object whose methods will be adapted to another class. The class should be included or be autoloaded by this point.

$call_class

string

The call class is the classes methods that will be called in place of the methods in the trigger_class. These class does not have to be included as this point.

$options

array

Options that be used to further distinguish the behavior of the adapters added -'object' string: Determines if the object being adapted to is static or an instance.Default is static -'call_class' string: The name of the class that the methods will be adapted too. -'class' string: The name of the whose methods will be adapted to another class

Adds a filter to the class. Filters are for modifying a value within a class and should not interpet the normal flow within the method.

addFilter(string $class, string $method, string $filter_class, string $filter_method, array $options = array()) : void
inherited static
access

public

Arguments

$class

string

The name of the class the filter is going in

$method

string

The name of the method the filter is in

$filter_class

string

The class that the filter resides in.

$filter_method

string

The method in the class that the parameters will be passed too.

$options

array

Options that can be set for further modifying the filter. -'object' string: If the method being called is static, static should be inserted. If its in an instance, 'instance' should be set. Default is set to static. -'event' string: Associate this filter with an event. -'type' string: The type of function being called. Default is class_method but if the function is a closure, set the type to be 'closure' and make the $filter_method the closure

Adds a closure/anonymous function to the object that can be called.

addMethod(string $method, \function $closure) : void
inherited static
access

public

Arguments

$method

string

The key/value that will be used to call the function

$closure

\function

The anonymous function/closure to be added

Adds an observer to the class. Observer events can fired in any method to trigger a response.

addObserver(string $event, string $class, string $method, array $options = array()) : void
inherited static
access

public

Arguments

$event

string

The name of the event that will cause a certain class and method to fire

$class

string

The name of the class that contains the function that will be fired for this event

$method

string

The name of the method that will be fired when the event occurs

$options

array

Options to further the define the firing of an event -'object' string : If the method being called is static, should be set to static. Else set to instance -'class' stinrg : The name of the class to be called. Default is the class that is passed in. -'method' string: The name of the method to be called. Default is the method that is passed in. -'type' string: The type of function being called. Default is class_method but if the function is a closure, set the type to be 'closure' and make the $method the closure

Adds a rule to the router. The rule determines how the router will react.

addRouteRule(mixed $route) : void
static

.

Arguments

$route

mixed

Can a string that merely sets a rule or an array with configuration information for rule.

  • 'rule' string: A rule to follow that will be matched using a preg_match.
  • 'redirect' string: A location to redirect if the uri matches the rule
  • 'access_level' int: A level of access required for the matching rule.
  • 'access_level_redirect' string: The location to be redirected too if the route matches and the access level was not high enough.
  • 'user_roles' array: An array of user roles that are allowed to access this location
  • 'user_roles_redirect' string: A location to be redirected to if the route matches and the required role was not present.

Adds a data to the public collection, index will be assigned automatically. Primarily used for adding launch quanties of data to the collection

addToCollection(mixed $data) : void
inherited static
access

public

Arguments

$data

mixed

Any data type( Object, Array, int, etc) to add to the public data collection

Adds data to the public collection. The data is assigned a key/index. If the key/index is already set, new information will override the old one.

addToCollectionWithName(string $name, mixed $data) : void
inherited static
access

public
todo

check the relevance of get and set

Arguments

$name

string

The key/index to assign the value to

$data

mixed

Data to be stored in the collection

Remove all the filters from a class.

clearFilters(string $class, string $method) : void
inherited static
access

public

Arguments

$class

string

The class the filter is in

$method

string

The method of the class that the filter is in

Removes all the observers assoicated with an event.

clearObservers(string $event) : void
inherited static
access

public

Arguments

$event

string

The event to remove all the observers from

If the current url is open on an SSL connection, the url will be made into a normal connectin.

deactivateSSL( $url = '')
static

Arguments

$url

Retrieves a value that is in the public data collection or was pass through by the set method.

get(string $index) : mixed
inherited static
access

public

Arguments

$index

string

The index to retrieve a value from

Response

mixed

$data The data that was stored at that index

Returns the instance of a class. Used for implementing the singleton design pattern. Class will only be instantiated once.

getInstance() : object
inherited static
access

public

Response

object

$instance Returns the instance of a class.

Returns the iterator for iterating through the values stored in the classes collection.

getIterator() : \PVIterator
inherited static

Response

\PVIterator

$iterator The classes collection in an iteratable form

access public

Returns the current options associated with the route, if they have been set.

getRoute() : array
static
access

public

Response

array

options: The options associated with the set route

Returns a parameter that is embeed within the route.

getRouteParameter(string $parameter) : string
static

Arguments

$parameter

string

The parameter being looked for

Response

string

The found value, if any

Gets the variable if specified in a rule.

getRouteVariable(string $parameter) : string
static

Example: PVRouter::addRouteRule('/:controller/:action/:id');

PVRouter::setRoute(/post/view/3124);

$id=PVRouter::getRouteVariable('id'); echo $id //Should print 3124

access

public

Arguments

$parameter

string

A variable to retrieve that is in the url

Response

string

$variable Gets the variable, if it exist.

Returns all the variables that are specified in a route.

getRouteVariables() : array
static
access

public

Response

array

Initializes the router and sets up default parameters and default rules for using the router. Seo urls is the ability to create and use easily readabable urls.

init(array $config = array()) : void
static
access

public

Arguments

$config

array

The configuration to add to the router. -'seo_urls' boolean: Defaulted to true, specifiy to always make the urls appear seo friendly -'default_rule_replace' string: Specifies what to look for when defining a parameter in a router -'default_route_replace' string : When a rule is found, speficies what to replace it with before parsing

Determines of the connection is secure behind SSL to TLS. Default functionality utilizes the server.

isSecureConnection() : boolean
static

Response

boolean

Return true is secure, otherwise false

If the url is a valid url, such as another site, the url will be point to that site.

redirect(string $url, boolean $exit = true) : void
static

Otherwise it is run through the router and actions are taken if needed.

access

public

Arguments

$url

string

A url to be redirected too.

$exit

boolean

Exit script after header is set

Removes an adapter.

removeAdapter( $class, string $method) : void
inherited static
access

public

Arguments

$class

$method

string

The associated method

Removes an adapter for an entire class.

removeClassAdapter( $class) : void
inherited static
access

public

Arguments

$class

Adds a value to the classes Collection. By default the collection is stored in the public collection. The stored instance can be retrieved later by called in it's key value.

set(string $index, mixed $value) : void
inherited static
access

public

Arguments

$index

string

The key or index to store the value at

$value

mixed

A mixed value that can be anytype

Turn on/off the ability to trace an adapter.Turning on will log an adapter using PVLog when adapter is executed.

setAdapterTrace(boolean $trace = false) : void
inherited static
access

public

Arguments

$trace

boolean

Default is false. If set to true, will trace adatper.

Turn on/off the ability to trace an filter.Turning on will log a filter using PVLog when filter is executed.

setFilterTrace(boolean $trace = false) : void
inherited static
access

public

Arguments

$trace

boolean

Default is false. If set to true, will trace filter.

Turn on/off the ability to trace an observer.Turning on will log an observer using PVLog when the observer is executed.

setObserverTrace(boolean $trace = false) : void
inherited static
access

public

Arguments

$trace

boolean

Default is false. If set to true, will trace observer.

Sets the current uri. If the uri is empty, the default uri will be used. How the uri will react depends on how the route rules are specified. If redirects are set and the uri matches a rule, a redirect will be automatically instantied.

setRoute( $uri = '') : void
static
access

public

Arguments

$uri

If SEO Urls is on and the url has query data present, the data will be converted to search engine friendly urls.

url(string $url, array $options = array()) : string
static

Example: $url = PVRouter::url(index.php?id=gohard&option=gohome); echo $url

//Will print out /gohard/gohome

access

public

Arguments

$url

string

A url to be parsed

$options

array

Response

string

$url Returns the url

Properties

A list of routes that have been added

routes :
static

Type(s)

Items within a route, after is has been parsed

route_parameters :
static

Type(s)

Configurationoptions around a route

route_options :
static

Type(s)

Attempt to make Seo friendy urls

seo_urls :
static

Type(s)

Specifies what to look for when defining a parameter in a router

default_rule_replace :
static

Type(s)

When a rule is found, speficies what to replace it with before parsing

default_route_replace :
static

Type(s)

A collection of items that belong to this class

_collection :
inherited static

Type(s)

A collection of dynamically added methods that below to this class

_methods :
inherited static

Type(s)

The adapters that have been added

_adapters :
inherited static

Type(s)

Observers that have been added

_observers :
inherited static

Type(s)

Instances for singleton that have added

_instances :
inherited static

Type(s)

Intercepting filters that have been added

_filters :
inherited static

Type(s)

Boolean for following and logging adapters that have been added

_traceAdapters :
inherited static

Type(s)

Boolean for following and logging filters that have been added

_traceFilters :
inherited static

Type(s)

Boolean for following and logging observers that have been added.

_traceObservers :
inherited static

Type(s)