diff --git a/functions/satellite.xml b/functions/satellite.xml index 8ff6c1a64c..e31402044b 100644 --- a/functions/satellite.xml +++ b/functions/satellite.xml @@ -1,67 +1,63 @@ - - Satellite CORBA extension - Satellite + + Satellite CORBA extension + Satellite - - - The Satellite extension is used for accessing CORBA objects. - You will need to set the idl_directory= entry in php.ini to a - path where you store all IDL files you use. - - + + + The Satellite extension is used for accessing CORBA objects. You + will need to set the idl_directory= entry in php.ini to a path + where you store all IDL files you use. + + - - - OrbitObject - Access CORBA objects - - - Description - - - new OrbitObject - string ior - - + + + OrbitObject + Access CORBA objects + + + Description + + + new OrbitObject + string ior + + + + This class provides access to a CORBA object. The + ior parameter should be a string + containing the IOR (Interoperable Object Reference) that + identifies the remote object. + + + + Sample IDL file + +interface MyInterface { + void SetInfo (string info); + string GetInfo(); - - This class provides access to a CORBA object. The ior - parameter should be a string containing the - IOR (Interoperable Object Reference) that identifies the - remote object. - - - - - Sample IDL file - -interface MyInterface -{ - void SetInfo(string info); - string GetInfo(); - - attribute int value; + attribute int value; } - - - - - - - PHP code for accessing MyInterface - + + + + + + PHP code for accessing MyInterface + <?php -$obj = new OrbitObject($ior); +$obj = new OrbitObject ($ior); -$obj->SetInfo("A 2GooD object"); +$obj->SetInfo ("A 2GooD object"); echo $obj->GetInfo(); @@ -69,237 +65,223 @@ $obj->value = 42; echo $obj->value; ?> - - - + + + + + - - - - - - OrbitEnum - Use CORBA enums - - - Description - - - new OrbitEnum - string id - - - - - This class represents the enumeration identified with the id parameter. - The id can be either the name of the enumeration (e.g "MyEnum"), - or the full repository id (e.g. "IDL:MyEnum:1.0"). - - - - - Sample IDL file - -enum MyEnum -{ - a,b,c,d,e + + + OrbitEnum + Use CORBA enums + + + Description + + + new OrbitEnum + string id + + + + This class represents the enumeration identified with the + id parameter. The + id can be either the name of the + enumeration (e.g "MyEnum"), or the full repository id + (e.g. "IDL:MyEnum:1.0"). + + + + Sample IDL file + +enum MyEnum { + a,b,c,d,e }; - - - - - - - PHP code for accessing MyEnum - + + + + + + PHP code for accessing MyEnum + <?php -$enum = new OrbitEnum("MyEnum"); +$enum = new OrbitEnum ("MyEnum"); echo $enum->a; /* write 0 */ echo $enum->c; /* write 2 */ echo $enum->e; /* write 4 */ ?> - - - + + + + + - - - - - - OrbitStruct - Use CORBA structs - - - Description - - - new OrbitStruct - string id - - - - - This class represents the structure identified with the id parameter. - The id can be either the name of the struct (e.g "MyStruct"), - or the full repository id (e.g. "IDL:MyStruct:1.0"). - - - - - Sample IDL file - -struct MyStruct -{ - short shortvalue; - string stringvalue; + + + OrbitStruct + Use CORBA structs + + + Description + + + new OrbitStruct + string id + + + + This class represents the structure identified with the + id parameter. The + id can be either the name of the struct + (e.g "MyStruct"), or the full repository id + (e.g. "IDL:MyStruct:1.0"). + + + + Sample IDL file + +struct MyStruct { + short shortvalue; + string stringvalue; }; -interface SomeInterface -{ - void SetValues(MyStruct values); +interface SomeInterface { + void SetValues (MyStruct values); MyStruct GetValues(); } - - - - - - - PHP code for accessing MyStruct - + + + + + + PHP code for accessing MyStruct + <?php -$obj = new OrbitObject($ior); +$obj = new OrbitObject ($ior); -$initial_values = new OrbitStruct("IDL:MyStruct:1.0"); +$initial_values = new OrbitStruct ("IDL:MyStruct:1.0"); $initial_values->shortvalue = 42; $initial_values->stringvalue = "HGTTG"; -$obj->SetValues($initial_values); +$obj->SetValues ($initial_values); $values = $obj->GetValues(); echo $values->shortvalue; echo $values->stringvalue; ?> - - - + + + + + - - - - - - satellite_caught_exception - See if an exception was caught from the previous function. - - - Description - - - bool satellite_caught_exception - - - - - - This function returns true if an exception has been caught. - - - - - Sample IDL file - + + + satellite_caught_exception + + See if an exception was caught from the previous function + + + + Description + + + bool + satellite_caught_exception + + + + + + This function returns true if an exception has been caught. + + + + Sample IDL file + /* ++?????++ Out of Cheese Error. Redo From Start. */ -exception OutOfCheeseError -{ - int parameter; +exception OutOfCheeseError { + int parameter; } -interface AnotherInterface -{ - void AskWhy() raises(OutOfCheeseError); +interface AnotherInterface { + void AskWhy() raises (OutOfCheeseError); } - - - - - - - PHP code for handling CORBA exceptions - + + + + + + PHP code for handling CORBA exceptions + <?php -$obj = new OrbitObject($ior); +$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; - } +if (satellite_caught_exception()) { + if ("IDL:OutOfCheeseError:1.0" == satellite_exception_id()) { + $exception = satellite_exception_value(); + echo $exception->parameter; + } } ?> - - - + + + + + - - + + + satellite_exception_id + Get the repository id for the latest excetpion. + + + Description + + + string satellite_exception_id + + + + + Return a repository id string. (E.g. "IDL:MyException:1.0".) For + example usage see + satellite_caught_exception. + + + - - - satellite_exception_id - Get the repository id for the latest excetpion. - - - Description - - - string satellite_exception_id - - - + + + satellite_exception_value + + Get the exception struct for the latest exception + + + + Description + + + + OrbitStruct satellite_exception_value + + + + + + Return an exception struct. For example usage see + satellite_caught_exception. + + + - - Return a repository id string. (E.g. "IDL:MyException:1.0".) - For example usage see satellite_caught_exception. - + - - - - - - satellite_exception_value - Get the exception struct for the latest exception. - - - Description - - - OrbitStruct satellite_exception_value - - - - - - Return an exception struct. - For example usage see satellite_caught_exception. - - - - - - - - - -