spanish docs initial commit

This commit is contained in:
mohrt
2004-10-07 18:50:52 +00:00
parent 56ed915a8b
commit 8c29cc08f0
175 changed files with 15689 additions and 0 deletions

View File

@@ -0,0 +1,117 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="advanced.features.objects">
<title>Objetos</title>
<para>
El Smarty permite acceso a objetos de PHP a trav<61>s de sus templates.
Hay dos formas de accesarlos. Una forma es registrando objetos para el
template, entonces acceselos mediante sintaxis similar a las funciones
habituales. La otra es asignar objetos al template y accesarlos como si
fueran una variable asignada. El primer m<>todo tiene una sintaxis de
template mucho mas agradable. Y tambi<62>n mas segura, a medida que un
objeto registrado puede ser reescrito a ciertos m<>todos y propiedades.
Sin embargo tanto, un objeto registrado no puede ser puesto en loop o
ser asignado en arreglos de objetos, etc. El m<>todo que usted escoja
sera determinado por sus necesidades, pero utilice el primero m<>todo si
es posible para mantener un minimo de sintaxis en el template.
</para>
<para>
Si la seguridad esta habilitada, ninguno de los dos m<>todos privados o
funciones pueden ser accesados (comenzando con "_"). Si un metodo y
propiedades de un mismo nombre existe, el m<>todo ser<65> usado.
</para>
<para>
Usted puede restringir los m<>todos y propiedades que pueden ser accesados
listandolos en un arreglo como el tercer par<61>metro de registro.
</para>
<para>
Por default, los par<61>metros pasados a los objetos a a trav<61>s de los
templates son pasados de la misma forma en que las funciones de
costumbre los obtienen. Un arreglo asociativo es pasado como el primer
par<61>metro, y el objeto smarty como el segundo. Si usted quiere que los
par<61>metros pasados uno de cada vez por cada argumento pasen como
par<61>metros de un objeto tradicional, defina el cuarto par<61>metro de
registro en falso.
</para>
<para>
El quinto par<61>metro opcional solo tiene efecto con
<parameter>format</parameter> siendo <literal>true</literal>
y conteniendo una lista de m<>todos de ob que seran tratados
como bloques. Esto significa que estos m<>todos tienen una
etiqueta de cierre en el template
(<literal>{foobar->meth2}...{/foobar->meth2}</literal>) y
los par<61>metros para los m<>todos tienen la misma sinopsis como
los par<61>metros de block-function-plugins: Ellos reciben 4
par<61>metros <parameter>$params</parameter>,
<parameter>$content</parameter>,<parameter>&amp;$smarty</parameter>
y <parameter>&amp;$repeat</parameter> tambi<62>n se comportan como
block-function-plugins.
</para>
<example>
<title>usando un objeto registrado o atribuido</title>
<programlisting role="php">
<![CDATA[
<?php
// El objeto
class My_Object {
function meth1($params, &$smarty_obj) {
return "this is my meth1";
}
}
$myobj = new My_Object;
// registrando el objeto (ser<65> por referencia)
$smarty->register_object("foobar",$myobj);
// Si usted quiere restringir acceso a ciertos metodos o propriedades,
// listelos
$smarty->register_object("foobar",$myobj,array('meth1','meth2','prop1'));
// Si usted quiere usar el formato de par&aacute;metro del objeto tradicional,
// pase un booleano en false
$smarty->register_object("foobar",$myobj,null,false);
// tambi&eacute;n puede asignar ojetos. Posible cuando se asignan por
// referencia.
$smarty->assign_by_ref("myobj", $myobj);
$smarty->display("index.tpl");
?>
TEMPLATE:
{* accesando a nuestro objeto registrado *}
{foobar->meth1 p1="foo" p2=$bar}
{* usted tambi<62>n puede asignar la salida *}
{foobar->meth1 p1="foo" p2=$bar assign="output"}
the output was {$output}
{* accesando a nuestro objeto asignado *}
{$myobj->meth1("foo",$bar)}
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -0,0 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="advanced.features.outputfilters">
<title>Filtros de salida</title>
<para>
Cuando el template es invocado a trav<61>s de display() o fetch(),
su salida puede ser enviada a trav<61>s de uno o mas filtros de salida.
Este es diferente a los postfilters porque los postfilters operan en
los templates compilados antes de ser salvados en disco, y los filtros
de salida operan en la salida del template cuando este es ejecutado.
</para>
<para>
Los Filtros de Salida pueden ser
<link linkend="api.register.outputfilter">registrado</link> o
cargados del directorio de plugins usando la funci<63>n
<link linkend="api.load.filter">load_filter()</link> o
configurando a variable
<link linkend="variable.autoload.filters">$autoload_filters</link>.
El Smarty pasara la salida como el primer argumento, y espera
que la funci<63>n retorne el resultado del procesamiento.
</para>
<example>
<title>Usando un filtro de salida de template</title>
<programlisting role="php">
<![CDATA[
<?php
// ponga esto en su aplicaci<63>n
function protect_email($tpl_output, &$smarty)
{
$tpl_output =
preg_replace('!(\S+)@([a-zA-Z0-9\.\-]+\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',
'$1%40$2', $tpl_output);
return $tpl_output;
}
// registra el outputfilter
$smarty->register_outputfilter("protect_email");
$smarty->display("index.tpl");
// Ahora cualquier ocurrencia de una direcci&oacute;n de email en la salida
// del template tendra una simple protecci&oacute;n contra spambots
?>
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -0,0 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="advanced.features.postfilters">
<title>Postfilters</title>
<para>
Los postfilters de template son funciones de PHP con las cuales sus
templates son corridos inmediatamente despu<70>s de ser compilados.
Los postfilters pueden ser <link linkend="api.register.postfilter">
registrado</link> o cargados del directorio de plugins usando la funci<63>n
<link linkend="api.load.filter">load_filter()</link> o por la variable
de configuraci<63>n
<link linkend="variable.autoload.filters">$autoload_filters</link>.
El Smarty pasara el c<>digo fuente del template
compilado como el primer argumento, y espera que la funci<63>n retorne el
resultado del procesamiento.
</para>
<example>
<title>Usando un postfilter de template</title>
<programlisting role="php">
<![CDATA[
<?php
// ponga esto en su aplicaci&oacute;n
function add_header_comment($tpl_source, &$smarty)
{
return "<?php echo \"<!-- Created by Smarty! -->;\n\" ?>;\n".$tpl_source;
}
// registra el postfilter
$smarty->register_postfilter("add_header_comment");
$smarty->display("index.tpl");
?>
{* compiled Smarty template index.tpl *}
<!-- Created by Smarty! -->
{* rest of template content... *}
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -0,0 +1,61 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="advanced.features.prefilters">
<title>Prefilters</title>
<para>
Los prefilters de Template son funciones de PHP que corren sus
templates antes de ser compilados. Esto es bueno para procesar
por adelantado sus templates y remover comentarios no deseados,
vigilando a las personas que coloquen en sus templates, etc.
Los Prefilters pueden ser
<link linkend="api.register.prefilter">registrado</link>
o cargado del directorio de plugins usando la funci<63>n
<link linkend="api.load.filter">load_filter()</link> o por la
configuraci<63>n de la variable
<link linkend="variable.autoload.filters">$autoload_filters</link>.
El Smarty pasara el c<>digo fuente del template como el primer argumento,
y espera que la funci<63>n le retorne el c<>digo fuente del template
resultante.
</para>
<example>
<title>usando un prefiltro prefilter de template</title>
<programlisting role="php">
<![CDATA[
<?php
// ponga esto en su aplicaci<63>n
function remove_dw_comments($tpl_source, &$smarty)
{
return preg_replace("/<!--#.*-->/U","",$tpl_source);
}
// registrar el prefilter
$smarty->register_prefilter("remove_dw_comments");
$smarty->display("index.tpl");
?>
{* Smarty template index.tpl *}
<!--# esta linea ser<65> eliminada por el prefilter -->
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -0,0 +1,158 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="section.template.cache.handler.func">
<title>Funci<EFBFBD>n manipuladora de cache</title>
<para>
Como una alternativa al uso del mecanismo de caching por default
basado en archivo, usted puede especificar una funci<63>n habitual
de manipulaci<63>n de cache que ser<65> usada para leer, escribir y
limpar archivos de cache.
</para>
<para>
Cree una funci<63>n en su aplicaci<63>n para que Smarty la use como un
manipulador de cache. Defina el nombre de la variable de clase en el
<link linkend="variable.cache.handler.func">$cache_handler_func</link>.
El Smarty ahora usara esta para manipular datos en el cache. El primer
par<61>metro es la acci<63>n, que puede ser uno de estos 'read', 'write' y
'clear'. El segundo par<61>metro es el objeto de Smarty. El tercer par<61>metro
es el contenido que esta en el cache. Sobre 'write', el Smarty pasa el
contenido en cache en estos par<61>metros. sobre 'read', el Smarty espera
que su funci<63>n acepte este par<61>metro por referencia y poblar estos con los
datos en cache. Sobre 'clear', el Smarty pasa una variable en cero desde
aqu<71> que esta no es usada. El cuarto par<61>metro es el nombre del archivo de
template(necesario para leer/escribir). El quinto par<61>metro es la cache_id
(opcional). El sexto par<61>metro es la compile_id (opcional).
</para>
<para>
NOTA: El ultimo par<61>metro ($exp_time) fue adicionado en el Smarty-2.6.0.
</para>
<example>
<title> ejemplo usando MySQL como una fuente de cache</title>
<programlisting role="php">
<![CDATA[
<?php
/*
ejemplo de uso:
include('Smarty.class.php');
include('mysql_cache_handler.php');
$smarty = new Smarty;
$smarty->cache_handler_func = 'mysql_cache_handler';
$smarty->display('index.tpl');
mysql database is expected in this format:
create database SMARTY_CACHE;
create table CACHE_PAGES(
CacheID char(32) PRIMARY KEY,
CacheContents MEDIUMTEXT NOT NULL
);
*/
function mysql_cache_handler($action, &$smarty_obj, &$cache_content, $tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null)
{
// set db host, user and pass here
$db_host = 'localhost';
$db_user = 'myuser';
$db_pass = 'mypass';
$db_name = 'SMARTY_CACHE';
$use_gzip = false;
// create unique cache id
$CacheID = md5($tpl_file.$cache_id.$compile_id);
if(! $link = mysql_pconnect($db_host, $db_user, $db_pass)) {
$smarty_obj->_trigger_error_msg("cache_handler: could not connect to database");
return false;
}
mysql_select_db($db_name);
switch ($action) {
case 'read':
// read cache from database
$results = mysql_query("select CacheContents from CACHE_PAGES where CacheID='$CacheID'");
if(!$results) {
$smarty_obj->_trigger_error_msg("cache_handler: query failed.");
}
$row = mysql_fetch_array($results,MYSQL_ASSOC);
if($use_gzip && function_exists("gzuncompress")) {
$cache_contents = gzuncompress($row["CacheContents"]);
} else {
$cache_contents = $row["CacheContents"];
}
$return = $results;
break;
case 'write':
// save cache to database
if($use_gzip && function_exists("gzcompress")) {
// compress the contents for storage efficiency
$contents = gzcompress($cache_content);
} else {
$contents = $cache_content;
}
$results = mysql_query("replace into CACHE_PAGES values(
'$CacheID',
'".addslashes($contents)."')
");
if(!$results) {
$smarty_obj->_trigger_error_msg("cache_handler: query failed.");
}
$return = $results;
break;
case 'clear':
// clear cache info
if(empty($cache_id) && empty($compile_id) && empty($tpl_file)) {
// clear them all
$results = mysql_query("delete from CACHE_PAGES");
} else {
$results = mysql_query("delete from CACHE_PAGES where CacheID='$CacheID'");
}
if(!$results) {
$smarty_obj->_trigger_error_msg("cache_handler: query failed.");
}
$return = $results;
break;
default:
// error, unknown action
$smarty_obj->_trigger_error_msg("cache_handler: unknown action \"$action\"");
$return = false;
break;
}
mysql_close($link);
return $return;
}
?>
]]>
</programlisting>
</example>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -0,0 +1,239 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="template.resources">
<title>Recursos</title>
<para>
Los templates pueden venir de una variedad de fuentes. Cuando usted
muestra un template con (display) o (fetch), o incluye un template
dentro de otro template, usted suministra un tipo de recurso, seguido
por la ruta correcta y el nombre del template.
Si un recurso no es dado explicitamente el valor de
<link linkend="variable.default.resource.type">$default_resource_type</link>
es asumido.
</para>
<sect2 id="templates.from.template.dir">
<title>Templates partiendo del $template_dir</title>
<para>
Los templates desde el $template_dir no requieren recursos del
template, aunque usted puede usar el file: resource for
consistancy(recurso por consistencia). Justamente proporcionando
la ruta(path) del template que usted quiere usar en relaci<63>n al
directorio root $template_dir.
</para>
<example>
<title>Usando templates partiendo del $template_dir</title>
<programlisting role="php">
<![CDATA[
<?php
// desde el script de PHP
$smarty->display("index.tpl");
$smarty->display("admin/menu.tpl");
$smarty->display("file:admin/menu.tpl"); // agual al de arriba
?>
{* dentro del template de Smarty *}
{include file="index.tpl"}
{include file="file:index.tpl"} {* igual al de arriba *}
]]>
</programlisting>
</example>
</sect2>
<sect2 id="templates.from.any.dir">
<title>Templates partiendo de cualquier directorio</title>
<para>
Los templates de fuera del $template_dir requieren el file: tipo
de recurso del template, seguido por la ruta absoluta y el nombre
del template.
</para>
<example>
<title>usando templates partiendo de cualquier directorio</title>
<programlisting role="php">
<![CDATA[
<?php
// desde el script de PHP
$smarty->display("file:/export/templates/index.tpl");
$smarty->display("file:/path/to/my/templates/menu.tpl");
?>
{* desde adentro del template Smarty *}
{include file="file:/usr/local/share/templates/navigation.tpl"}
]]>
</programlisting>
</example>
<sect3 id="templates.windows.filepath">
<title>Rutas de archivos de Windows</title>
<para>
Si usted esta utilizando una maquina con windows, las rutas de
los archivos normalmente incluyen la letra del drive (C:) en el
comienzo del nombre de la ruta. Asegurarse de usar "file:" en la
ruta para evitar conflictos de nombres y poder obtener los
resultados desados.
</para>
<example>
<title>usando templates con rutas de archivos de windows</title>
<programlisting role="php">
<![CDATA[
<?php
// dentro del script de PHP
$smarty->display("file:C:/export/templates/index.tpl");
$smarty->display("file:F:/path/to/my/templates/menu.tpl");
?>
{* dentro del template de Smarty *}
{include file="file:D:/usr/local/share/templates/navigation.tpl"}
]]>
</programlisting>
</example>
</sect3>
</sect2>
<sect2 id="templates.from.elsewhere">
<title>Templates partiendo de otras fuentes</title>
<para>
Se pueden retomar templates usando cualquier fuente posible a la
que usted pueda acceder con PHP: base de datos, sockets, LDAP, etc.
Usted puede hacer esto escribiendo las funciones de plugin de recurso
y registrandolas con Smarty.
</para>
<para>
Vea la secci<63>n <link linkend="plugins.resources">resource plugins</link>
para mayor informacion sobre las funciones que puede utilizar.
</para>
<note>
<para>
Nota Usted puede activar manualmente el recurso <literal>file</literal>
incrustado, pero no puede suministrar un recurso que busca templates a
partir del sistema de archivos de alguna otra forma registrando bajo
otro nombre de recurso.
</para>
</note>
<example>
<title>Usando recursos habituales</title>
<programlisting role="php">
<![CDATA[
<?php
// ponga estas funciones en algun lugar de su aplicaci<63>n
function db_get_template ($tpl_name, &$tpl_source, &$smarty_obj)
{
// ejecutar la base de datos madar llamar aqu<71> su template,
// poblando el $tpl_source
$sql = new SQL;
$sql->query("select tpl_source
from my_table
where tpl_name='$tpl_name'");
if ($sql->num_rows) {
$tpl_source = $sql->record['tpl_source'];
return true;
} else {
return false;
}
}
function db_get_timestamp($tpl_name, &$tpl_timestamp, &$smarty_obj)
{
// ejecutar la base de datos llamar aqu<71> para poblar
// $tpl_timestamp.
$sql = new SQL;
$sql->query("select tpl_timestamp
from my_table
where tpl_name='$tpl_name'");
if ($sql->num_rows) {
$tpl_timestamp = $sql->record['tpl_timestamp'];
return true;
} else {
return false;
}
}
function db_get_secure($tpl_name, &$smarty_obj)
{
// asume que todos los templates son seguros
return true;
}
function db_get_trusted($tpl_name, &$smarty_obj)
{
// no usar para templates
}
// registrar el nombre del recurso "db"
$smarty->register_resource("db", array("db_get_template",
"db_get_timestamp",
"db_get_secure",
"db_get_trusted"));
// usando el recurso a partir del script PHP
$smarty->display("db:index.tpl");
?>
{* usando el recurso dentro del template de Smarty *}
{include file="db:/extras/navigation.tpl"}
]]>
</programlisting>
</example>
</sect2>
<sect2 id="default.template.handler.function">
<title>Funci<EFBFBD>n manipuladora de Template por default</title>
<para>
Usted puede especificar la funci<63>n que ser<65> usada para devolver
el contenido del template dentro del evento del template no puede
ser retomado desde su recurso. Un uso distinto es para crear
templates que no existen "on-the-fly" (templates cuyo contenido
cambia mucho, bastante variable).
</para>
<example>
<title> usando la funci<63>n manipuladora de template por default</title>
<programlisting role="php">
<![CDATA[
<?php
// ponga esta funci&oacute;n en algun lugar de su aplicaci&oacute;n
function make_template ($resource_type, $resource_name, &$template_source, &$template_timestamp, &$smarty_obj)
{
if( $resource_type == 'file' ) {
if ( ! is_readable ( $resource_name )) {
// create the template file, return contents.
$template_source = "This is a new template.";
$template_timestamp = time();
$smarty_obj->_write_file($resource_name,$template_source);
return true;
}
} else {
// not a file
return false;
}
}
// defina la funci&oacute;n manipuladora por default
$smarty->default_template_handler_func = 'make_template';
?>
]]>
</programlisting>
</example>
</sect2>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->