Route Class Reference

Inheritance diagram for Route:

Public Member Functions
	__construct ($route='')
	setServiceClass ($serviceClass)
	getServiceClass ()
	setServiceMethod ($serviceMethod)
	getServiceMethod ()
	setSecure ($secure)
	isSecure ()
	setAclResources ($aclResources)
	getAclResources ()
	setParameters ($parameters)
	getParameters ()
	getRoutePath ()
Public Member Functions inherited from RouterInterface
	match (RequestInterface $request)

Protected Member Functions
	getRouteParts ()
	isVariable ($value)
	getPathParts ($path)

Protected Attributes
	$serviceClass
	$serviceMethod
	$secure
	$aclResources = []
	$parameters = []
	$variables = []
	$route

Detailed Description

Definition at line 13 of file Route.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$route = ''

)

Parameters

string

$route

Definition at line 53 of file Route.php.

    {
        $this->route = trim($route, '/');
    }

Member Function Documentation

getAclResources()

getAclResources

(

)

Get ACL resources list.

Returns

array

Definition at line 218 of file Route.php.

    {
        return $this->aclResources;
    }

getParameters()

getParameters

(

)

Get parameters list.

Returns

array

Definition at line 240 of file Route.php.

    {
        return $this->parameters;
    }

getPathParts()

getPathParts (   $path )

protected

Retrieve unified requested path

Parameters

string

$path

Returns

array

Definition at line 98 of file Route.php.

    {
        return explode('/', trim($path, '/'));
    }

getRouteParts()

getRouteParts ( )

protected

Split route by parts and variables

Returns

array

Definition at line 63 of file Route.php.

    {
        $result = [];
        $routeParts = explode('/', $this->route);
        foreach ($routeParts as $key => $value) {
            if ($this->isVariable($value)) {
                $this->variables[$key] = substr($value, 1);
                $value = null;
            }
            $result[$key] = $value;
        }
        return $result;
    }

getRoutePath()

getRoutePath

(

)

Get route path.

Returns

string

Definition at line 250 of file Route.php.

    {
        return $this->route;
    }

getServiceClass()

getServiceClass

(

)

Get service class.

Returns

string

Definition at line 152 of file Route.php.

    {
        return $this->serviceClass;
    }

getServiceMethod()

getServiceMethod

(

)

Get service method name.

Returns

string

Definition at line 174 of file Route.php.

    {
        return $this->serviceMethod;
    }

isSecure()

isSecure

(

)

Returns true if the route is secure

Returns

boolean

Definition at line 196 of file Route.php.

    {
        return $this->secure;
    }

isVariable()

isVariable (   $value )

protected

Check if current route part is a name of variable

Parameters

string

$value

Returns

bool

Definition at line 83 of file Route.php.

    {
        if (substr($value, 0, 1) == ':'
            && substr($value, 1, 1) != ':') {
            return true;
        }
        return false;
    }

setAclResources()

setAclResources

(

$aclResources

)

Set ACL resources list.

Parameters

array

$aclResources

Returns

$this

Definition at line 207 of file Route.php.

    {
        $this->aclResources = $aclResources;
        return $this;
    }

setParameters()

setParameters

(

$parameters

)

Set parameters list.

Parameters

array

$parameters

Returns

$this

Definition at line 229 of file Route.php.

    {
        $this->parameters = $parameters;
        return $this;
    }

setSecure()

setSecure

(

$secure

)

Set if the route is secure

Parameters

boolean

$secure

Returns

$this

Definition at line 185 of file Route.php.

    {
        $this->secure = $secure;
        return $this;
    }

setServiceClass()

setServiceClass

(

$serviceClass

)

Set service class.

Parameters

string

$serviceClass

Returns

$this

Definition at line 141 of file Route.php.

    {
        $this->serviceClass = $serviceClass;
        return $this;
    }

setServiceMethod()

setServiceMethod

(

$serviceMethod

)

Set service method name.

Parameters

string

$serviceMethod

Returns

$this

Definition at line 163 of file Route.php.

    {
        $this->serviceMethod = $serviceMethod;
        return $this;
    }

Field Documentation

$aclResources

$aclResources = []

protected

Definition at line 33 of file Route.php.

$parameters

$parameters = []

protected

Definition at line 38 of file Route.php.

$route

$route

protected

Definition at line 48 of file Route.php.

$secure

$secure

protected

Definition at line 28 of file Route.php.

$serviceClass

$serviceClass

protected

Definition at line 18 of file Route.php.

$serviceMethod

$serviceMethod

protected

Definition at line 23 of file Route.php.

$variables

$variables = []

protected

Definition at line 43 of file Route.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-webapi/Controller/Rest/Router/Route.php