phpkrond
[ class tree: phpkrond ] [ index: phpkrond ] [ all elements ]

Class: krond_plantilla

Source Location: Program_Root/mainfunctions.php

Class Overview


Clase que controla las plantillas del Sistema.


Author(s):

  • Francisco José Sánchez Sánchez

Version:

  • 200

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 614]
Clase que controla las plantillas del Sistema.

Las plantillas del sistema son módelos de páginas con etiquetas del tipo {nombreEtiqueta} que son variables de sustitución. La información de las plantillas se encuentra en la tabla 'krond_plantillas'.




Tags:

version:  200
author:  Francisco José Sánchez Sánchez


[ Top ]


Class Variables

$db =

[line 634]

Contiene la conexion de la base de datos.

Este atributo es del tipo newADOconnection que pertenece a ADODB. Automaticamente es inicializado recogiendolo de la objeto $GLOBALS['KROND_CFG']. Este objeto tiene un atributo, $db, que inicializa la conexion con la base de datos.



Type:   mixed


[ Top ]

$idPlantilla =

[line 623]

Atributo de la clase que guarda la clave de la plantilla.

El atributo de la clase $idPlantilla es el identificador utilizado como clave primaria en la tabla 'krond_plantillas'.



Type:   mixed


[ Top ]



Class Methods


constructor krond_plantilla [line 644]

krond_plantilla krond_plantilla( [integer $idPlantilla = ""])

Contructor de la clase que inicializa el atricuto $idPlantilla.

El atributo $idPlantilla es la clave primaria para recuperar la información de la plantilla en la tabla 'krond_plantillas'.




Parameters:

integer   $idPlantilla   Identificador de plantilla.

[ Top ]

method add_llaves [line 1174]

String add_llaves( $cadena $cadena)

Sustituye las entidades HTML '{', '}' por su correspondiente carácter.

Esta función es útil cuando se ha editado una plantilla y se quieren deshacer los cambios de {} para que aparezcan de nuevo en el contenido de la plantilla. Hace lo contrario que la función strip_llaves.




Tags:

return:  String con el texto en donde se ha realizado la sustitución.


Parameters:

$cadena   $cadena   Texto sobre el que se realiza la sustitución.

[ Top ]

method borrar [line 859]

Boolean borrar( )

Borra la plantilla del Sistema.

Si la plantilla no tiene dependencias, es decir, la plantilla no esta siendo utilizada por otras páginas, entonces se se puede borrar sin problemas. Elimina las variables de la plantilla que estan en la la tabla 'krond_variables' y la entrada en la tabla 'krond_plantillas'.




Tags:

return:  La plantilla se borró del sistema.


[ Top ]

method buscar_variables [line 1131]

Array buscar_variables( $contenido $contenido)

Devuelve las variables de plantilla que contiene la cadena $contenido.

Las variables de plantilla son cadenas de la forma {nombreVariable}. Las expresión regular que busca estas variables es "[{][a-zA-Z_0-9 ]+[}]". Esta función es util para inicializar las variables de plantilla cuando se crea una nueva plantilla.




Tags:

return:  Array con los nombres de las variables.


Parameters:

$contenido   $contenido   String con el contenido de la plantilla.

[ Top ]

method caja_evalua [line 798]

String caja_evalua( $tipoCaja $tipoCaja, $contenido $contenido)

Devuelve un texto enmarcado con el tipo de caja seleccionado de la plantilla

El texto se enmarca según el tipo de caja que se pasa por los paramteros de la función y sustituye a la variable {cuerpo} del contenido de la caja por el texto enviado.




Tags:

return:  Contenido del enmarcado para la caja.


Parameters:

$tipoCaja   $tipoCaja   Constante para seleccionar el tipo de caja de la plantilla. Las constantes son 'CAJA_VACIA', 'CAJA_TIPO1', 'CAJA_TIPO2', 'CAJA_TIPO3'.
$contenido   $contenido   String con el contenido a enmarcar.

