[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/admin/tool/installaddon/classes/ -> pluginfo_client.php (summary)

Provides tool_installaddon_pluginfo_client and related classes

Copyright: 2013 David Mudrak <[email protected]>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 209 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

tool_installaddon_pluginfo_client:: (9 methods):
  instance()
  get_pluginfo()
  __construct()
  call_service()
  service_request_url()
  service_request_params()
  service_request_options()
  decode_response()
  validate_response()

tool_installaddon_pluginfo_exception:: (1 method):
  __construct()


Class: tool_installaddon_pluginfo_client  - X-Ref

Implements a client for https://download.moodle.org/api/x.y/pluginfo.php service

instance()   X-Ref
Factory method returning an instance of this class.

return: tool_installaddon_pluginfo_client

get_pluginfo($component, $version)   X-Ref
Return the information about the plugin

param: string $component
param: string $version
return: stdClass the pluginfo structure

__construct()   X-Ref


call_service($component, $version)   X-Ref
Calls the pluginfo.php service and returns the raw response

param: string $component
param: string $version
return: string

service_request_url()   X-Ref
Return URL to the pluginfo.php service

return: moodle_url

service_request_params($component, $version)   X-Ref
Return list of pluginfo service parameters

param: string $component
param: string $version
return: array

service_request_options()   X-Ref
Return cURL options for the service request

return: array of (string)param => (string)value

decode_response($raw)   X-Ref
Decode the raw service response

param: string $raw
return: stdClass

validate_response($response)   X-Ref
Validate decoded service response

param: stdClass $response

Class: tool_installaddon_pluginfo_exception  - X-Ref

General exception thrown by {@link tool_installaddon_pluginfo_client} class

__construct($errorcode, $a=null, $debuginfo=null)   X-Ref

param: string $errorcode exception description identifier
param: mixed $debuginfo debugging data to display



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