Moodle  2.2.1
http://www.collinsharper.com
registration_manager Class Reference

Public Member Functions

 cron ()
 get_site_secret_for_hub ($huburl)
 add_registeredhub ($hub)
 delete_registeredhub ($huburl)
 get_registeredhub ($huburl=null, $token=null)
 get_unconfirmedhub ($huburl)
 update_registeredhub ($communication)
 get_registered_on_hubs ()
 get_site_info ($huburl)
 get_site_privacy_string ($privacy)

Detailed Description

Definition at line 48 of file lib.php.


Member Function Documentation

add_registeredhub ( hub)

When the site register on a hub, he must call this function

Parameters:
object$hubwhere the site is registered on
Returns:
integer id of the record

Definition at line 119 of file lib.php.

cron ( )

Automatically update the registration on all hubs

Definition at line 53 of file lib.php.

Here is the call graph for this function:

delete_registeredhub ( huburl)

When a site unregister from a hub, he must call this function

Parameters:
string$huburlthe huburl to delete

Definition at line 129 of file lib.php.

Return all hubs where the site is registered on

Definition at line 184 of file lib.php.

Here is the caller graph for this function:

get_registeredhub ( huburl = null,
token = null 
)

Get a hub on which the site is registered for a given url or token Mostly use to check if the site is registered on a specific hub

Parameters:
string$huburl
string$token
Returns:
object the hub

Definition at line 141 of file lib.php.

get_site_info ( huburl)

Return site information for a specific hub

Parameters:
string$huburl
Returns:
array site info

Definition at line 195 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_site_privacy_string ( privacy)

Retrieve the site privacy string matching the define value

Parameters:
string$privacymust match the define into moodlelib.php
Returns:
string

Definition at line 277 of file lib.php.

get_site_secret_for_hub ( huburl)

Return the site secret for a given hub site identifier is assigned to Mooch each hub has a unique and personal site secret.

Parameters:
string$huburl
Returns:
string site secret

Definition at line 94 of file lib.php.

Here is the call graph for this function:

get_unconfirmedhub ( huburl)

Get the hub which has not confirmed that the site is registered on, but for which a request has been sent

Parameters:
string$huburl
Returns:
object the hub

Definition at line 162 of file lib.php.

update_registeredhub ( communication)

Update a registered hub (mostly use to update the confirmation status)

Parameters:
object$communicationthe hub

Definition at line 176 of file lib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations