betz Thu Sep 15 05:02:29 2005 EDT
Added files:
/phpdoc/en/reference/satellite .cvsignore reference.xml
/phpdoc/en/reference/satellite/functions orbitenum.xml
orbitobject.xml
orbitstruct.xml
satellite-caught-exception.xml
satellite-exception-id.xml
satellite-exception-value.xml
satellite-get-repository-id.xml
satellite-load-idl.xml
satellite-object-to-string.xml
Log:
move satellite from peardoc to phpdoc
http://cvs.php.net/co.php/phpdoc/en/reference/satellite/.cvsignore?r=1.1&p=1
Index: phpdoc/en/reference/satellite/.cvsignore
+++ phpdoc/en/reference/satellite/.cvsignore
functions.xml
http://cvs.php.net/co.php/phpdoc/en/reference/satellite/reference.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/reference.xml
+++ phpdoc/en/reference/satellite/reference.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- State: deprecated -->
<!-- Author: David Eriksson <[EMAIL PROTECTED]> -->
<reference id="ref.satellite">
<title>Satellite CORBA client extension [deprecated]</title>
<titleabbrev>Satellite</titleabbrev>
<partintro>
<section id="satellite.intro">
&reftitle.intro;
&warn.experimental;
¬e.no-windows.extension;
<para>
Satellite is deprecated. It is suggested that you use Universe
(<ulink url="&url.corba.universe;">&url.corba.universe;</ulink>) and not
Satellite.
</para>
<para>
The Satellite extension is used for accessing CORBA objects. You
will need to set the <literal>idl_directory=</literal> entry in &php.ini;
to a path where you store all IDL files you use.
</para>
<para>
See the Satellite <filename>README</filename>file for details about
installing Satellite.
</para>
</section>
</partintro>
&reference.satellite.functions;
</reference>
<!-- 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/co.php/phpdoc/en/reference/satellite/functions/orbitenum.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/orbitenum.xml
+++ phpdoc/en/reference/satellite/functions/orbitenum.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.orbitenum">
<refnamediv>
<refname>OrbitEnum</refname>
<refpurpose>Use CORBA enums</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>new</type><methodname>OrbitEnum</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This class represents the enumeration identified with the
<parameter>id</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
Can be either the name of the enumeration (e.g "MyEnum"), or the full
repository id (e.g. "IDL:MyEnum:1.0").
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Sample IDL file</title>
<programlisting role="txt">
<![CDATA[
enum MyEnum {
a,b,c,d,e
};
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>PHP code for accessing MyEnum</title>
<programlisting role="php">
<![CDATA[
<?php
$enum = new OrbitEnum ("MyEnum");
echo $enum->a; /* write 0 */
echo $enum->c; /* write 2 */
echo $enum->e; /* write 4 */
?>
]]>
</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/co.php/phpdoc/en/reference/satellite/functions/orbitobject.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/orbitobject.xml
+++ phpdoc/en/reference/satellite/functions/orbitobject.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.orbitobject">
<refnamediv>
<refname>OrbitObject</refname>
<refpurpose>Access CORBA objects</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>new</type><methodname>OrbitObject</methodname>
<methodparam><type>string</type><parameter>ior</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This class provides access to a CORBA object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ior</parameter></term>
<listitem>
<para>
Should be a string containing the IOR (Interoperable Object Reference)
that identifies the remote object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Sample IDL file</title>
<programlisting role="txt">
<![CDATA[
interface MyInterface {
void SetInfo (string info);
string GetInfo();
attribute int value;
}
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>PHP code for accessing MyInterface</title>
<programlisting role="php">
<![CDATA[
<?php
$obj = new OrbitObject ($ior);
$obj->SetInfo ("A 2GooD object");
echo $obj->GetInfo();
$obj->value = 42;
echo $obj->value;
?>
]]>
</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/co.php/phpdoc/en/reference/satellite/functions/orbitstruct.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/orbitstruct.xml
+++ phpdoc/en/reference/satellite/functions/orbitstruct.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.orbitstruct">
<refnamediv>
<refname>OrbitStruct</refname>
<refpurpose>Use CORBA structs</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>new</type><methodname>OrbitStruct</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This class represents the structure identified with the
<parameter>id</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
Can be either the name of the struct (e.g "MyStruct"), or the full
repository id (e.g. "IDL:MyStruct:1.0").
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Sample IDL file</title>
<programlisting role="txt">
<![CDATA[
struct MyStruct {
short shortvalue;
string stringvalue;
};
interface SomeInterface {
void SetValues (MyStruct values);
MyStruct GetValues();
}
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>PHP code for accessing MyStruct</title>
<programlisting role="php">
<![CDATA[
<?php
$obj = new OrbitObject ($ior);
$initial_values = new OrbitStruct ("IDL:MyStruct:1.0");
$initial_values->shortvalue = 42;
$initial_values->stringvalue = "HGTTG";
$obj->SetValues ($initial_values);
$values = $obj->GetValues();
echo $values->shortvalue;
echo $values->stringvalue;
?>
]]>
</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/co.php/phpdoc/en/reference/satellite/functions/satellite-caught-exception.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-caught-exception.xml
+++ phpdoc/en/reference/satellite/functions/satellite-caught-exception.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.satellite-caught-exception">
<refnamediv>
<refname>satellite_caught_exception</refname>
<refpurpose>See if an exception was caught from the previous
function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>satellite_caught_exception</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns &true; if an exception has been caught, &false;
otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Sample IDL file</title>
<programlisting role="txt">
<![CDATA[
/* ++?????++ Out of Cheese Error. Redo From Start. */
exception OutOfCheeseError {
int parameter;
}
interface AnotherInterface {
void AskWhy() raises (OutOfCheeseError);
}
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>PHP code for handling CORBA exceptions</title>
<programlisting role="php">
<![CDATA[
<?php
$obj = new OrbitObject ($ior);
$obj->AskWhy();
if (satellite_caught_exception()) {
if ("IDL:OutOfCheeseError:1.0" == satellite_exception_id()) {
$exception = satellite_exception_value();
echo $exception->parameter;
}
}
?>
]]>
</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/co.php/phpdoc/en/reference/satellite/functions/satellite-exception-id.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-exception-id.xml
+++ phpdoc/en/reference/satellite/functions/satellite-exception-id.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.satellite-exception-id">
<refnamediv>
<refname>satellite_exception_id</refname>
<refpurpose>Get the repository id for the latest exception.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>satellite_exception_id</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
For example usage see <function>satellite_caught_exception</function>.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return a repository id string. (E.g. "IDL:MyException:1.0".)
</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/co.php/phpdoc/en/reference/satellite/functions/satellite-exception-value.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-exception-value.xml
+++ phpdoc/en/reference/satellite/functions/satellite-exception-value.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id="function.satellite-exception-value">
<refnamediv>
<refname>satellite_exception_value</refname>
<refpurpose>Get the exception struct for the latest exception</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>OrbitStruct</type><methodname>satellite_exception_value</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Return an exception struct. For example usage see
<function>satellite_caught_exception</function>.
</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/co.php/phpdoc/en/reference/satellite/functions/satellite-get-repository-id.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-get-repository-id.xml
+++ phpdoc/en/reference/satellite/functions/satellite-get-repository-id.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id='function.satellite-get-repository-id'>
<refnamediv>
<refname>satellite_get_repository_id</refname>
<refpurpose>NOT IMPLEMENTED</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>satellite_get_repository_id</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
</methodsynopsis>
<para>Not implemented.</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/co.php/phpdoc/en/reference/satellite/functions/satellite-load-idl.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-load-idl.xml
+++ phpdoc/en/reference/satellite/functions/satellite-load-idl.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id='function.satellite-load-idl'>
<refnamediv>
<refname>satellite_load_idl</refname>
<refpurpose>Instruct the type manager to load an IDL file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>satellite_load_idl</methodname>
<methodparam><type>string</type><parameter>file</parameter></methodparam>
</methodsynopsis>
<para>
Load an IDL file into Satellite.
</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/co.php/phpdoc/en/reference/satellite/functions/satellite-object-to-string.xml?r=1.1&p=1
Index: phpdoc/en/reference/satellite/functions/satellite-object-to-string.xml
+++ phpdoc/en/reference/satellite/functions/satellite-object-to-string.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/satellite.xml, last change in rev 1.2 -->
<refentry id='function.satellite-object-to-string'>
<refnamediv>
<refname>satellite_object_to_string</refname>
<refpurpose>Convert an object to its string representation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>satellite_object_to_string</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
</methodsynopsis>
<para>
Convert an object to its string representation (IOR).
</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
-->
