Membros públicos | |
| cpaint () | |
| __construct () | |
| initialize ($input_encoding='UTF-8') | |
| start ($input_encoding='UTF-8') | |
| return_data () | |
| register ($func, $alias='', $input=array(), $output=array(), $comment='') | |
| unregister ($func) | |
| & | add_node ($nodename, $id='') |
| set_data ($data) | |
| get_data () | |
| set_id ($id) | |
| get_id () | |
| set_attribute ($name, $value) | |
| get_attribute ($name) | |
| set_name ($name) | |
| get_name () | |
| get_response_type () | |
| setResponseControls ($controls, $elements='') | |
| setResponseScripts ($scripts=array()) | |
| setResponse ($controls, $elements='', $scripts=array()) | |
Campos de Dados | |
| $version = '2.1.0' | |
| $response_type | |
| $basenode | |
| $api_functions | |
| $api_datatypes | |
| $use_wsdl | |
| $arguments | |
| $user_function | |
| $response = NULL | |
Outros membros herdados | |
 Atributos Protegidos herdados de MService | |
| $manager | |
Documentação dos Construtores & Destrutor
◆ __construct()
| __construct | ( | ) |
Documentação das funções
◆ add_node()
| & add_node | ( | $nodename, | |
| $id = '' ) |
registers a complex data type
@access public
- Parâmetros
-
array $schema schema definition for the complex type
- Retorna
- boolean
public function complex_type($schema) { $return_value = false; $schema = (array) $schema;
if ($schema['name'] != '' && in_array($schema['type'], array('restriction', 'complex', 'list'))) {
$this->api_datatypes[] = $schema; $return_value = true; } // end: if
return $return_value; } switches the generation of WSDL on/off. default is on
@access public
- Parâmetros
-
boolean $state state of WSDL generation
- Retorna
- void
public function use_wsdl($state) { $this->use_wsdl = (boolean) $state; } adds a new subnode to the basenode.
will return a reference to it for further processing.
@access public
- Parâmetros
-
string $nodename name of the new node string $id id of the new node
- Retorna
- object
◆ cpaint()
| cpaint | ( | ) |
PHP4 constructor.
@access public
- Retorna
- void
◆ get_attribute()
| get_attribute | ( | $name | ) |
retrieves an attribute of the basenode by name.
@access public
- Parâmetros
-
string $name attribute name
- Retorna
- string
◆ get_data()
| get_data | ( | ) |
returns the data assigned to the basenode.
@access public
- Retorna
- mixed
◆ get_id()
| get_id | ( | ) |
gets the id property of the basenode.
- Retorna
- string
◆ get_name()
| get_name | ( | ) |
get name property of the basenode.
@access public
- Retorna
- string
◆ get_response_type()
| get_response_type | ( | ) |
returns the response type as requested by the client
@access public
- Retorna
- string
◆ initialize()
| initialize | ( | $input_encoding = 'UTF-8' | ) |
initialize arguments and user_function
@access public
- Parâmetros
-
string $input_encoding input data character encoding, default is UTF-8
- Retorna
- void
◆ register()
| register | ( | $func, | |
| $alias = '', | |||
| $input = array(), | |||
| $output = array(), | |||
| $comment = '' ) |
registers a new function or method as part of the CPAINT API
@access public
- Parâmetros
-
mixed $func function name, array(&$object, 'function_name') or array('class', 'function_name') string $alias alias name for the function. Will be used by the frontend. array $input function input parameters (not yet used by CPAINT and subject to change) array $output function output format (not yed used by CPAINT and subject to change) string $comment description of the functionality
- Retorna
- boolean
- Versão
- 1.0.1 16.09.2006 23:07:44 [dstender] Added alias functionality.
◆ return_data()
| return_data | ( | ) |
generates and prints the response based on response type supplied by the frontend.
@access public
- Retorna
- void
◆ set_attribute()
| set_attribute | ( | $name, | |
| $value ) |
adds a new attribute to the basenode.
@access public
- Parâmetros
-
string $name attribute name mixed $value attribute value
- Retorna
- void
◆ set_data()
| set_data | ( | $data | ) |
assigns textual data to the basenode.
@access public
- Parâmetros
-
mixed $data data to assign to this node
- Retorna
- void
◆ set_id()
| set_id | ( | $id | ) |
sets the id property of the basenode.
- Parâmetros
-
string $id the id
- Retorna
- void
◆ set_name()
| set_name | ( | $name | ) |
set name property of the basenode.
@access public
- Parâmetros
-
string $name the name
- Retorna
- void
◆ setResponse()
| setResponse | ( | $controls, | |
| $elements = '', | |||
| $scripts = array() ) |
◆ setResponseControls()
| setResponseControls | ( | $controls, | |
| $elements = '' ) |
prepare response object
@access public
- Retorna
- string
◆ setResponseScripts()
| setResponseScripts | ( | $scripts = array() | ) |
◆ start()
| start | ( | $input_encoding = 'UTF-8' | ) |
calls the user function responsible for this specific call.
@access public
- Parâmetros
-
string $input_encoding input data character encoding, default is UTF-8
- Retorna
- void
◆ unregister()
| unregister | ( | $func | ) |
unregisters a function that is currently part of the CPAINT API.
proves useful when the same set of functions is to be used in the frontend and in some kind of administration environment. you might want to unregister a few (admin) functions for the frontend in this case.
Note that if you supplied an alias when registering a method, you must use the alias to unregister the function / method.
@access public
- Parâmetros
-
string $func function name
- Retorna
- boolean
- Veja também
- cpaint:register()
- Versão
- 1.0.1 16.09.2006 23:10:58 [dstender] Extended PHPDoc for use of aliases.
Documentação dos campos e atributos
◆ $api_datatypes
| array $api_datatypes |
list of registered complex types used in the CPAINT API
@access protected
◆ $api_functions
| array $api_functions |
list of registered methods available through the CPAINT API
@access protected
◆ $arguments
| array $arguments |
arguments send by front-end
@access private
◆ $basenode
| object $basenode |
the basenode ajaxResponse.
@access protected
◆ $response
| string $response = NULL |
response.
@access protected
◆ $response_type
| string $response_type |
response type.
@access protected
◆ $use_wsdl
| boolean $use_wsdl |
whether or not the CPAINT API generates a WSDL when called with ?wsdl querystring
@access private
◆ $user_function
| string $user_function |
user function name
@access private
◆ $version
| string $version = '2.1.0' |
version number
@access private
A documentação para esta classe foi gerada a partir do seguinte ficheiro:
- /var/docker/solisge-devel/www/solisge/miolo25/classes/ui/mcpaint.class.php
