Skip to content

Commit df1280f

Browse files
lacatoirelacatoire
authored
[Sync EN] Phar::setStub: describe the $length parameter (#777)
Refs: php/doc-en@d7056bd
1 parent d5a32e8 commit df1280f

2 files changed

Lines changed: 69 additions & 27 deletions

File tree

‎reference/phar/Phar/setStub.xml‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 9c828621cbce488cf6306b21c39e208f847eabd5 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
2+
<!-- EN-Revision: d7056bd0948e3dd9316708247933026bd3d560b1 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
33
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.setstub">
44
<refnamediv>
55
<refname>Phar::setStub</refname>
@@ -8,28 +8,33 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="Phar">
11-
<modifier>public</modifier> <type>bool</type><methodname>Phar::setStub</methodname>
11+
<modifier>public</modifier> <type>true</type><methodname>Phar::setStub</methodname>
1212
<methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>stub</parameter></methodparam>
1313
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
1414
</methodsynopsis>
1515
&phar.write;
1616

17-
1817
<para>
1918
Este método é usado para adicionar um stub de carregador de inicialização PHP a um novo arquivo Phar, ou
2019
para substituir o stub de carregador em um arquivo Phar existente.
2120
</para>
2221
<para>
2322
O stub do carregador para um arquivo Phar é usado sempre que um arquivo é incluído diretamente
2423
como neste exemplo:
25-
</para>
26-
<programlisting role="php">
24+
<programlisting role="php">
2725
<![CDATA[
2826
<?php
2927
include 'meuphar.phar';
3028
?>
3129
]]>
32-
</programlisting>
30+
</programlisting>
31+
ou por execução simples:
32+
<screen>
33+
<![CDATA[
34+
php meuphar.phar
35+
]]>
36+
</screen>
37+
</para>
3338
<para>
3439
O carregador não é acessado ao incluir um arquivo por meio do empacotador de fluxo <literal>phar</literal>
3540
como a seguir:
@@ -60,9 +65,16 @@ include 'phar://meuphar.phar/algumarquivo.php';
6065
<varlistentry>
6166
<term><parameter>length</parameter></term>
6267
<listitem>
63-
<para>
64-
65-
</para>
68+
<simpara>
69+
Comprimento de <parameter>stub</parameter> em bytes.
70+
</simpara>
71+
<warning>
72+
<simpara>
73+
Passar o argumento <parameter>length</parameter> com um &resource; no
74+
primeiro argumento está <emphasis>DESCONTINUADO</emphasis> a partir do PHP 8.3.0.
75+
Em vez disso, use <literal>$phar->setStub(stream_get_contents($resource))</literal>.
76+
</simpara>
77+
</warning>
6678
</listitem>
6779
</varlistentry>
6880
</variablelist>
@@ -71,9 +83,9 @@ include 'phar://meuphar.phar/algumarquivo.php';
7183

7284
<refsect1 role="returnvalues">
7385
&reftitle.returnvalues;
74-
<para>
75-
&return.success;
76-
</para>
86+
<simpara>
87+
&return.true.always;
88+
</simpara>
7789
</refsect1>
7890

7991
<refsect1 role="errors">
@@ -98,12 +110,18 @@ include 'phar://meuphar.phar/algumarquivo.php';
98110
</row>
99111
</thead>
100112
<tbody>
113+
<row>
114+
<entry>8.4.0</entry>
115+
<entry>
116+
O tipo do retorno agora é &true;; anteriormente, era <type>bool</type>.
117+
</entry>
118+
</row>
101119
<row>
102120
<entry>8.3.0</entry>
103121
<entry>
104122
Chamar <methodname>Phar::setStub</methodname> com um
105123
<type>resource</type> e um <parameter>length</parameter>
106-
foi descontinuado. Tais chamadas devem ser substituídas por:
124+
agora está descontinuado. Tais chamadas devem ser substituídas por:
107125
<code>$phar->setStub(stream_get_contents($resource));</code>
108126
</entry>
109127
</row>
@@ -122,12 +140,14 @@ include 'phar://meuphar.phar/algumarquivo.php';
122140
<programlisting role="php">
123141
<![CDATA[
124142
<?php
143+
125144
try {
126145
$p = new Phar(dirname(__FILE__) . '/novophar.phar', 0, 'novophar.phar');
127146
$p['a.php'] = '<?php var_dump("Olá");';
128147
$p->setStub('<?php var_dump("Primeiro"); Phar::mapPhar("novophar.phar"); __HALT_COMPILER(); ?>');
129148
include 'phar://novophar.phar/a.php';
130149
var_dump($p->getStub());
150+
131151
$p['b.php'] = '<?php var_dump("Mundo");';
132152
$p->setStub('<?php var_dump("Segundo"); Phar::mapPhar("novophar.phar"); __HALT_COMPILER(); ?>');
133153
include 'phar://novophar.phar/b.php';

‎reference/phar/PharData/setStub.xml‎

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
2+
<!-- EN-Revision: d7056bd0948e3dd9316708247933026bd3d560b1 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
33
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phardata.setstub">
44
<refnamediv>
55
<refname>PharData::setStub</refname>
@@ -8,9 +8,9 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="PharData">
11-
<modifier>public</modifier> <type>bool</type><methodname>PharData::setStub</methodname>
12-
<methodparam><type>string</type><parameter>stub</parameter></methodparam>
13-
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>-1</initializer></methodparam>
11+
<modifier>public</modifier> <type>true</type><methodname>PharData::setStub</methodname>
12+
<methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>stub</parameter></methodparam>
13+
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
1414
</methodsynopsis>
1515

1616

@@ -27,18 +27,18 @@
2727
<varlistentry>
2828
<term><parameter>stub</parameter></term>
2929
<listitem>
30-
<para>
31-
Uma string ou um identificador de fluxo aberto para usar como stub executável para este
30+
<simpara>
31+
Formalmente, uma string ou um identificador de fluxo aberto para usar como stub executável para este
3232
arquivo phar. Este parâmetro é ignorado.
33-
</para>
33+
</simpara>
3434
</listitem>
3535
</varlistentry>
3636
<varlistentry>
37-
<term><parameter>len</parameter></term>
37+
<term><parameter>length</parameter></term>
3838
<listitem>
39-
<para>
40-
41-
</para>
39+
<simpara>
40+
<parameter>stub</parameter> em bytes. Este parâmetro é ignorado.
41+
</simpara>
4242
</listitem>
4343
</varlistentry>
4444
</variablelist>
@@ -48,9 +48,9 @@
4848

4949
<refsect1 role="returnvalues">
5050
&reftitle.returnvalues;
51-
<para>
52-
&return.success;
53-
</para>
51+
<simpara>
52+
&return.true.always;
53+
</simpara>
5454
</refsect1>
5555

5656
<refsect1 role="errors">
@@ -60,6 +60,28 @@
6060
</para>
6161
</refsect1>
6262

63+
<refsect1 role="changelog">
64+
&reftitle.changelog;
65+
<informaltable>
66+
<tgroup cols="2">
67+
<thead>
68+
<row>
69+
<entry>&Version;</entry>
70+
<entry>&Description;</entry>
71+
</row>
72+
</thead>
73+
<tbody>
74+
<row>
75+
<entry>8.4.0</entry>
76+
<entry>
77+
O tipo do retorno agora é &true;; anteriormente, era <type>bool</type>.
78+
</entry>
79+
</row>
80+
</tbody>
81+
</tgroup>
82+
</informaltable>
83+
</refsect1>
84+
6385
<refsect1 role="seealso">
6486
&reftitle.seealso;
6587
<para>

0 commit comments

Comments
 (0)