Router

 

Router::getAccessPoint

Retorna el punto de acceso actual.

public Router::getAccessPoint( ): string

 

Router::getAccessPoints

Devuelve todos los puntos de acceso disponibles.

public function routeWith ( string $uri, array $paramNames, string|array $callback, string $id = '' )

 

Router::getComponent

Devuelve el nombre del componente, o del subcomponente, actual.

public Router::getComponent( bool $full = false ): string

full

En caso de true, devolverá tambien el subcomponente.

 

Router::getTask

Devuelve la tarea actual.

public Router::getTask( ): string

 

Router::getFormat

Devuelve el formato actual.

public Router::getFormat( ): string

 

Router::isFormat

Verifica el formato actual.

public Router::isFormat( string $format ): bool

 

Router::getController

Devuelve el controlador actual. En caso de no hallarlo, devolverá false.

public Router::getController(): callable|false

 

Router::getControllerAsString

Devuelve el nombre del controlador actual.

public Router::getControllerAsString( ): string

 

Router::getRoute

Devuelve la ruta actual.

public Router::getRoute( ): string

 

Router::getArgsWithFormat

A un arreglo de argumentos, le agrega un formato. Se utiliza para indicar en una url de consulta, un formato de salida.

public Router::getArgsWithFormat( string $format, array $args = [] ): array

 

Router::getHash

Devuelve una cadena, basada en la ruta que se está ejecutando actualmente.

public Router::getHash( ): string

 

Generadores de Url

Router::getUrl

url

Crea una URL.

public Router::getUrl ( string $route = '', array  $args = [], bool   $absolute = false): string

/* Alias */
function url ( string $route = '', array  $args = [], bool   $absolute = false): string

route

La ruta al recurso. El formato debe ser: access_point/component/task. Todos los valores se deberían poder omitir.

args

Otros valores que se agregarán a la cadena de consulta.

absolute

Crea una URL absoluta en lugar de una relativa.

 

Router::getUrlForm

Cumple la misma función que Router::getUrl pero la salida está orientada a un formulario. Devuelve un array con dos valores:

• action: la acción para el formulario.
• hidden: elementos ocultos del formulario con los restantes valores a enviar.

public Router::getUrlForm ( string $route = '',  array $args = [], bool $absolute = false ): array

 

Router::absoluteUrl

Devuelve una url con su ruta absoluta.

public Router::absoluteUrl( string $url ): string

 

Router::redirect

redirect

Redirecciona la Url.

public Router::redirect ( $url = null, bool $absolute = true ): void

/* Alias */
redirect ( $url = null, bool $absolute = true ): void

url

La url a la cual será redirigida la página.

Los valores pueden ser:

1. Un array con los valores para construir la url con Router::getUrl.
2. El número 401 que redirige al Login.
3. El número 404 que redirige a una página de error.
4. Una cadena con la url.

absolute

Crea una URL absoluta en lugar de una relativa.

 

Routes

Routes::route

Registra una uri, la cual quedará asociada con la tarea de un controlador.

public Routes::route ( string $uri, string|array $callback, string $id = '' )

uri

La uri a registrar. La uri puede estar precedida por los métodos válidos.

callback

La función de retorno. Si es una cadena, será el nombre del método del controlador por defecto. Si es un array, será un callable.

id

Una Id con la cual identificar la uri.

 

Ejemplos

$routes->route('/articles', 'list', '#list');
$routes->route('/articles/{id:int}', 'show', '#show');
$routes->route('DELETE /articles/{id:int}', 'delete');

 

Routes::routeWith

La función es similar a Router::route, sólo que la uri será valida si además contiene los parámetros pasados en el arreglo $paramNames.

public Routes::routeWith ( string $uri, array $paramNames, string|array $callback, string $id = '' )