[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/external/ -> externallib.php (summary)

external API for core library

Copyright: 2012 Jerome Mouneyrac <[email protected]>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 261 lines (10 kb)
Included or required:0 times
Referenced: 4 times
Includes or requires: 0 files

Defines 1 class

core_external:: (10 methods):
  format_string_parameters()
  get_string_parameters()
  get_string()
  get_string_returns()
  get_strings_parameters()
  get_strings()
  get_strings_returns()
  get_component_strings_parameters()
  get_component_strings()
  get_component_strings_returns()


Class: core_external  - X-Ref

Web service related functions

format_string_parameters($stringparams)   X-Ref
Format the received string parameters to be sent to the core get_string() function.

param: array $stringparams
return: object|string

get_string_parameters()   X-Ref
Returns description of get_string parameters

return: external_function_parameters

get_string($stringid, $component = 'moodle', $stringparams = array()   X-Ref
Return a core get_string() call

param: string $identifier string identifier
param: string $component string component
param: array $stringparams the string params
return: string

get_string_returns()   X-Ref
Returns description of get_string() result value

return: string

get_strings_parameters()   X-Ref
Returns description of get_string parameters

return: external_function_parameters

get_strings($strings)   X-Ref
Return multiple call to core get_string()

param: array $strings strings to translate
return: array

get_strings_returns()   X-Ref
Returns description of get_string() result value

return: array

get_component_strings_parameters()   X-Ref
Returns description of get_component_strings parameters

return: external_function_parameters

get_component_strings($component, $lang = null)   X-Ref
Return all lang strings of a component - call to core get_component_strings().

param: string $component component name
return: array

get_component_strings_returns()   X-Ref
Returns description of get_component_strings() result value

return: array



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1