1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.createdefaultstub">
<refnamediv>
<refname>Phar::createDefaultStub</refname>
<refpurpose>Create a phar-file format specific stub</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>Phar::createDefaultStub</methodname>
<methodparam choice="opt"><type>string</type><parameter>indexfile</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>webindexfile</parameter></methodparam>
</methodsynopsis>
<para>
This method is intended for creation of phar-file format-specific stubs, and is
not intended for use with tar- or zip-based phar archives.
</para>
<para>
Phar archives contain a bootstrap loader, or <literal>stub</literal>
written in PHP that is executed when the archive is executed in PHP either via
include:
<programlisting role="php">
<![CDATA[
<?php
include 'myphar.phar';
?>
]]>
</programlisting>
or by simple execution:
<screen>
<![CDATA[
php myphar.phar
]]>
</screen>
</para>
<para>
This method provides a simple and easy method to create a stub that will
run a startup file from the phar archive. In addition, different files can
be specified for running the phar archive from the command line versus through
a web server. The loader stub also calls <function>Phar::interceptFileFuncs</function>
to allow easy bundling of a PHP application that accesses the file system. If the
phar extension is not present, the loader stub will extract the phar archive
to a temporary directory and then operate on the files. A shutdown function
erases the temporary files on exit.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the contents of a customized bootstrap loader (stub)
that allows the created Phar archive to work with or without the Phar extension
enabled.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>UnexpectedValueException</classname> if either parameter is longer
than 400 bytes.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Phar::createDefaultStub</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
try {
$phar = new Phar('myphar.phar');
$phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
// handle errors
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::setStub</function></member>
<member><function>Phar::getStub</function></member>
</simplelist>
</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
-->
|