[ Top ]

method check_caja [line 1114]

Boolean check_caja( $caja $caja)

Checkea el contenido de la caja de la plantilla.

Comprueba que el contenido de la caja de la plantilla contiene la variable de sustitución {cuerpo}




Tags:

return:  Devuelve true si contiene la variable {cuerpo}.


Parameters:

$caja   $caja   String con el contenido de la caja.

[ Top ]

method check_contenido [line 1096]

Boolean check_contenido( $contenido $contenido)

Checkea el contenido de la plantilla.

Comprueba la validez del contenido de la plantilla. Deberia verificar que el contneido contiene variables de sustitución del tipo {nombreVariable}.




Tags:

return:  Devuelve true si el contenido tiene al menos una variable.


Parameters:

$contenido   $contenido   String con el contenido de la plantilla.

[ Top ]

method check_dependencias [line 1076]

Boolean check_dependencias( )

Checkea las dependencias de una plantilla.

Comprueba si la plantilla tiene páginas que la usan. Una plantilla no se puede borrar siempre que tenga dependencias de uso de páginas.




Tags:

return:  Devuelve true si es usada por alguna página.


[ Top ]

method check_existe [line 1057]

Boolean check_existe( $nombre $nombre)

Checkea si existe una plantilla con el mismo nombre.

Comprueba si existe una plantilla que tenga el mismo nombre. No pueden existir plantillas con el mismo nombre.




Tags:

return:  Devuelve true si es el nombre de la plantilla existe.


Parameters:

$nombre   $nombre   String con el nombre de la plantilla.

[ Top ]

method check_nombre [line 1044]

Boolean check_nombre( mixed $nombre)

Checkea el nombre de la plantilla.

Comprueba la validez del nombre de la plantilla. Función no implementada.




Tags:

return:  Devuelve true SIEMPRE.


[ Top ]

method crear [line 893]

Boolean crear( $nombre $nombre, $contenido $contenido, $caja1 $caja1, $caja2 $caja2, $caja2 $caja3)

Crea una nueva plantilla en el sistema.

Las plantillas son modelos de páginas. Los datos de la plantilla se encuentran en dos tablas, 'krond_plantillas' y 'krond_variables'. El contenido de una plantilla contiene, además de texto html, variables del tipo {nombreVariable} que serán sustituidas por las los objetos del sistema en las sustituciones de páginas. Tambien contiene 3 módelos de cajas difierentes para enmarcar textos adecuándolos a la plantilla. Los modelos de cajas contienen en su interior la variable {cuerpo}.




Tags:

return:  La plantilla se creó con éxito.


Parameters:

$nombre   $nombre   Nombre de la plantilla a crear.
$contenido   $contenido   Contenido de la plantilla.
$caja1   $caja1   Contenido del tipo de Caja 1 de la plantilla
$caja2   $caja2   Contenido del tipo de Caja 2 de la plantilla
$caja2   $caja3   Contenido del tipo de Caja 3 de la plantilla

[ Top ]

method existe [line 837]

Boolean existe( )

Comprueba si el identificador de plantilla existe en el sistema.

La verificación se realiza consultado en la tabla 'krond_plantilla' si existe el identificador de plantilla.




Tags:

return:  Devuelve true si la plantilla existe, false en caso contrario.


[ Top ]

method get_all [line 817]

Array get_all( )

Obtiene las plantillas del sistema.

Devuelve un array de krond_plantillas con todas las plantillas del sistema.




Tags:

return:  Plantillas del Sistema.


[ Top ]

method get_caja [line 758]

String get_caja( $tipoCaja $tipoCaja)

Devuelve el contenido del tipo de caja de una plantilla.

Se consulta el campo 'tipo_caja1' o 'tipo_caja2' o 'tipo_caja13' de la tabla 'krond_plantillas'. El tipo de caja es un modelo de plantilla especial para generar Cajas de texto. En su interior contiene una variable de de sustitucion de nombre {cuerpo} que será sustituida con la funcion caja_evalua ().




