\EntradaHistorial

Representa un item en el historial de navegación, es decir, una página visitada.

Contiene el url de la página y datos extra que pudiera tener.

Summary

Methods
Properties
Constants
__construct()
uri()
esActual()
guardar_variables()
eliminar_variables()
variable()
variables()
__toString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(\HistorialNavegacion  $historial, string  $uri = null) 

Constructor de la clase.

Parameters

\HistorialNavegacion $historial

el historial que contiene la nueva entrada

string $uri

el URI de la página que la nueva entrada representa; si es null se guarda el URI del request

uri()

uri() : string

Retorna la propiedad uri de la clase

Returns

string

esActual()

esActual() : boolean

Permite comprobar si esta entrada representa la página actual.

Sólo tiene en cuenta la página, no los posibles parámetros GET.

Returns

boolean

guardar_variables()

guardar_variables(array  $variables, boolean  $solo_si_actual = true) 

Guarda en la entrada las variables contenidas en <var>$variables</var>.

Si ya hay una variable guardada con una clave existente en $variables, se sobreescribe.

Parameters

array $variables

pares clave => valor a guardar ejemplo: $variables = array('var1' => 'a', 'var2' => 5)

boolean $solo_si_actual

¿sólo se debe realizar la operación si esta entrada es la actual en el historial?

eliminar_variables()

eliminar_variables(array  $variables, boolean  $solo_si_actual = true) 

Elimina de la entrada las variables indicadas en <var>$variables</var>.

Si $variables contiene nombres que no existen en la entrada, se ignoran.

Parameters

array $variables

lista de nombres de variables a eliminar; ejemplo: $variables = array('var1', 'var2')

boolean $solo_si_actual

¿sólo se debe realizar la operación si esta entrada es la actual en el historial?

variable()

variable(string  $clave, mixed  $default = null) : mixed

Devuelve el valor de una variable guardada en esta entrada.

Parameters

string $clave

la clave de la variable a obtener

mixed $default

valor a retornar si no existe la variable $clave en esta entrada

Returns

mixed

variables()

variables() : array

Devuelve un arreglo de variables guardadas en esta entrada.

Returns

array

__toString()

__toString() : string

Devuelve una representación textual de esta entrada.

Returns

string