DOMbasic  1.0
DOMBasic es un Framework PHP para la creación de elementos DOM que generan contenido HTML dinámico y permite su modificación 'al vuelo' (Websites). Está escrito entéramente en PHP y sigue el paradigma POO.
Métodos públicos | Métodos públicos estáticos | Campos de datos | Métodos protegidos | Atributos protegidos
Referencia de la Clase DOM_attribs
Diagrama de herencias de DOM_attribs
DOM_element DOM_textNode

Métodos públicos

 __construct ($asocArrayAttribs=null)
 
 setReadOnly ($readOnly)
 
 getReadOnly ()
 
 reinicializar ()
 
 __get ($attrib)
 
 __set ($attrib, $value)
 
 __isset ($attrib)
 
 __unset ($attrib)
 
 offsetExists ($attrib)
 
 offsetGet ($attrib)
 
 offsetSet ($attrib, $value)
 
 offsetUnset ($attrib)
 
 getIterator ()
 
 setAttribs ($asocArrayAttribs)
 
 getAttribs ()
 
 getAttribsStr ()
 
 addAttrib ($attrib, $valorAttrib)
 
 addAttribs ($arrayAttribs)
 
 removeAttrib ($attrib)
 
 removeAttribs ($arrayAttribs)
 
 clearAttribs ()
 
 countAttrs ()
 
 equals ($objAttribs)
 
 __toString ()
 
 toJSON ($return=true, $base64values=true)
 
 fromJSON ($arrJSON)
 
 setEjemplo ()
 

Métodos públicos estáticos

static arrayFromURL ($strURLquery)
 
static filtrarStrJSON ($str="")
 
static writeLog ($mensaje, $trace)
 

Campos de datos

const N_C = __CLASS__
 
const ENCODE_RFC_1738 ="RFC_1738"
 
const ENCODE_RFC_3986 ="RFC_3986"
 

Métodos protegidos

 tryingWrite ($arg="")
 
 toURL ($encode=self::ENCODE_RFC_3986)
 
 fromURL ($strURLquery)
 

Atributos protegidos

 $_READ_ONLY =false
 
 $AVISO_GET =false
 
 $_attribs =array()
 

Descripción detallada

Interfaz para crear atributos de elementos DOM. Para que objetos derivados del DOM (como links, ...) implementen atributos HTML.

El programador debe asegurarse que son nombres estandarizados para los atributos de elementos DOM. (W3C)

TODO: FILTRADO: <del>Solo se admitiran nombres estandarizados para los atributos de elementos DOM. (W3C)</del>

Admite CONCATENACION DE METODOS mediante el retorno de la construccion '$this' en todos los metodos 'NO-GETTER': … $this->setAttrib('href','http://www.uno.com/')->removeAttrib('href');

Documentación del constructor y destructor

__construct (   $asocArrayAttribs = null)

CONSTRUCTOR PHP 5, CON ENTREGA DIRECTA DE ATRIBUTOS.

El parametro sera un array asociativo de atributos con pares correctos 'clave=valor'.

El programador debe asegurarse que son nombres estandarizados para los atributos de elementos DOM.(W3C)

TODO: FILTRADO: <del>Solo se admitiran nombres estandarizados para los atributos de elementos DOM. (W3C)</del>

Parámetros
$asocArrayAttribsArray de pares 'clave=valor' de atributos DOM.

Documentación de las funciones miembro

__get (   $attrib)

Property get access. Simply returns a given attrib.

Excepciones
DOMAttribNotFoundExceptionIf a the value for the property attrib is not an instance of
Parámetros
string$attribThe name of the attrib to get.
Devuelve
mixed The attrib value.
Excepciones
DOMBasicAttribNotFoundExceptionif the given property does not exist.
DOMBasicAttribReadOnlyExceptionif the attrib to be set is a write-only property.
__isset (   $attrib)

Returns if an attrib exists. (Desde PHP 5.1.0 )

Parámetros
string$attribAttrib name to check for.
Devuelve
bool Whether the attrib exists.
__set (   $attrib,
  $value 
)

Sets an attrib. This method is called when an attrib is set.

Parámetros
string$attribNameThe name of the attrib to set.
mixed$attribValueThe attrib value.
Devuelve
DOM_element $this este elemento (DOM). (NO-UTIL)
Excepciones
DOMBasicAttribNotFoundExceptionif the given attrib does not exist.
DOMBasicValueExceptionif the value to be assigned to a attrib is invalid.
DOMBasicAttribReadOnlyExceptionif the attrib to be set is a read-only attrib.
__unset (   $attrib)

