Class: Service

Source Location: /webservices.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --Service

Component class

Class Details

[line 30]
Component class

Base class for components, it provides owner relationships properties and basic methods to call events.

Non-visible components must inherit from Component and not from Control, the IDE automatically handles the component as iconic.

[ Top ]

Properties Active [published] NameSpace [published] SchemaTargetNamespace [published] ServiceName [published]	Events OnAddComplexTypes [published] OnRegisterServices [published]	JS Events [none]
Methods __construct addComplexType init register	Constants [none]

Inherited Properties Class: Component Component::ComponentCount Indicates how many components this component is owner Component::Components Component list containing all the components owned by this component Component::ControlState A flag to know the state of the control, csLoading, csDesigning Component::DataFieldValue This function returns the value of the datafield, if any Component::Name Name for the component, to be used as an identifier, should be unique Component::NamePath The path to uniquely identify a component, qualified by the owner when required Component::Owner The owner of this component, usually the page component, but the owner of pages is the application object Component::Tag A versatily property of every Component that can be used in any way you want Class: Persistent Persistent::NamePath Used to serialize/unserialize Persistent::Owner Owner of the component, in Persistent always return null	Inherited Events	Inherited JS Events
Inherited Methods Class: Component Component::__construct Constructor Component::ajaxCall Returns the js event attribute to call the server using ajax Component::callEvent Calls a server event Component::dumpChildrenHeaderCode Dump the header code for all the children Component::dumpChildrenJavascript Dump the javascript code for all the children Component::dumpHeaderCode To dump header code required Component::dumpHiddenKeyFields This function dumps out the key fields for the current row, useful to Component::dumpJavascript To dump the javascript code needed by this component Component::fixupProperty This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference Component::generateAjaxEvent Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff. Component::hasValidDataField This function returns true if the datafield is valid Component::init To initialize a component, the right place to process events Component::insertComponent Insert a component into the components collection Component::loaded A virtual method to get notified when the object has been fully loaded from a stream Component::loadedChildren Calls childrens loaded recursively Component::loadResource Load this component from a string Component::preinit To initialize a component, called before init() Component::readAccessibility Overwrite this method to provide accessibility info for the RPC engine Component::readFromResource Read a component from a resource file Component::removeComponent Remove a component from the components collection Component::serializeChildren Serialize all children Component::unserializeChildren Unserialize all children Component::updateDataField Checks if there is any datafield attached to the component Class: Persistent Persistent::assign Assing the source properties to this object Persistent::assignError Raises an assignation error Persistent::assignTo Assign this object to another object Persistent::serialize Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored. Persistent::unserialize Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized. Class: Object Object::__construct Constructor Object::className Returns the name of the object class Object::classNameIs Check if the object is from a specific class Object::classParent Returns the parent class of the object Object::inheritsFrom Check if the object inherits from a specific class Object::methodExists Check if a method exists Object::readProperty Reads a property from the streams Object::__get To virtualize properties Object::__set To virtualize properties

Properties

property Active [line 41]

Specifies if the webservice is active or not, if it's true, the component will fire the events

to get the functions to register and any complex type required and will publish the WSDL and process service requests

[ Top ]

property NameSpace [line 59]

Specifies the Name Space for the WSDL

[ Top ]

property SchemaTargetNamespace [line 68]

Specifies the Target Name Space for the WSDL

[ Top ]

property ServiceName [line 50]

Specifies the Name of the service you want to create

[ Top ]

Events

property OnAddComplexTypes [line 87]

Fired when the service needs to register complex types, see also addComplexType

[ Top ]

property OnRegisterServices [line 78]

Fired when the service needs to register the functions to be published by the service, see also register method

[ Top ]

Javascript Events

Methods

constructor __construct [line 122]

Service __construct(
[
$aowner = null])

Overrides Component::__construct (Constructor)

Parameters:

$aowner

[ Top ]

void addComplexType [line 190]

void addComplexType(
name
$name, [typeClass
$typeClass = 'complexType'], [phpType:
$phpType = 'array'], [compositor
$compositor = ''], [restrictionBase
$restrictionBase = ''], [elements
$elements = array()], [attrs
$attrs = array()], [arrayType:
$arrayType = ''])

adds a complex type to the schema

example: array

addType( 'ArrayOfstring', 'complexType', 'array', '', 'SOAP-ENC:Array', array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'string[]'), 'xsd:string' );

example: PHP associative array ( SOAP Struct )

addType( 'SOAPStruct', 'complexType', 'struct', 'all', array('myVar'=> array('name'=>'myVar','type'=>'string') );

Tags:

see:	getTypeDef
access:	public

Parameters:

name	$name
typeClass	$typeClass	(complexType\|simpleType\|attribute)
phpType:	$phpType	currently supported are array and struct (php assoc array)
compositor	$compositor	(all\|sequence\|choice)
restrictionBase	$restrictionBase	namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
elements	$elements	= array ( name = array(name=>'',type=>'') )
attrs	$attrs	= array( array( 'ref' => "http://schemas.xmlsoap.org/soap/encoding/:arrayType", "http://schemas.xmlsoap.org/wsdl/:arrayType" => "string[]" ) )
arrayType:	$arrayType	namespace:name (http://www.w3.org/2001/XMLSchema:string)

[ Top ]

void init [line 91]

void init(
)

Overrides Component::init (To initialize a component, the right place to process events)

[ Top ]

void register [line 142]

void register(
string
$name, [array
$in = array()], [array
$out = array()], [mixed
$namespace = false], [mixed
$soapaction = false], [mixed
$style = false], [mixed
$use = false], [string
$documentation = ''], [string
$encodingStyle = ''])

Tags:

access:

public

Parameters:

string	$name	the name of the PHP function, class.method or class..method
array	$in	assoc array of input values: key = param name, value = param type
array	$out	assoc array of output values: key = param name, value = param type
mixed	$namespace	the element namespace for the method or false
mixed	$soapaction	the soapaction for the method or false
mixed	$style	optional (rpc\|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically
mixed	$use	optional (encoded\|literal) or false
string	$documentation	optional Description to include in WSDL
string	$encodingStyle	optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:36:02 +0200 by phpDocumentor 1.3.1

Class: Service

Class Overview

Class Details

Properties

Events

JS Events

Methods

Constants

Inherited Properties

Class: Component

Class: Persistent

Inherited Events

Inherited JS Events

Inherited Methods

Class: Component

Class: Persistent

Class: Object

Properties

property Active [line 41]

property NameSpace [line 59]

property SchemaTargetNamespace [line 68]

property ServiceName [line 50]

Events

property OnAddComplexTypes [line 87]

property OnRegisterServices [line 78]

Javascript Events

Methods

constructor __construct [line 122]

Parameters:

void addComplexType [line 190]

Tags:

Parameters:

void init [line 91]

void register [line 142]

Tags:

Parameters: