Overview

Namespaces

  • MvcCore
    • Ext
      • Auth
        • Virtual
      • Debug
        • Tracy
      • Form
        • Core
        • Validators
      • Request
      • Router
        • Lang
      • View
        • Helpers
  • None

Classes

  • Config
  • Controller
  • Debug
  • Model
  • Request
  • Response
  • Route
  • Router
  • Session
  • Tool
  • View
  • Overview
  • Namespace
  • Class
  • Tree

Class Route

Core route: - describing request input, url output, controller/action target and default params - required properties to set: - Pattern - classic preg_match() pattern including border '#' characters, containing char groups - Reverse - url form with {%param} replacements where to insert param values from url method - Controller - controller to create and dispatch or view directory name, pascal case - Action - controller action to execute or view name to render, pascal case - Name - 'Controller:Action' or any custom route name how to create url in application by Url() method - Params - default params to set before controller/action dispatching if no params in request

Direct known subclasses

MvcCore\Ext\Router\Lang\Route
Namespace: MvcCore
Located at mvccore/src/MvcCore/Route.php
Methods summary
public static MvcCore\Route
# GetInstance( array|stdClass $object )

Get new instance by array or stdClass, if created, return it

Get new instance by array or stdClass, if created, return it

Parameters

$object
route configuration data

Returns

MvcCore\Route
public
# __construct( $nameOrConfig = NULL, $controller = NULL, $action = NULL, $pattern = NULL, $reverse = NULL, $params = array() )

Create new route

Create new route

Parameters

$nameOrConfig
required
$controller
optional
$action
optional
$pattern
optional
$reverse
optional
$params
optional
public MvcCore\Route
# SetName( string $name )

Set route name, your custom keyword/term or pascal case combination of 'Controller:Action'

Set route name, your custom keyword/term or pascal case combination of 'Controller:Action'

Parameters

$name

Returns

MvcCore\Route
public MvcCore\Route
# SetController( string $controller )

Set controller name in pascal case.

Set controller name in pascal case.

Parameters

$controller

Returns

MvcCore\Route
public MvcCore\Route
# SetAction( string $action )

Set action name in pascal case.

Set action name in pascal case.

Parameters

$action

Returns

MvcCore\Route
public MvcCore\Route
# SetPattern( string $pattern )

Set route preg_match pattern in classic PHP form: "#^/url-begin/([^/])/([^/])/(.*)#".

Set route preg_match pattern in classic PHP form: "#^/url-begin/([^/])/([^/])/(.*)#".

Parameters

$pattern

Returns

MvcCore\Route
public MvcCore\Route
# SetReverse( string $reverse )

Set route reverse address form from preg_replace pattern in form: "/url-begin/{%first}/{%second}/{%third}".

Set route reverse address form from preg_replace pattern in form: "/url-begin/{%first}/{%second}/{%third}".

Parameters

$reverse

Returns

MvcCore\Route
public MvcCore\Route
# SetParams( array $params = array() )

Set route params with default values in form: array('first' => 1, 'second' => 2, 'third' => 3).

Set route params with default values in form: array('first' => 1, 'second' => 2, 'third' => 3).

Parameters

$params

Returns

MvcCore\Route
Properties summary
public string $Name

Route name, your custom keyword/term or pascal case combination of 'Controller:Action'.

Route name, your custom keyword/term or pascal case combination of 'Controller:Action'.

# ''
public string $Controller

Controller name in pascal case.

Controller name in pascal case.

# ''
public string $Action

Action name in pascal case.

Action name in pascal case.

# ''
public string $Pattern

Route preg_match pattern in classic PHP form: "#^/url-begin/([^/])/([^/])/(.*)#".

Route preg_match pattern in classic PHP form: "#^/url-begin/([^/])/([^/])/(.*)#".

# ''
public string $Reverse

Route reverse address form from preg_replace pattern in form: "/url-begin/{%first}/{%second}/{%third}".

Route reverse address form from preg_replace pattern in form: "/url-begin/{%first}/{%second}/{%third}".

# ''
public array $Params

Route params with default values in form: array('first' => 1, 'second' => 2, 'third' => 3).

Route params with default values in form: array('first' => 1, 'second' => 2, 'third' => 3).

# array()
MvcCore API documentation generated by ApiGen