archived-doc-es/reference/bbcode/functions/bbcode-create.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ab195aca866f9568aa625dcb9ce5ee3500d22f4d Maintainer: tatai Status: ready -->
<refentry xml:id="function.bbcode-create" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bbcode_create</refname>
  <refpurpose>Crea un resource de BBCode</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>bbcode_create</methodname>
   <methodparam choice="opt"><type>array</type><parameter>bbcode_initial_tags</parameter></methodparam>
  </methodsynopsis>

  <para>
   Esta función retorna un nuevo resource de BBCode usado para analizar
   strings BBCode.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>bbcode_initial_tags</parameter></term>
     <listitem>
      <para>
       Un array asociativo que contiene el nombre de la etiqueta como clave y
       los parámetros requeridos para analizar correctamente el BBCode por su
       valor. Se soportan los siguientes pares clave/valor:
        <itemizedlist>
         <listitem>
          <simpara>
           <varname remap="structfield">flags</varname> opcional - un set de
           flags basado en las constantes BBCODE_FLAGS_*.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">type</varname> requerido - un int
           indicando el tipo de etiqueta. Usar las constantes BBCODE_TYPE_*.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">open_tag</varname> requerido - el
           string HTML usado para reemplazar a la etiqueta de apertura.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">close_tag</varname> requerido - el
           string HTML usado para reemplazar a la etiqueta de cierre.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">default_arg</varname> opcional - usar
           este valor como el argumento por defecto si no se indica uno y
           tag_type es de tipo OPTARG.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">content_handling</varname> opcional -
           proporciona la llamada de retorno usada para modificar el
           contenido. Object Oriented Notation soportado únicamente desde
           0.10.1
           El prototipo para la llamada de retorno es:
           string nombre(string $contenido, string $argumento)
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">param_handling</varname> opcional - 
           proporciona la llamada de retorno usada para la modificación del
           argumento. Object Oriented Notation soportado únicamente desde
           0.10.1
           El prototipo para la llamada de retorno es:
           string nombre(string $contenido, string $argumento)
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">childs</varname> opcional - lista de
           hijos aceptados para la etiqueta. El formato de la lista es un
           string de valores separados por comas. Si la lista comienza con !
           entonces es la lista de hijos no permitidos para la etiqueta.
          </simpara>
         </listitem>
         <listitem>
          <simpara>
           <varname remap="structfield">parent</varname> opcional - lista de
           padres aceptados para la etiqueta. El formato de la lista es un
           string de valores separados por comas.
          </simpara>
         </listitem>
        </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna un resource BBCode_Container
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>bbcode_create</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$arrayBBCode = array(
    ''=>         array('type'=>BBCODE_TYPE_ROOT,  'childs'=>'!i'),
    'i'=>        array('type'=>BBCODE_TYPE_NOARG, 'open_tag'=>'<i>',
                    'close_tag'=>'</i>', 'childs'=>'b'),
    'url'=>      array('type'=>BBCODE_TYPE_OPTARG,
                    'open_tag'=>'<a href="{PARAM}">', 'close_tag'=>'</a>',
                    'default_arg'=>'{CONTENT}',
                    'childs'=>'b,i'),
    'img'=>      array('type'=>BBCODE_TYPE_NOARG,
                    'open_tag'=>'<img src="', 'close_tag'=>'" />',
                    'childs'=>''),
    'b'=>        array('type'=>BBCODE_TYPE_NOARG, 'open_tag'=>'<b>',
                    'close_tag'=>'</b>'),
);
$texto = <<<EOF
[b]Texto en negrita[/b]
[i]Texto en cursiva[/i]
[url]http://www.php.net/[/url]
[url=http://pecl.php.net/][b]Contenido[/b][/url]
[img]http://static.php.net/www.php.net/images/php.gif[/img]
[url=http://www.php.net/]
[img]http://static.php.net/www.php.net/images/php.gif[/img]
[/url]
EOF;
$BBHandler=bbcode_create($arrayBBCode);
echo bbcode_parse($BBHandler, $texto);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<b>Texto en negrita</b>
[i]Texto en cursiva[/i]
<a href="http://www.php.net/">http://www.php.net/</a>
<a href="http://pecl.php.net/"><b>Content Text</b></a>
<img src="http://static.php.net/www.php.net/images/php.gif" />
<a href="http://www.php.net/">
[img]http://static.php.net/www.php.net/images/php.gif[/img]
</a>
]]>
    </screen>
   </example>
  </para>
 </refsect1>

</refentry>

<!-- 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:"~/.phpdoc/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
-->