Skip to content

Document changes to Phar in 8.4 #4050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndossche merged 2 commits into from
Nov 12, 2024
Merged

Document changes to Phar in 8.4 #4050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33bb77a
Document tentative return type changes in Phar
ndossche Nov 12, 2024
432a0fd
Document Unix timestamp support
ndossche Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion reference/phar/Phar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,30 @@
<!-- }}} -->

</section>

<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Added support for the Unix timestamp extension for Zip-based archives.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</partintro>

&reference.phar.entities.Phar;

</reference>
Expand Down
30 changes: 27 additions & 3 deletions reference/phar/Phar/setAlias.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>bool</type><methodname>Phar::setAlias</methodname>
<modifier>public</modifier> <type>true</type><methodname>Phar::setAlias</methodname>
<methodparam><type>string</type><parameter>alias</parameter></methodparam>
</methodsynopsis>
&phar.write;
Expand Down Expand Up @@ -44,8 +44,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<simpara>
&return.true.always;
</simpara>
</refsect1>

<refsect1 role="errors">
Expand All @@ -57,6 +58,29 @@
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<methodname>Phar::setAlias</methodname>
now has a tentative return of <type>true</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
15 changes: 11 additions & 4 deletions reference/phar/Phar/setDefaultStub.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>bool</type><methodname>Phar::setDefaultStub</methodname>
<modifier>public</modifier> <type>true</type><methodname>Phar::setDefaultStub</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>index</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>webIndex</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -45,9 +45,9 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<simpara>
&return.true.always;
</simpara>
</refsect1>

<refsect1 role="errors">
Expand All @@ -72,6 +72,13 @@
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<methodname>Phar::setDefaultStub</methodname>
now has a tentative return of <type>true</type>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Expand Down