Tags:

return:  Contenido del Tipo de Caja de la plantilla.


Parameters:

$tipoCaja   $tipoCaja   Constante para seleccionar el tipo de caja de la plantilla. Las constantes son 'CAJA_VACIA', 'CAJA_TIPO1', 'CAJA_TIPO2', 'CAJA_TIPO3'.

[ Top ]

method get_contenido [line 690]

String get_contenido( )

Devuelve el contenido de la plantilla.

El contenido de la plantilla se recupera de la tabla 'krond_plantillas' del campo 'texto_plantilla'. Este contenido es un módelo de página HTML que contiene etiquetas del tipo {nombrEtiqueta} que luego son utilizadas como variables para ser sustituidas por los objetos en las sustituciones de páginas.




Tags:

return:  Contenido de la plantilla.


[ Top ]

method get_id [line 657]

Integer get_id( )

Recupera el identificador de la plantilla.

El identificador de plantilla es un entero y que se utiliza como clave primaria en la base de datos.




Tags:

return:  Identificador de la plantilla.


[ Top ]

method get_nombre [line 669]

String get_nombre( )

Devuelve el nombre de la plantilla.

El nombre de la plantilla se recupera de la tabla 'krond_plantillas' del campo 'nombre_plantilla'.




Tags:

return:  Nombre de la página.


[ Top ]

method get_paginas [line 707]

Array get_paginas( )

Devuelve un array de Paginas que usan la plantilla.

Se consulta el campo 'id_pagina' de la tabla 'krond_paginas' para saber las páginas que la utilizan.




Tags:

return:  Páginas que usan la plantilla.


[ Top ]

method get_variables [line 731]

Array get_variables( )

Devuelve un array de Variables que tiene la plantilla.

Se consulta el campo 'id_variable' de la tabla 'krond_variables' para saber las variables que tiene. Las variables se han dado de alta en la tabla cuando se creo la plantilla. Las variables son cadenas de caracteres que estan en el contenido de la plantilla del tipo {nombreVariable}.




Tags:

return:  Variables que tiene la plantilla.


[ Top ]

method set [line 943]

Boolean set( $nombre $nombre, $contenido $contenido, $caja1 $caja1, $caja2 $caja2, $caja2 $caja3)

Modifica los atributos de una plantilla.

Modifica todos los atributos de la plantilla. Si se detecta que se han modificado las variables de plantilla que estan en $contenido, (aparecen nuevas variables de plantilla o se han eliminado algunas), entonces esta funcion reconstruye todas las asignaciones que puedieran tener las páginas que usen esta plantilla. Eliminando las sustituciones que corresponen a variables que han desaparecido e inicializando las sustituciones (con el objeto nulo) de las variables nuevas.




Tags:

return:  La plantilla se modificó con éxito.


Parameters:

$nombre   $nombre   Nombre de la plantilla a crear.
$contenido   $contenido   Contenido de la plantilla.
$caja1   $caja1   Contenido del tipo de Caja 1 de la plantilla
$caja2   $caja2   Contenido del tipo de Caja 2 de la plantilla
$caja2   $caja3   Contenido del tipo de Caja 3 de la plantilla

[ Top ]

method strip_llaves [line 1157]

String strip_llaves( $cadena $cadena)

Sustituye las llaves '{', '}' por su correspondiente entidad HTML.

Esta función es útil cuando se esta editando una plantilla y no se quiere que el motor de la aplicación realiza sustituciones sobre el propio código de la plantilla. Hace lo contrario que la funcion add_llaves.




Tags:

return:  String con el texto en donde se ha realizado la sustitución.


Parameters:

$cadena   $cadena   Texto sobre el que se realiza la sustitución.

[ Top ]


Documentation generated on Sun, 14 Sep 2003 01:54:45 +0200 by phpDocumentor 1.2.1