Procedural File: services.inc.php

Source Location: /plugins/staticpages/services.inc.php

Page Details:

Functions related to the webservices and the internal plugin API

STATICPAGE_MAX_ID_LENGTH = 40

Max. length of the ID for a static page.

This must be kept in sync with the actual size of 'sp_id' in the db.

[ Top ]

int service_delete_staticpages(
array $args, string &$output, string &$svc_msg)

Delete an existing static page

return:

Response code as defined in lib-plugins.php

array	$args	args Contains all the data provided by the client
string	&$output	&output OUTPUT parameter containing the returned text
string	&$svc_msg	&svc_msg OUTPUT parameter containing any service messages

[ Top ]

int service_getTopicList_staticpages(
array $args, string &$output,  &$svc_msg)

Get all the topics available

return:

Response code as defined in lib-plugins.php

array	$args	args Contains all the data provided by the client
string	&$output	&output OUTPUT parameter containing the returned text
	&$svc_msg

[ Top ]

int service_get_staticpages(
array $args, string &$output, string &$svc_msg)

Get an existing static page

return:

Response code as defined in lib-plugins.php

array	$args	args Contains all the data provided by the client
string	&$output	&output OUTPUT parameter containing the returned text
string	&$svc_msg	&svc_msg OUTPUT parameter containing any service messages

[ Top ]

int service_submit_staticpages(
array $args, string &$output, string &$svc_msg)

Submit static page. The page is updated if it exists, or a new one is created

return:

Response code as defined in lib-plugins.php

array	$args	args Contains all the data provided by the client
string	&$output	&output OUTPUT parameter containing the returned text
string	&$svc_msg	&svc_msg OUTPUT parameter containing any service messages

[ Top ]

Documentation generated on Sat, 11 Feb 2012 02:08:57 -0500 by phpDocumentor 1.4.3