functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@197335 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Spector 2005-10-02 08:20:49 +00:00
parent b24cd179a6
commit 9243160988
2 changed files with 224 additions and 0 deletions

View file

@ -0,0 +1,134 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.expect-expectl">
<refnamediv>
<refname>expect_expectl</refname>
<refpurpose>Waits until the output from a process matches one
of the patterns, a specified time period has passed, or an EOF is seen.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>expect_expectl</methodname>
<methodparam><type>resource</type><parameter>expect</parameter></methodparam>
<methodparam><type>array</type><parameter>cases</parameter></methodparam>
</methodsynopsis>
<para>
Waits until the output from a process matches one of the patterns,
a specified time period has passed, or an EOF is seen.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>expect</parameter></term>
<listitem>
<para>
An Expect stream, previously opened with
<function>expect_popen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cases</parameter></term>
<listitem>
<para>
An array of expect cases. Each expect case is an indexed array, where
value corresponding to key 0 is a string pattern, 1 - return value,
and 2 - one of EXP_GLOB, EXP_EXACT or EXP_REGEXP (pattern type).
Key index 2 is optional, if not specified - the value of EXP_GLOB is
used by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns value associated with pattern that was matched.
</para>
<para>
On failure this function returns EXP_EOF, EXP_TIMEOUT or EXP_FULLBUFFER.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>expect_expectl</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Copies file from remote host:
ini_set ("expect.timeout", 30);
$stream = popen ("expect://scp user@remotehost:/var/log/messages /home/user/messages.txt", "r");
$cases = array (
array (0 => "password:", 1 => PASSWORD),
array (0 => "yes/no)?", 1 => YESNO)
);
while (true) {
switch (expect_expectl ($stream, $cases))
{
case PASSWORD:
fwrite ($stream, "password\n");
break;
case YESNO:
fwrite ($stream, "yes\n");
break;
case EXP_TIMEOUT:
case EXP_EOF:
break 2;
default:
die ("Error has occurred!\n");
}
}
fclose ($stream);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>expect_popen</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:"../../../../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
-->

View file

@ -0,0 +1,90 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.expect-popen">
<refnamediv>
<refname>expect_popen</refname>
<refpurpose>Exectutes command via Bourne shell.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>expect_popen</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
</methodsynopsis>
<para>
Executes command via Bourne shell.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
Command to execute.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an open PTY stream to the process'es stdio, stdout and stderr.
</para>
<para>
On failure this function returns &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>expect_popen</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Login to the PHP.net CVS repository:
$stream = expect_popen ("cvs -d :pserver:anonymous@cvs.php.net:/repository login");
sleep (3);
fwrite ($stream, "phpfi\n");
fclose ($stream);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>popen</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:"../../../../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
-->