Desde PHP 5.1.0

Excepciones
DOMBasicAttribReadOnlyExceptionIf 'Read Only' ON.
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
Parámetros
string$attribThe name of the attrib to unset.
addAttrib (   $attrib,
  $valorAttrib 
)

El programador debe asegurarse que los atributos aportados son nombres estandarizados y valores validos para los atributos de elementos DOM.(W3C)

Retorna <del>el total de los atributos establecidos si no hay exceptcion.</del> $this

TODO: FILTRADO: <del>Solo se admitiran nombres estandarizados para los atributos de elementos DOM. (W3C)</del>

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
string$attribThe name of the attrib to add.
mixed$valorAttribThe value of the attrib to add.
Devuelve
DOM_element $this este elemento (DOM).
addAttribs (   $arrayAttribs)

Añade atributos (si no existian previamente). El parametro sera un array asociativo de atributos con pares correctos 'clave=valor'.

Retorna <del>el total de los atributos establecidos.</del> $this

El programador debe asegurarse que son nombres estandarizados (y valores validos) para los atributos de elementos DOM.(W3C)

TODO: FILTRADO: <del>Solo se admitiran nombres estandarizados para los atributos de elementos DOM. (W3C)</del>

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
array$arrayAttribsThe array of the attribs to add.
Devuelve
DOM_element $this este elemento (DOM).
static arrayFromURL (   $strURLquery)
static

Retorna un array de atributos con sus correspondientes valores extraidos de una cadena con el formato de las URL's.

El parametro es la cadena desde la que se extraeran los atributos y sus valores, esta cadena tendra el formato de las URL's (relativa o absoluta) donde debe incluirsele una 'queryString' (entre '?' y '#'), Igual a la generada por el metodo toURL().

Parámetros
$strURLqueryCadena desde la que se extraeran los atributos y sus valores, esta cadena tendra el formato entregado en las URL's como parte de su 'queryString' (entre '?' y '#').
Devuelve
Array de atributos extraidos de la queryString.
clearAttribs ( )

Suprime o elimina todos los atributos. Retorna <del>el numero de atributos que quedan.</del> $this

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Devuelve
DOM_element $this este elemento (DOM).
countAttrs ( )

Retorna el total de los atribuos establecidos.

Devuelve
int Total de atributos establecidos
equals (   $objAttribs)

Compara si otro objeto es igual a este (no si es el mismo); para esto se tienen que cumplir las siguientes normas:

  • Que los dos sean instancias de la misma Clase (DOM_attribs).
  • Que los dos tengan definidos el mismo numero de atributos y con los mismos valores.
Parámetros
DOM_attribs$objAttribsAlgun objeto instancia de esta Clase
Devuelve
boolean
static filtrarStrJSON (   $str = "")
static

Limpia una cadena de RETORNOS DE CARRO, AVANCES DE LINEA y TABULACIONES, preparandola asi para datos JSON

fromURL (   $strURLquery)
protected

Establece y retorna un array de atributos con sus correspondientes valores extraidos de una cadena con el formato de las URL's, para construir Atributos de este Objeto.

El parametro es la cadena desde la que se extraeran los atributos y sus valores, esta cadena tendra el formato de las URL's (relativa o absoluta) donde debe incluirsele una 'queryString' (entre '?' y '#'), Igual a la generada por el metodo toURL().

Parámetros
$strURLqueryCadena desde la que se extraeran los atributos y sus valores, esta cadena tendra el formato entregado en las URL's como parte de su 'queryString' (entre '?' y '#').
Devuelve
Array de atributos extraidos de la queryString.
getAttribs ( )

Retorna todos los atributos establecidos como un array asociativo 'clave=valor'.

Devuelve
array assoc attribs (key=value) or null if not defined.
getAttribsStr ( )

Retorna todos los atributos establecidos como una cadena con los pares 'clave=valor' separados por espacios.

Si el atributo comienza con la palabra reservada '_null' entonces solo imprimira el valor entrecomillado, por el contrario si el valor es 'nulo' entonces solo imprimira la clave (sin comillas).

Este metodo esta pensado para poder retornar atributos de etiquetas XHTML (y XML), donde existen casos de atributos sin valor y otros de atributos sin clave (por ej. en la etiqueta 'DOCTYPE')

Es sinonimo de '__toString()'.

OJO !!: Que sea sinonimo no significa que pueda llamarse dentro de esta funcion a '__toString()' ya que crearia una REFERENCIA CIRCULAR!..

;

Devuelve
string Cadena de pares 'attrib="attribValue"' separados por espacios
getReadOnly ( )
abstract

