sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate methodsynopses based on stubs for recent changes (#903)

Browse source
This commit is contained in:
Máté Kocsis 2021-10-01 17:23:05 +02:00 committed by GitHub
parent aabe0e631b
commit b0b19b6618
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
39 changed files with 244 additions and 103 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
reference/dir/directory/close.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="directory.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Directory::close</refname>
@ -11,16 +10,33 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Directory::close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<void/>
</methodsynopsis>
<para>
Same as <function>closedir</function>, only <parameter>
dir_handle</parameter> defaults to <varname>$this->handle</varname>.
</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.0.0</entry>
<entry>
No parameter is accepted. Previously, a directory handle could be passed as argument.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/dir/directory/read.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="directory.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Directory::read</refname>
@ -10,17 +9,34 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Directory::read</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Directory::read</methodname>
<void/>
</methodsynopsis>
<para>
Same as <function>readdir</function>, only <parameter>
dir_handle</parameter> defaults to <varname>$this->handle</varname>.
</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.0.0</entry>
<entry>
No parameter is accepted. Previously, a directory handle could be passed as argument.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/dir/directory/rewind.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="directory.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Directory::rewind</refname>
@ -11,16 +10,33 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Directory::rewind</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<void/>
</methodsynopsis>
<para>
Same as <function>rewinddir</function>, only <parameter>
dir_handle</parameter> defaults to <varname>$this->handle</varname>.
</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.0.0</entry>
<entry>
No parameter is accepted. Previously, a directory handle could be passed as argument.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/dir/functions/closedir.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>closedir</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>dir_handle</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Closes the directory stream indicated by
@ -70,7 +70,6 @@ if (is_dir($dir)) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/dir/functions/dir.xml
View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>Directory</type><methodname>dir</methodname>
<type class="union"><type>Directory</type><type>false</type></type><methodname>dir</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
@ -44,11 +44,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an instance of <classname>Directory</classname>, or &null; with
wrong parameters, or &false; in case of another error.
Returns an instance of <classname>Directory</classname>, or &false; in case of error.
</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.0.0</entry>
<entry>
<parameter>context</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -102,7 +123,6 @@ cli
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/dir/functions/opendir.xml
View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>opendir</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Opens up a directory handle to be used in subsequent
@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The directory path that is to be opened
@ -59,12 +59,34 @@
&reftitle.errors;
&fs.emits.warning.on.failure;
<para>
This may happen if <parameter>path</parameter> is not a valid directory,
This may happen if <parameter>directory</parameter> is not a valid directory,
the directory can not be opened due to permission restrictions,
or due to filesystem errors.
</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.0.0</entry>
<entry>
<parameter>context</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -112,7 +134,6 @@ filename: cli : filetype: dir
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/dir/functions/readdir.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>readdir</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>dir_handle</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns the name of the next entry in the directory. The
@ -47,6 +47,28 @@
&return.falseproblem;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>dir_handle</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -56,8 +78,7 @@
Please note the fashion in which <function>readdir</function>'s
return value is checked in the examples below. We are explicitly
testing whether the return value is identical to (equal to and of
the same type as--see <link
linkend="language.operators.comparison">Comparison
the same type as--see <link linkend="language.operators.comparison">Comparison
Operators</link> for more information) &false; since otherwise,
any directory entry whose name evaluates to &false; will stop the
loop (e.g. a directory named "0").
@ -123,7 +144,6 @@ if ($handle = opendir('.')) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

27
reference/dir/functions/rewinddir.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>rewinddir</methodname>
<methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>dir_handle</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Resets the directory stream indicated by
@ -42,12 +42,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.nullorfalse;
&return.void;
</para>
</refsect1>
</refentry>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>dir_handle</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

30
reference/dir/functions/scandir.xml
View file

@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>scandir</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>scandir</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sorting_order</parameter><initializer>SCANDIR_SORT_ASCENDING</initializer></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sorting_order</parameter><initializer><constant>SCANDIR_SORT_ASCENDING</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns an <type>array</type> of files and directories from the
@ -69,6 +69,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.0.0</entry>
<entry>
<parameter>context</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -129,7 +152,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/dom/domelement/getattributenode.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>DOMAttr</type><type>DOMNamespaceNode</type><type>false</type></type><methodname>DOMElement::getAttributeNode</methodname>
<modifier>public</modifier> <type class="union"><type>DOMAttr</type><type>DOMNameSpaceNode</type><type>false</type></type><methodname>DOMElement::getAttributeNode</methodname>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
</methodsynopsis>
<para>

2
reference/dom/domelement/getattributenodens.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>DOMAttr</type><type>DOMNamespaceNode</type><type>null</type></type><methodname>DOMElement::getAttributeNodeNS</methodname>
<modifier>public</modifier> <type class="union"><type>DOMAttr</type><type>DOMNameSpaceNode</type><type>null</type></type><methodname>DOMElement::getAttributeNodeNS</methodname>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter></methodparam>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>

4
reference/ldap/functions/ldap-connect.xml
View file

@ -20,7 +20,7 @@
</warning>
<methodsynopsis>
<type class="union"><type>LDAP\Connection</type><type>false</type></type><methodname>ldap_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uri</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>389</initializer></methodparam>
</methodsynopsis>
<para>
@ -56,7 +56,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>host</parameter></term>
<term><parameter>uri</parameter></term>
<listitem>
<para>
The hostname to connect to.

4
reference/mysqli/mysqli/get-client-info.xml
View file

@ -13,12 +13,12 @@
<para>&style.oop;</para>
<fieldsynopsis><type class="union"><type>string</type><type>null</type></type><varname linkend="mysqli.get-client-info">mysqli-&gt;client_info</varname></fieldsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>mysqli::get_client_info</methodname>
<modifier>public</modifier> <type>string</type><methodname>mysqli::get_client_info</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type class="union"><type>string</type><type>null</type></type><methodname>mysqli_get_client_info</methodname>
<type>string</type><methodname>mysqli_get_client_info</methodname>
<methodparam choice="opt"><type class="union"><type>mysqli</type><type>null</type></type><parameter>mysql</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>

4
reference/mysqli/mysqli/init.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>mysqli</type><methodname>mysqli::init</methodname>
<modifier>public</modifier> <type class="union"><type>null</type><type>false</type></type><methodname>mysqli::init</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>mysqli</type><methodname>mysqli_init</methodname>
<type class="union"><type>mysqli</type><type>false</type></type><methodname>mysqli_init</methodname>
<void/>
</methodsynopsis>
<para>

6
reference/reflection/reflectionclass/getattributes.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionclass.getattributes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionClass::getAttributes</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ReflectionClass::getAttributes</methodname>
<methodparam><type>string</type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns all attributes declared on this class as an array of <type>ReflectionAttribute</type>.
@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/reflection/reflectionclassconstant/getattributes.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionclassconstant.getattributes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionClassConstant::getAttributes</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ReflectionClassConstant::getAttributes</methodname>
<methodparam><type>string</type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns all attributes declared on this class constant as an array of <type>ReflectionAttribute</type>.
@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/reflection/reflectionfunctionabstract/getattributes.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionfunctionabstract.getattributes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionFunctionAbstract::getAttributes</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ReflectionFunctionAbstract::getAttributes</methodname>
<methodparam><type>string</type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns all attributes declared on this function or method as an array of <type>ReflectionAttribute</type>.
@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/reflection/reflectionparameter/getattributes.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionparameter.getattributes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionParameter::getAttributes</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ReflectionParameter::getAttributes</methodname>
<methodparam><type>string</type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns all attributes declared on this parameter as an array of <type>ReflectionAttribute</type>.
@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/reflection/reflectionproperty/getattributes.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="reflectionproperty.getattributes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReflectionProperty::getAttributes</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ReflectionProperty::getAttributes</methodname>
<methodparam><type>string</type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns all attributes declared on this class property as an array of <type>ReflectionAttribute</type>.
@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/session/sessionhandler/gc.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>int</type><type>bool</type></type><methodname>SessionHandler::gc</methodname>
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandler::gc</methodname>
<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/snmp/functions/snmp2-get.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-get">
<refentry xml:id="function.snmp2-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_get</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmp2_get</methodname>
<type>mixed</type><methodname>snmp2_get</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

4
reference/snmp/functions/snmp2-getnext.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-getnext">
<refentry xml:id="function.snmp2-getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_getnext</refname>
<refpurpose>Fetch the <acronym>SNMP</acronym> object which follows the given object id</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmp2_getnext</methodname>
<type>mixed</type><methodname>snmp2_getnext</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

4
reference/snmp/functions/snmp2-real-walk.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-real-walk">
<refentry xml:id="function.snmp2-real-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_real_walk</refname>
<refpurpose>Return all objects including their respective object ID within the specified one</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp2_real_walk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmp2_real_walk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

4
reference/snmp/functions/snmp2-set.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-set">
<refentry xml:id="function.snmp2-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_set</refname>
<refpurpose>Set the value of an <acronym>SNMP</acronym> object</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp2_set</methodname>
<type>bool</type><methodname>snmp2_set</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

4
reference/snmp/functions/snmp2-walk.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp2-walk">
<refentry xml:id="function.snmp2-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp2_walk</refname>
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp2_walk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmp2_walk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

4
reference/snmp/functions/snmp3-get.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-get">
<refentry xml:id="function.snmp3-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_get</refname>
<refpurpose>Fetch an <acronym>SNMP</acronym> object</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmp3_get</methodname>
<type>mixed</type><methodname>snmp3_get</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>

4
reference/snmp/functions/snmp3-getnext.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-getnext">
<refentry xml:id="function.snmp3-getnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_getnext</refname>
<refpurpose>Fetch the <acronym>SNMP</acronym> object which follows the given object id</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmp3_getnext</methodname>
<type>mixed</type><methodname>snmp3_getnext</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>

4
reference/snmp/functions/snmp3-real-walk.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-real-walk">
<refentry xml:id="function.snmp3-real-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_real_walk</refname>
<refpurpose>Return all objects including their respective object ID within the specified one</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp3_real_walk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmp3_real_walk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>

4
reference/snmp/functions/snmp3-set.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-set">
<refentry xml:id="function.snmp3-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_set</refname>
<refpurpose>Set the value of an SNMP object</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp3_set</methodname>
<type>bool</type><methodname>snmp3_set</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>

4
reference/snmp/functions/snmp3-walk.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.snmp3-walk">
<refentry xml:id="function.snmp3-walk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>snmp3_walk</refname>
<refpurpose>Fetch all the <acronym>SNMP</acronym> objects from an agent</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmp3_walk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmp3_walk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>security_name</parameter></methodparam>
<methodparam><type>string</type><parameter>security_level</parameter></methodparam>

2
reference/snmp/functions/snmpget.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmpget</methodname>
<type>mixed</type><methodname>snmpget</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/functions/snmpgetnext.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>array</type><type>string</type><type>bool</type></type><methodname>snmpgetnext</methodname>
<type>mixed</type><methodname>snmpgetnext</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/functions/snmprealwalk.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmprealwalk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmprealwalk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/functions/snmpset.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmpset</methodname>
<type>bool</type><methodname>snmpset</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/functions/snmpwalk.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmpwalk</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmpwalk</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/functions/snmpwalkoid.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>snmpwalkoid</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>snmpwalkoid</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>string</type><parameter>community</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>object_id</parameter></methodparam>

2
reference/snmp/snmp/getnext.xml
View file

@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>bool</type></type><methodname>SNMP::getnext</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>SNMP::getnext</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>objectId</parameter></methodparam>
</methodsynopsis>
<para>

2
reference/snmp/snmp/set.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>bool</type></type><methodname>SNMP::set</methodname>
<modifier>public</modifier> <type>bool</type><methodname>SNMP::set</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>objectId</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>type</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>value</parameter></methodparam>

2
reference/snmp/snmp/walk.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>bool</type></type><methodname>SNMP::walk</methodname>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SNMP::walk</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>objectId</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>suffixAsKey</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxRepetitions</parameter><initializer>-1</initializer></methodparam>