Docs For Class Services_Webservice

$description =

[line 61]

Description of the web service

Access: protected

Type:

string

[ Top ]

$namespace =

[line 53]

Namespace of the web service

Access: public

Type:

string

[ Top ]

$_classname =

[line 88]

Name of the class from which to create a web service from

Access: protected

Type:

string

[ Top ]

$_hiddenMethods =

[line 96]

Exclude these methods from web service

Access: protected

Type:

array

[ Top ]

$_simpleTypes = array(
        'string', 'int', 'float', 'bool', 'double', 'integer', 'boolean',
        'varstring', 'varint', 'varfloat', 'varbool', 'vardouble',
        'varinteger', 'varboolean')

[line 69]

Simple WSDL types

Access: protected

Type:

array

[ Top ]

$_URI = array()

[line 104]

Some user-overwritten URIs

Access: protected

Type:

array

[ Top ]

$_wsdlStruct =

[line 80]

Classes are parsed into this struct

Access: protected

Type:

array

[ Top ]

__construct (Constructor) [line 115]

Services_Webservice_Definition __construct(

$class, 
$namespace, [
$options = null])

Constructor

Throws: Services_Webservice_Definition_NotClassException
Access: public

Parameters:

	`$class`	—
	`$namespace`	—
	`$options`	—

[ Top ]

classMethodsIntoStruct [line 378]

void classMethodsIntoStruct(
)

Parses classes methods into struct

Throws: Services_Webservice_Definition_NoDocCommentException
Throws: Services_Webservice_Definition_DocCommentMismatchException
Throws: Services_Webservice_Definition_Exception
Access: protected

[ Top ]

classPropertiesIntoStruct [line 299]

void classPropertiesIntoStruct(

$className)

Parses classes properties into struct

Throws: Services_Webservice_Definition_IncompleteDocCommentException
Throws: Services_Webservice_Definition_NoDocCommentException
Access: protected

Parameters:

$className —

[ Top ]

classStructDispatch [line 269]

void classStructDispatch(
)

Dispatches types

Throws: Services_Webservice_Definition_Exception
Access: protected

[ Top ]

getClassName [line 182]

string getClassName(
)

Returns the name of the class being defined

Return: the nane of the class being introspected
Access: public

[ Top ]

getStruct [line 168]

array getStruct(
)

Returns the structure of classes as parsed by intoStruct

Access: public

[ Top ]

getURI [line 224]

mixed getURI(
[string
$name = null])

Returns some URIs

Return: an array of found URIs if $name is an array, a string if $name is a string, or and NULL if $name is not found
See: Services_Webservice_Definition::setURI()
Access: public

Parameters:

string $name — URI identifier or array of URI identifiers

[ Top ]

intoStruct [line 150]

void intoStruct(
)

Parses classes into struct

Access: protected

[ Top ]

isMethodExposed [line 583]

boolean isMethodExposed(
string
$methodName, [boolean
&$isStatic = null])

Checks if a given method is exposed for the web service

Return: TRUE if exposed, FALSE otherwise
Throws: Services_Webservice_Definition_Exception
Throws: Services_Webservice_Definition_NoDocCommentException
Access: public

Parameters:

string	`$methodName`	—	method name to check accessibility for
boolean	`&$isStatic`	—	if method is exposed and is static, this by-reference variable will be set to TRUE.

[ Top ]

setURI [line 203]

void setURI(
string|array
$name, [string
$URI = null])

Sets some URIs

Allows to override the default value for some URI set in the definition Currently documented URI identifier:

WSDL : URI of the WSDL as it should be made public
DISCO : URI of the DISCO as it should be made public
doc : URI of the documentation page
service: Base URI of the service

Access: public

Parameters:

string\|array	`$name`	—	URI identifier or array of URI
string	`$URI`	—

[ Top ]

_parseDocBlock [line 497]

array _parseDocBlock(
string
$comments)

Parses a docblock comment

Throws: Services_Webservice_Definition_InvalidDocCommentException
Access: protected

Parameters:

string $comments —

[ Top ]

__call [line 248]

string __call(
string
$name, array
$arg)

Returns web service definition in requested format

Catch-all for toWSDL(), toHTML() and toDISCO()

Throws: Services_Webservice_Definition_Exception
Throws: Services_Webservice_Definition_UnknownFormatException
Access: public

Parameters:

string	`$name`	—	method's name being actually called
array	`$arg`	—

[ Top ]

Class: Services_Webservice_Definition

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$description =

$namespace =

$_classname =

$_hiddenMethods =

$_simpleTypes = array(
        'string', 'int', 'float', 'bool', 'double', 'integer', 'boolean',
        'varstring', 'varint', 'varfloat', 'varbool', 'vardouble',
        'varinteger', 'varboolean')

$_URI = array()

$_wsdlStruct =

Method Detail

__construct (Constructor) [line 115]

Parameters:

classMethodsIntoStruct [line 378]

classPropertiesIntoStruct [line 299]

Parameters:

classStructDispatch [line 269]

getClassName [line 182]

getStruct [line 168]

getURI [line 224]

Parameters:

intoStruct [line 150]

isMethodExposed [line 583]

Parameters:

setURI [line 203]

Parameters:

_parseDocBlock [line 497]

Parameters:

__call [line 248]

Parameters:

Class: Services_Webservice_Definition

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$description =

$namespace =

$_classname =

$_hiddenMethods =

$_simpleTypes = array( 'string', 'int', 'float', 'bool', 'double', 'integer', 'boolean', 'varstring', 'varint', 'varfloat', 'varbool', 'vardouble', 'varinteger', 'varboolean')

$_URI = array()

$_wsdlStruct =

Method Detail

__construct (Constructor) [line 115]

Parameters:

classMethodsIntoStruct [line 378]

classPropertiesIntoStruct [line 299]

Parameters:

classStructDispatch [line 269]

getClassName [line 182]

getStruct [line 168]

getURI [line 224]

Parameters:

intoStruct [line 150]

isMethodExposed [line 583]

Parameters:

setURI [line 203]

Parameters:

_parseDocBlock [line 497]

Parameters:

__call [line 248]

Parameters:

$_simpleTypes = array(
'string', 'int', 'float', 'bool', 'double', 'integer', 'boolean',
'varstring', 'varint', 'varfloat', 'varbool', 'vardouble',
'varinteger', 'varboolean')