![]() |
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 | |
setKey (string $key=null) | |
getKey () | |
getTag () | |
getOpenTag () | |
getCloseTag () | |
getType () | |
getDesc () | |
addChild (DOM_element $child=null) | |
addChildren (array $children=null) | |
setChildren (array $children=null) | |
getChildren () | |
getChildrenAll () | |
getChildByKey ($key, $grandchildren=true) | |
getChildrenByTag ($tag, $grandchildren=true) | |
getChildrenByType ($type, $grandchildren=true) | |
removeChild ($child, $grandchildren=true) | |
removeChildrenAll () | |
removeChildByKey ($key, $grandchildren=true) | |
removeChildrenByTag ($tag, $grandchildren=true) | |
removeChildrenByType ($type, $grandchildren=true) | |
equalsType ($objDOM) | |
toHTML () | |
toJSON ($return=true, $base64values=true) | |
fromJSON ($json) | |
getConfiguration () | |
setConfiguration (array $conf) | |
importConfINI ($confFile=null) | |
Interfaz para los elementos del DOM. Admite CONCATENACION DE METODOS mediante el retorno de la construccion '$this' en todos los metodos 'NO-GETTER'
addChild | ( | DOM_element | $child = null | ) |
Metodo para agregar un hijo al elemento DOM.
$child | Elemento DOM. |
Implementado en DOM_element.
addChildren | ( | array | $children = null | ) |
Metodo para agregar un array de hijos de elementos DOM, al ya existente.
$child | Elemento DOM. |
Implementado en DOM_element.
equalsType | ( | $objDOM | ) |
Compara si otro objeto es del mismo TIPO que este (no si es el mismo)
DOM_element | $objDOM | Algun objeto instancia de esta Clase |
Implementado en DOM_element.
fromJSON | ( | $json | ) |
Metodo para reconstruir este objeto a la imagen y semejanza de la cadena JSON entregada que deberia representar otro DOM_element con hijos, atributos, y caracteristicas propias.
Detecta AUTOMATICAMENTE si el objeto se codifico con 'base64'.
UTILIZA LA FUNCION PHP 'json_decode()' con parametros por defecto.
string | $json | La cadena json que representa un objeto DOM_element. Esta cadena se construye con la funcion contraria toJSON(). |
Implementado en DOM_element.
getChildByKey | ( | $key, | |
$grandchildren = true |
|||
) |
Metodo para buscar y retornar un hijo del elemento que contenga la misma clave que la pasada por parametro, este metodo es recursivo pero retorna el primer elemento que concuerde su clave, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: USE RECURSIVE FUNCTION!!
string | $key | La clave del elemento a buscar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
getChildren | ( | ) |
Metodo para retornar el array de todos los hijos del elemento DOM. Similar a DOM_Interface::getChildrenAll()
Implementado en DOM_element.
getChildrenAll | ( | ) |
Metodo para retornar un array con todos los hijos de forma recursiva (nietos, bisnietos, ...) del elemento DOM. Similar a DOM_Interface::getChildren()
Implementado en DOM_element.
getChildrenByTag | ( | $tag, | |
$grandchildren = true |
|||
) |
Metodo para buscar y retornar un array de hijos del elemento que contengan la misma etiqueta (TAG) que la pasada por parametro, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: RECURSIVE FUNCTION!!
string | $tag | La etiqueta (TAG) del elemento a buscar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
getChildrenByType | ( | $type, | |
$grandchildren = true |
|||
) |
Metodo para buscar y retornar un array de hijos del elemento que sean del mismo tipo (TYPE) que el pasado por parametro, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: RECURSIVE FUNCTION!!
string | $type | El tipo (TYPE) del elemento a buscar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
getCloseTag | ( | ) |
Metodo para leer la etiqueta HTML de cierre construida para este elemento, con sus atributos incluidos.
NOTE: Existen elementos que deben establecer la suya propia, como los elementos autocontendios (<img />, </br >, ...) o elementos sin etiqueta como 'textNode'.
Implementado en DOM_element.
getConfiguration | ( | ) |
getDesc | ( | ) |
Metodo para leer la descripcion DOM de este elemento.
Implementado en DOM_element.
getKey | ( | ) |
Metodo para tomar la clave del elemento.
Implementado en DOM_element.
getOpenTag | ( | ) |
Metodo para leer la etiqueta HTML de apertura construida para este elemento, con sus atributos incluidos.
Implementado en DOM_element y DOM_textNode.
getTag | ( | ) |
Metodo para leer la etiqueta DOM de este elemento.
Implementado en DOM_element.
getType | ( | ) |
Metodo para leer el tipo DOM de este elemento.
Implementado en DOM_element.
importConfINI | ( | $confFile = null | ) |
Importar las configuraciones desde el archivo config.ini, Utiliza la seccion del INI [CONF_SEC].
Si no se entrega parametro de ruta se utilizara el archivo de configuracion por defecto ('config.ini') en la ruta del pakete.
Debe contener como minimo las siguientes secciones: [PK_SEC] : Seccion para identificacion del pakete. [CONSTS_SEC] : Seccion para las constantes de la clase (PATH_CLASS_DOM, CONF_INI_FILE_DOM, ...) [CONF_SEC] : Seccion para las variables de configuracion (TAG, _text,...)
string | $confFile | (OPCIONAL, DEFAULT=NULL) La ruta completa al archivo de configuracion INI a cargar. |
Implementado en DOM_element.
removeChild | ( | $child, | |
$grandchildren = true |
|||
) |
Metodo para eliminar el hijo del elemento que sea el mismo ('equalsExact') que el pasado por parametro, Retorna el numero de elementos eliminados, Este metodo puede ser recursivo, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: USE RECURSIVE FUNCTION!!
DOM_element | $child | El objeto hijo a eliminar. |
boolean | $grandchildren | TRUE(DEFAULT)=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
removeChildByKey | ( | $key, | |
$grandchildren = true |
|||
) |
Metodo para eliminar el hijo del elemento que contengan la misma clave que la pasada por parametro, Este metodo es recursivo, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: USE RECURSIVE FUNCTION!!
string | $key | La clave del elemento a eliminar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
removeChildrenAll | ( | ) |
Elimina todos sus hijos (ELIMINA EL CONTENIDO ENTERO DE ESTE ELEMENTO).
Implementado en DOM_element.
removeChildrenByTag | ( | $tag, | |
$grandchildren = true |
|||
) |
Metodo para eliminar los hijos del elemento que contengan la misma etiqueta (TAG) que la pasada por parametro, Retorna el numero de elementos eliminados, Este metodo es recursivo, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: USE RECURSIVE FUNCTION!!
string | $tag | La etiqueta (TAG) del elemento a eliminar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
removeChildrenByType | ( | $type, | |
$grandchildren = true |
|||
) |
Metodo para eliminar los hijos del elemento que sean del mismo tipo (Type) que el pasado por parametro, Retorna el numero de elementos eliminados, Este metodo es recursivo, el segundo parametro (por defecto TRUE) indica si comprobar recursivamente en nietos...
CAUTION!: USE RECURSIVE FUNCTION!!
string | $tag | La etiqueta (TAG) del elemento a eliminar. |
boolean | $grandchildren | TRUE=elimina recursivamente, FALSE=solo mira en los hijos directos. |
Implementado en DOM_element.
setChildren | ( | array | $children = null | ) |
Metodo para establecer los hijos al elemento DOM. Estos hijos a su vez deben ser elementos DOM.
$children | Array Elementos del DOM. |
Implementado en DOM_element.
setConfiguration | ( | array | $conf | ) |
Grabar la configuracion de este elemento
array | $conf | Array asociativo de variables de configuracion en formato 'clave=valor' |
Implementado en DOM_element.
setKey | ( | string | $key = null | ) |
Metodo para establecer la clave de este elemento DOM.
$key | string clave del elemento. |
Implementado en DOM_element.
toHTML | ( | ) |
Metodo para retornar la cadena que representa el HTML de este elemento DOM con sus atributos, y los de sus hijos, correspondientes.
Implementado en DOM_element.
toJSON | ( | $return = true , |
|
$base64values = true |
|||
) |
Metodo para retornar la cadena JSON que representa este elemento DOM con sus hijos y con sus atributos, y los de sus hijos, correspondientes.
RECOMENDADO: 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>
boolean | $return | Indica si retornar el resultado (TRUE) o imprimirlo (FALSE). |
boolean | $base64values | Indica si codificar los textos en 'base64' o no. |
Implementado en DOM_element.