Comprueba si los atributos de este elemento son DE SOLO LECTURA O ESCRIBIBLES.

Devuelve
boolean
offsetExists (   $attrib)

Returns if an attrib exists. Allows isset() using ArrayAccess.

Parámetros
string$attribThe name of the attrib to get.
Devuelve
bool Whether the attrib exists.
offsetGet (   $attrib)

Returns an attrib value. Get an attrib value by ArrayAccess.

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
Parámetros
string$attribThe name of the attrib to get.
Devuelve
mixed The attrib value.
offsetSet (   $attrib,
  $value 
)

Set an attrib. Sets an attrib using ArrayAccess.

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
string$attribThe name of the attrib to set.
mixed$attribThe value for the attrib.
Devuelve
DOM_element $this este elemento (DOM).
offsetUnset (   $attrib)

Unset an attrib. Unsets an attrib using ArrayAccess.

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
string$attribThe name of the option to unset.
reinicializar ( )
abstract

Pone a cero los elementos de arrays de este Objeto.

Devuelve
DOM_element $this este elemento (DOM).
removeAttrib (   $attrib)

Suprime o elimina el atributo indicado (si es que existe). Retorna <del>el numero de atributos que quedan.</del> $this

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
string$attribThe name of the attrib to remove.
Devuelve
DOM_element $this este elemento (DOM).
removeAttribs (   $arrayAttribs)

Suprime o elimina todos los atributos indicados (si es que existen). Retorna <del>el numero de atributos que quedan.</del> $this

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
arraystring $arrayAttribs Array with the attribs's name to remove.
Devuelve
DOM_element $this este elemento (DOM).
setAttribs (   $asocArrayAttribs)

El parametro sera un array asociativo de atributos con pares correctos 'clave=valor'.

El programador debe asegurarse que son nombres estandarizados para los atributos de elementos DOM.(W3C)

TODO: FILTRADO: <del>Solo se admitiran nombres estandarizados para los atributos de elementos DOM.(W3C)</del>

Excepciones
DOMBasicAttribNotFoundExceptionIf $attrib is not a key in the $_attribs array.
DOMBasicValueExceptionIf the value for a attrib is out of range.
Parámetros
array$asocArrayAttribsThe array of the attribs to set.
Devuelve
DOM_element $this este elemento (DOM).
setReadOnly (   $readOnly)
abstract

Establece si los atributos de este elemento son DE SOLO LECTURA O ESCRIBIBLES.

Parámetros
boolean
Devuelve
DOM_element $this este elemento (DOM).
toJSON (   $return = true,
  $base64values = true 
)

Metodo para retornar la cadena JSON que representa estos atributos en la forma '{"clave1":"valor1", "clave2":"valor2"}'.

Aporta un segundo parametro para codificar todos los valores (no las claves) en 'base64', (DEFECTO=true), asi podriamos evitar el problema de los tipos de codificacion empleados (JSON solo admite UTF-8).

NO UTILIZA LA FUNCION PHP 'json_encode(..)'

<del>Utiliza las siguientes constantes PHP 5.3: JSON_HEX_QUOT && JSON_HEX_TAG && JSON_HEX_AMP && JSON_HEX_APOS</del>

Parámetros
boolean$returnIndica si retornar el resultado (TRUE) o imprimirlo (FALSE).
boolean$base64valuesIndica si codificar los textos en 'base64' o no.
Devuelve
String JSON de estos atributos o NULL en caso de desear imprimirlo.
toURL (   $encode = self::ENCODE_RFC_3986)
protected

Retorna una cadena con el formato de las URL's, construida con los Atributos de este Objeto.
Contiene un parametro $encode indicando el tipo de codificacion a aplicar: 'RFC_1738' (espacios=+) o 'RFC_3986' (espacions=%20), las cuales estan implementadas como cadenas staticas de esta clase.

Parámetros
$encodeCadena indicando el tipo de codificacion (alguna de las dos constantes de esta clase RFC_1738 o RFC_3986).
Devuelve
Cadena con formato de codificacion URL.
tryingWrite (   $arg = "")
protected

Notifica una accion de escritura al objeto. Si es de solo-lectura lanzara una Excepcion.

Devuelve
boolean TRUE=OK, FALSE=throw DOMBasicAttribReadOnlyException()
Excepciones
DOMBasicAttribReadOnlyException;

Documentación de los campos

$AVISO_GET =false
protected

¿ Lanzar Aviso cuando se lee un atributo que no existe ?


La documentación para esta clase fue generada a partir del siguiente fichero: