reference/phar/Phar/createDefaultStub.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -1,16 +1,16 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.createdefaultstub">
3
+
<refentry xml:id="phar.createdefaultstub" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>Phar::createDefaultStub</refname>
6
6
<refpurpose>Create a phar-file format specific stub</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
-
<methodsynopsis>
10
+
<methodsynopsis role="Phar">
11
11
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>Phar::createDefaultStub</methodname>
12
-
<methodparam choice="opt"><type>string</type><parameter>indexfile</parameter></methodparam>
13
-
<methodparam choice="opt"><type>string</type><parameter>webindexfile</parameter></methodparam>
12
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>index</parameter><initializer>&null;</initializer></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>webIndex</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
16
16
<para>
...
...
@@ -47,6 +47,31 @@ php myphar.phar
47
47
</para>
48
48
49
49
</refsect1>
50
+
51
+
<refsect1 role="parameters">
52
+
&reftitle.parameters;
53
+
<para>
54
+
<variablelist>
55
+
<varlistentry>
56
+
<term><parameter>index</parameter></term>
57
+
<listitem>
58
+
<para>
59
+
Relative path within the phar archive to run if accessed on the command-line
60
+
</para>
61
+
</listitem>
62
+
</varlistentry>
63
+
<varlistentry>
64
+
<term><parameter>webIndex</parameter></term>
65
+
<listitem>
66
+
<para>
67
+
Relative path within the phar archive to run if accessed through a web browser
68
+
</para>
69
+
</listitem>
70
+
</varlistentry>
71
+
</variablelist>
72
+
</para>
73
+
</refsect1>
74
+
50
75
<refsect1 role="returnvalues">
51
76
&reftitle.returnvalues;
52
77
<para>
...
...
@@ -64,6 +89,28 @@ php myphar.phar
64
89
</para>
65
90
</refsect1>
66
91
92
+
<refsect1 role="changelog">
93
+
&reftitle.changelog;
94
+
<informaltable>
95
+
<tgroup cols="2">
96
+
<thead>
97
+
<row>
98
+
<entry>&Version;</entry>
99
+
<entry>&Description;</entry>
100
+
</row>
101
+
</thead>
102
+
<tbody>
103
+
<row>
104
+
<entry>8.0.0</entry>
105
+
<entry>
106
+
<parameter>index</parameter> and <parameter>webIndex</parameter> are now nullable.
107
+
</entry>
108
+
</row>
109
+
</tbody>
110
+
</tgroup>
111
+
</informaltable>
112
+
</refsect1>
113
+
67
114
<refsect1 role="examples">
68
115
&reftitle.examples;
69
116
<para>
...
...
@@ -97,7 +144,6 @@ try {
97
144
98
145
99
146
</refentry>
100
-
101
147
<!-- Keep this comment at the end of the file
102
148
Local variables:
103
149
mode: sgml
104
150