API
Class
include/api/api.php
The API class acts as a base class for the various
APIs available in JAS (
CSV,
Data and
XML). You'll generally only use this class when you're creating a new API.
Class variables
mode
Variable
Either: server or client
modes
Variable
Internal list of available modes
version
Variable
Version number of the API
encoding
Variable
Text encoding of the API
contentType (text)
Variable
Content type header output by the API
config (array)
Variable
Configuration
output (text)
Variable
Output of the API
filename (boolean)
Variable
Output filename of the API
commands
Variable
Commands array
requestResponseHeaders
Variable
Contains all request headers
Related topics
Here you'll find an overview of all core PHP code available in JAS as well as the JavaScript code. Most of the core code resides in the include directory. It's typically 1 class...
API :: __constructMethodinclude/api/api.php
Description...
mode = falseArgument
config = falseArgument
InstanceReturns
API class examplePHP<?
$api=new API($mode =...
API :: __cloneMethodinclude/api/api.php
Description...
InstanceReturns
API :: clearMethodinclude/api/api.php
Description...
NothingReturns
API Clear method examplePHP<?
$api->clear(); //Call API::clear method
?>
API :: errorMethodinclude/api/api.php
Description...
BooleanReturns
API Error method examplePHP<?
$api->error(); //Call API::error method
?>
API :: filenameMethodinclude/api/api.php
Description...
filenameArgument
BooleanReturns
API Filename method examplePHP<?
$api->filename($filename); //Call...
API :: outputMethodinclude/api/api.php
Description...
headers = trueArgument
VariableReturns
API Output method examplePHP<?
$api->output($headers = true); ...
API :: parseMethodinclude/api/api.php
Description...
requestArgument
BooleanReturns
API Parse method examplePHP<?
$api->parse($request); //Call API::parse...
API :: enabledMethodinclude/api/api.php
Description...
cmd = falseArgument
module = falseArgument
action = falseArgument
extra = falseArgument
BooleanReturns
API Enabled met...
API :: addDataMethodinclude/api/api.php
Description...
data (reference)Argument
count = falseArgument
FunctionReturns
API AddData method examplePHP<?
$api->addD...
API :: setDataMethodinclude/api/api.php
Description...
nrArgument
data (reference)Argument
count = falseArgument
BooleanReturns
API SetData method examplePHP<?
$ap...
API :: addLanguageMethodinclude/api/api.php
Description...
setArgument
langArgument
language = falseArgument
FunctionReturns
API AddLanguage method examplePHP<?
$a...
API :: setLanguageMethodinclude/api/api.php
Description...
nrArgument
setArgument
langArgument
language = falseArgument
BooleanReturns
API SetLanguage method examplePHP<?...
API :: addModulesMethodinclude/api/api.php
Description...
modules = falseArgument
all = falseArgument
FunctionReturns
API AddModules method examplePHP<?
$api->a...
API :: setModulesMethodinclude/api/api.php
Description...
nrArgument
modules = falseArgument
all = falseArgument
BooleanReturns
API SetModules method examplePHP<?
...
API :: mergeModulesMethodinclude/api/api.php
Description...
d (reference)Argument
BooleanReturns
API MergeModules method examplePHP<?
$api->mergeModules(&$d...
API :: compareModulesMethodinclude/api/api.php
Description...
expected (reference)Argument
received (reference)Argument
VariableReturns
API CompareModules method examplePHP&...
API :: addProjectsMethodinclude/api/api.php
Description...
activate = falseArgument
projects = falseArgument
FunctionReturns
API AddProjects method examplePHP<?
$a...
API :: setProjectsMethodinclude/api/api.php
Description...
nrArgument
activate = falseArgument
projects = falseArgument
BooleanReturns
API SetProjects method examplePHP<?...
API :: deleteCommandMethodinclude/api/api.php
Description...
nrArgument
BooleanReturns
API DeleteCommand method examplePHP<?
$api->deleteCommand($nr); //C...
API :: commandsMethodinclude/api/api.php
Description...
nr = falseArgument
MixedReturns
API Commands method examplePHP<?
$api->commands($nr = false); //Ca...
API :: command_dataMethodinclude/api/api.php
Description...
nrArgument
BooleanReturns
API Command_data method examplePHP<?
$api->command_data($nr); //Call...
API :: command_languageMethodinclude/api/api.php
Description...
nrArgument
BooleanReturns
API Command_language method examplePHP<?
$api->command_language($nr);&...
API :: command_modulesMethodinclude/api/api.php
Description...
nrArgument
BooleanReturns
API Command_modules method examplePHP<?
$api->command_modules($nr);&nbs...
API :: command_projectsMethodinclude/api/api.php
Description...
nrArgument
BooleanReturns
API Command_projects method examplePHP<?
$api->command_projects($nr);&...