igbinary : fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-18 21:41:46 +00:00
parent af4cd8e10e
commit eaca1fa46d
4 changed files with 57 additions and 55 deletions

View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: edd5686aff3f4b2d14eec931b875ee4e0e152b27 Maintainer: leonardolara Status: ready -->
<!-- EN-Revision: 43dd38b94fbf8a9e3efc9c5bfde27c14b9e2ce9c Maintainer: leonardolara Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.igbinary-serialize">
<refnamediv>
<refname>igbinary_serialize</refname>
@@ -12,17 +12,17 @@
<type class="union"><type>string</type><type>false</type></type><methodname>igbinary_serialize</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gera uma representação armazenável de um valor.
</para>
<para>
</simpara>
<simpara>
Isso é útil para armazenar ou passar valores PHP sem
perder seu tipo e estrutura.
</para>
<para>
</simpara>
<simpara>
Para transformar a string serializada em um valor PHP novamente,
a função <function>igbinary_unserialize</function> pode ser usada.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,14 +31,14 @@
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<simpara>
O valor a ser serializado. <function>igbinary_serialize</function>
lida com todos os tipos, exceto o tipo <type>resource</type> e alguns <type>object</type>s (veja nota abaixo).
Mesmo &array;s que contenham referências a si mesmo podem ser processados por <function>igbinary_serialize</function>.
As referências circulares dentro do &array; ou &object; que está sendo serializado também serão armazenadas.
Qualquer outra referência será perdida.
</para>
<para>
</simpara>
<simpara>
Ao serializar objetos, igbinary tentará chamar as funções membro
<link linkend="object.serialize">__serialize()</link> ou
<link linkend="object.sleep">__sleep()</link> antes da serialização.
@@ -46,13 +46,13 @@
de ser serializado. Da mesma forma, quando o objeto é restaurado usando
<function>igbinary_unserialize</function>, a função membro <link linkend="object.unserialize">__unserialize()</link> ou
<link linkend="object.wakeup">__wakeup()</link> será chamada.
</para>
</simpara>
<note>
<para>
<simpara>
Membros privados de &object;s têm o nome da classe anexado ao nome do
membro; membros protegidos têm um <literal>'*'</literal> prefixando o nome do membro.
Esses valores prefixados possuem bytes nulos em ambos os lados.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -61,16 +61,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Retorna uma string contendo uma representação de fluxo de bytes de
<parameter>value</parameter> que pode ser armazenada em qualquer lugar.
</para>
<para>
</simpara>
<simpara>
Observe que esta é uma string binária que pode incluir qualquer valor de byte e precisa
ser armazenada e tratada como tal. Por exemplo,
a saída de <function>igbinary_serialize</function> geralmente deve ser armazenada em um campo <literal>BLOB</literal>
em um banco de dados, em vez de um campo <literal>CHAR</literal> ou <literal>TEXT</literal>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -102,18 +102,18 @@ array (
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
Observe que muitos objetos integrados no PHP não podem ser serializados. No entanto, aqueles com
essa habilidade implementam a interface <interfacename>Serializable</interfacename> ou os métodos
mágicos <link linkend="object.serialize">__serialize()</link>/<link linkend="object.unserialize">__unserialize()</link>
ou <link linkend="object.sleep">__sleep()</link>/<link linkend="object.wakeup">__wakeup()</link>. Se uma
classe interna não atender a nenhum desses requisitos, ela não poderá ser serializada
de forma confiável com nenhum serializador.
</para>
<para>
</simpara>
<simpara>
Existem algumas exceções históricas à regra acima, onde alguns objetos internos
poderiam ser serializados sem implementar a interface ou expor os métodos.
</para>
</simpara>
</note>
</refsect1>

View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: edd5686aff3f4b2d14eec931b875ee4e0e152b27 Maintainer: leonardolara Status: ready -->
<!-- EN-Revision: 43dd38b94fbf8a9e3efc9c5bfde27c14b9e2ce9c Maintainer: leonardolara Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.igbinary-unserialize">
<refnamediv>
<refname>igbinary_unserialize</refname>
@@ -19,27 +19,27 @@
<function>igbinary_serialize</function> e a converte de volta em um valor PHP.
</simpara>
<warning>
<para>
<simpara>
Entradas não confiáveis de usuários não devem ser passadas para <function>igbinary_unserialize</function>.
A desserialização pode resultar no carregamento e execução do código devido à instanciação
e carregamento automático do objeto, e um usuário mal-intencionado pode explorar
isso. Em vez disso, um formato de intercâmbio de dados padrão e seguro, como JSON (via
<function>json_decode</function> e <function>json_encode</function>) deve ser usado,
se dados serializados precisarem ser passados para um cliente.
</para>
<para>
</simpara>
<simpara>
Se houver necessidade de desserializar dados serializados armazenados externamente,
<function>hash_hmac</function> pode ser usada para validação de dados.
É importante garantir que ninguém tenha adulterado os dados.
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
O formato de serialização igbinary não fornece uma maneira de distinguir entre diferentes grupos de
referência para o mesmo valor. Todas as referências PHP a um determinado valor são tratadas como parte
do mesmo grupo de referência quando desserializadas,
mesmo que façam parte de grupos de referência diferentes quando serializadas.
</para>
</simpara>
</warning>
</refsect1>
@@ -49,27 +49,27 @@
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
<simpara>
A string serializada gerada por <function>igbinary_serialize</function>.
</para>
<para>
</simpara>
<simpara>
Se o valor que está sendo desserializado for um &object;, após a reconstrução
bem-sucedida do objeto, o igbinary tentará automaticamente chamar os métodos
<link linkend="object.unserialize">__unserialize()</link> ou
<link linkend="object.wakeup">__wakeup()</link> (se existirem).
</para>
</simpara>
<note>
<title>
Diretiva
<link linkend="ini.unserialize-callback-func">unserialize_callback_func</link>
</title>
<para>
<simpara>
A função de retorno especificada na diretiva
<link linkend="ini.unserialize-callback-func">unserialize_callback_func</link>
é chamada quando uma classe indefinida é desserializada.
Se nenhuma função de retorno for especificada, o objeto será instanciado como
uma <classname>__PHP_Incomplete_Class</classname>.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -78,34 +78,34 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
O valor convertido é retornado, e pode ser dos tipos <type>bool</type>,
<type>int</type>, <type>float</type>, <type>string</type>,
<type>array</type>, <type>object</type> ou <type>null</type>.
</para>
<para>
</simpara>
<simpara>
Caso a string passada não for desserializável, &false; é retornado e
um <constant>E_NOTICE</constant> ou <constant>E_WARNING</constant> é emitido.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Objetos podem lançar <classname>Throwable</classname>s em seus manipuladores de desserialização.
</para>
</simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
<simpara>
&null; ou &false; serão retornados tanto em caso de erro quanto em caso de desserialização
dos valores &null; ou &false; serializados. É possível capturar este caso especial
comparando <parameter>str</parameter> com
<code>igbinary_serialize(null)</code> ou <code>igbinary_serialize(false)</code>
ou capturando o <constant>E_NOTICE</constant> emitido.
</para>
</simpara>
</warning>
</refsect1>

View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: edd5686aff3f4b2d14eec931b875ee4e0e152b27 Maintainer: fernandowobeto Status: ready -->
<!-- EN-Revision: 43dd38b94fbf8a9e3efc9c5bfde27c14b9e2ce9c Maintainer: fernandowobeto Status: ready -->
<!-- CREDITS: fernandowobeto -->
<section xmlns="http://docbook.org/ns/docbook" xml:id="igbinary.configuration">
&reftitle.runtime;
@@ -59,10 +59,10 @@
<type>bool</type>
</term>
<listitem>
<para>
<simpara>
Habilita ou desabilita a compactação de strings duplicadas.
O padrão é On.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -72,9 +72,9 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
Igbinary é usado como manipulador de sessão definindo este valor como <literal>igbinary</literal>.
</para>
</simpara>
</listitem>
</varlistentry>

View File

@@ -1,19 +1,21 @@
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 605553e228c78a9368736f4ff36d185cf7e6eb22 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto -->
<chapter xml:id="igbinary.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 43dd38b94fbf8a9e3efc9c5bfde27c14b9e2ce9c Maintainer: fernandowobeto Status: ready -->
<!-- CREDITS: fernandowobeto -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="igbinary.setup">
&reftitle.setup;
<section xml:id="igbinary.installation">
&reftitle.install;
<para>
<simpara>
&pecl.moved;
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;igbinary">&url.pecl.package;igbinary</link>.
</para>
<para>
</simpara>
<simpara>
&pecl.windows.download.avail;
</para>
</simpara>
</section>
&reference.igbinary.ini;