Procedural File: archive_xmlrpc.php

Source Location: /mplf/archive_xmlrpc.php

Page Details:

An XML-RPC interface to the online filter archive system of the MultiPurpose Log Filter porject.

Tags:

filesource:	Source Code for this file
license:	GNU Lesser General Public License
version:	$Revision: 1.4 $
author:	Andreas Launila

Includes:

require_once('_includes/common.php') [line 19]
For access to common constants and functions.

getCategoryFilters [line 81]

array getCategoryFilters(
integer $method, mixed $params, mixed $app_data)

XML-RPC method for getting all filters contained within a specified category.

Tags:

return:	The filters, each value is another structured array with the following structure 0:id, 1:name, 2:description.
access:	public

Parameters

integer

$method

first The unique directory identifier, 0 means the root directory.

[ Top ]

getFilterContents [line 151]

string getFilterContents(
integer $method, mixed $params, mixed $app_data)

XML-RPC method for getting the contents of a filter.

Tags:

return:	An XML document representing the filter.
access:	public

Parameters

integer

$method

first The unique identifier for the filter.

[ Top ]

getFilterDetails [line 114]

array getFilterDetails(
integer $method, mixed $params, mixed $app_data)

XML-RPC method for getting detailed information about a specified filter.

Tags:

return:	The filter information, the array is structured as follows 0:id, 1:name, 2:description, 3:timeAdded, 4:author, 5:edits. The fifth value is another array with one array for each edit performed. The arrays are structured as follows 0:id, 1:timePerformed, 2:description.
access:	public

Parameters

integer

$method

first The unique identifier for the filter.

[ Top ]

getSubCategories [line 46]

array getSubCategories(
integer $method, mixed $params, mixed $app_data)

XML-RPC method for getting all subcategories of a category.

Tags:

return:	The subcateories, each value is another structured array with the following structure 0:id, 1:name, 2:description.
access:	public

Parameters

integer

$method

first The unique directory identifier, 0 means the root directory.

[ Top ]

suggestChange [line 191]

boolean suggestChange(
integer $method, string $params, string $app_data)

XML-RPC method for suggesting a change of an existing filter.

Tags:

return:	True if the filter was successfully uploaded, false on an error.
access:	public

Parameters

integer	$method	first The unique identifier of the filter to change.
string	$params	second An description of what the change does.
string	$app_data	third The contents of the new modified filter.

[ Top ]

uploadFilter [line 172]

boolean uploadFilter(
string $method, string $params, integer $app_data, string 3)

XML-RPC method for uploading a new filter to the archive.

Tags:

return:	True if the filter was successfully uploaded, false on an error.
access:	public

Parameters

string	3	fourth The author of the filter.
string	$method	first The contents of the filter.
string	$params	second A description of what the filter does.
integer	$app_data	third The unique identifier of the category in which the filter belongs.

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:02:54 +0200 by phpDocumentor 1.3.0RC4