[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] cvs: phpdoc /en/reference/funchand/functions forward-static-call-array.xml forward-static-
From: "Damien Seguy" <dams () php ! net>
Date: 2009-06-29 10:25:25
Message-ID: cvsdams1246271125 () cvsserver
[Download RAW message or body]
dams Mon Jun 29 10:25:25 2009 UTC
Added files:
/phpdoc/en/reference/funchand/functions
forward-static-call-array.xml
forward-static-call.xml
/phpdoc/en/reference/imap/functions imap-gc.xml
/phpdoc/en/reference/openssl/functions
openssl-random-pseudo-bytes.xml
Log:
initial doc
["dams-20090629102525.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/funchand/functions/forward-static-call-array.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/funchand/functions/forward-static-call-array.xml
+++ phpdoc/en/reference/funchand/functions/forward-static-call-array.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.forward-static-call-array" \
xmlns="http://docbook.org/ns/docbook"> <refnamediv>
<refname>forward_static_call_array</refname>
<refpurpose>Call a static method and pass the arguments as array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>forward_static_call_array</methodname>
<methodparam><type>callback</type><parameter>function</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>parameters</parameter></methodparam>
</methodsynopsis>
<para>
Calls a user defined function or method given by the \
<parameter>function</parameter> parameter. This function must be called within a \
method context, et can't be used outside a class. All arguments of the forwarded \
method are passed as values, and as an array, similarly to \
<function>call_user_func_array</function>. </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The function or method to be called. This parameter may be an &array;,
with the name of the class, and the method, or a &string;, with a function
name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
One parameter, gathering all the method parameter in one array.
</para>
<note>
<para>
Note that the parameters for <function>forward_static_call_array</function> \
are not passed by reference.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the function result, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>forward_static_call_array</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class A
{
const NAME = 'A';
public static function test() {
$args = func_get_args();
echo static::NAME, " ".join(',', $args)." \n";
}
}
class B extends A
{
const NAME = 'B';
public static function test() {
echo self::NAME, "\n";
forward_static_call_array(array('A', 'test'), array('more', 'args'));
forward_static_call_array( 'test', array('other', 'args'));
}
}
B::test('foo');
function test() {
$args = func_get_args();
echo "C ".join(',', $args)." \n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
B
B more,args
C other,args
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>forward_static_call</function></member>
<member><function>call_user_func</function></member>
<member><function>call_user_func_array</function></member>
<member><function>is_callable</function></member>
<member>&seealso.callback;</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/funchand/functions/forward-static-call.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/funchand/functions/forward-static-call.xml
+++ phpdoc/en/reference/funchand/functions/forward-static-call.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.forward-static-call" \
xmlns="http://docbook.org/ns/docbook"> <refnamediv>
<refname>forward_static_call</refname>
<refpurpose>Call a static method</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>forward_static_call</methodname>
<methodparam><type>callback</type><parameter>function</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
Calls a user defined function or method given by the \
<parameter>function</parameter> parameter, with the following arguments. This \
function must be called within a method context, et can't be used outside a class.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The function or method to be called. This parameter may be an array,
with the name of the class, and the method, or a string, with a function
name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
Zero or more parameters to be passed to the function.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the function result, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>forward_static_call</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class A
{
const NAME = 'A';
public static function test() {
$args = func_get_args();
echo static::NAME, " ".join(',', $args)." \n";
}
}
class B extends A
{
const NAME = 'B';
public static function test() {
echo self::NAME, "\n";
forward_static_call(array('A', 'test'), 'more', 'args');
forward_static_call( 'test', 'other', 'args');
}
}
B::test('foo');
function test() {
$args = func_get_args();
echo "C ".join(',', $args)." \n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
B
B more,args
C other,args
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>forward_static_call_array</function></member>
<member><function>call_user_func_array</function></member>
<member><function>call_user_func</function></member>
<member><function>is_callable</function></member>
<member>&seealso.callback;</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imap/functions/imap-gc.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/imap/functions/imap-gc.xml
+++ phpdoc/en/reference/imap/functions/imap-gc.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.imap-gc" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>imap_gc</refname>
<refpurpose>Clears IMAP cache</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>imap_gc</methodname>
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>caches</parameter></methodparam>
</methodsynopsis>
<para>
Purges the cache of entries of a specific type.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-stream.description;
<varlistentry>
<term><parameter>caches</parameter></term>
<listitem>
<para>
Specifies the cache to purge. It may one or a combinaison
of the following constants :
<constant>IMAP_GC_ELT</constant> (message cache elements),
<constant>IMAP_GC_ENV</constant> (enveloppe and bodies),
<constant>IMAP_GC_TEXTS</constant> (texts).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imap_gc</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");
imap_gc($mbox, IMAP_GC_ELT);
?>
]]>
</programlisting>
</example>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-random-pseudo-bytes.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/openssl/functions/openssl-random-pseudo-bytes.xml
+++ phpdoc/en/reference/openssl/functions/openssl-random-pseudo-bytes.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" \
xml:id="function.openssl-random-pseudo-bytes"> <refnamediv>
<refname>openssl_random_pseudo_bytes</refname>
<refpurpose>Generate a pseudo-random string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_random_pseudo_bytes</methodname>
<methodparam><type>string</type><parameter>length</parameter></methodparam>
<methodparam><type>string</type><parameter>strong</parameter></methodparam>
</methodsynopsis>
<para>
<function>openssl_random_pseudo_bytes</function> returns a &string; with
<parameter>length</parameter> caracters. It also indicates if it has used
a strong algorithm to produce those pseudo-random bytes in the second argument.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
The length of the desired string. Must be a positive integer. PHP will
try to cast this parameter to a non-null integer to use it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strong</parameter></term>
<listitem>
<para>
If a strong algorithm was used, or not, as a boolean.
This parameter will be &null; if an error occurrs.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the generated &string; in cas of success, or &false; in case of error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>openssl_random_pseudo_bytes</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
for ($i = -1; $i < 5; $i++) {
var_dump(bin2hex(openssl_random_pseudo_bytes($i, $strong)));
var_dump($strong);
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(0) ""
NULL
string(0) ""
NULL
string(2) "f6"
bool(true)
string(4) "8999"
bool(true)
string(6) "c202c9"
bool(true)
string(8) "45261b8f"
bool(true)
]]>
</screen>
</example>
</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:"../../../../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
-->
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic