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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision: 297078 $ -->
<refentry xml:id="function.php-check-syntax" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>php_check_syntax</refname>
<refpurpose>
Check the PHP syntax of (and execute) the specified file
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>php_check_syntax</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">error_message</parameter></methodparam>
</methodsynopsis>
<para>
Performs a syntax (lint) check on the specified
<parameter>filename</parameter> testing for scripting errors.
</para>
<para>
This is similar to using <command>php -l</command> from the <link
linkend="features.commandline">commandline</link> except that this
function will execute (but not output) the checked
<parameter>filename</parameter>.
</para>
<para>
For example, if a function is defined in <parameter>filename</parameter>,
this defined function will be available to the file that executed
<function>php_check_syntax</function>, but output from
<parameter>filename</parameter> will be suppressed.
</para>
<note>
<!-- See PHP bug #27406 for details on this suppression -->
<para>
For technical reasons, this function is deprecated and removed from PHP.
Instead, use <literal>php -l somefile.php</literal> from the
<link linkend="features.commandline">commandline</link>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The name of the file being checked.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error_message</parameter></term>
<listitem>
<para>
If the <parameter>error_message</parameter> parameter is used, it will
contain the error message generated by the syntax check.
<parameter>error_message</parameter> is passed by
<link linkend="language.references">reference</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the lint check passed, and &false; if the link check
failed or if <parameter>filename</parameter> cannot be opened.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.0.5</entry>
<entry>
This function was removed from PHP.
</entry>
</row>
<row>
<entry>5.0.3</entry>
<entry>
Calling <function>exit</function> after
<function>php_check_syntax</function> resulted in a Segfault.
</entry>
</row>
<row>
<entry>5.0.1</entry>
<entry>
<parameter>error_message</parameter> is passed by reference.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<screen>
<![CDATA[
php -l somefile.php
]]>
</screen>
</para>
&example.outputs.similar;
<para>
<screen>
<![CDATA[
PHP Parse error: unexpected T_STRING in /tmp/somefile.php on line 81
]]>
</screen>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>include</function></member>
<member><function>is_readable</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
-->
|
