|
static | insert_share_progress (int $sharetype, int $userid, int $courseid, ?int $cmid=null) |
| Create a new share progress record in the DB.
|
|
static | update_share_progress (int $shareid, int $status, ?string $resourceurl=null) |
| Update the share progress record in the DB.
|
|
|
int const | STATUS_ERROR = 3 |
| The status of the share is 'error'.
|
|
int const | STATUS_IN_PROGRESS = 2 |
| The status of the share is 'in progress'.
|
|
int const | STATUS_SENT = 1 |
| The status of the share is 'sent'.
|
|
int const | TYPE_ACTIVITY = 2 |
| The content being shared is an activity.
|
|
int const | TYPE_COURSE = 1 |
| The content being shared is a course.
|
|
◆ get_allowed_share_statuses()
static core\moodlenet\share_recorder::get_allowed_share_statuses |
( |
| ) |
|
|
staticprotected |
Get all allowed share statuses.
Note that the particular status values aid in sorting.
- Return values
-
◆ get_allowed_share_types()
static core\moodlenet\share_recorder::get_allowed_share_types |
( |
| ) |
|
|
staticprotected |
Get all allowed share types.
- Return values
-
◆ insert_share_progress()
static core\moodlenet\share_recorder::insert_share_progress |
( |
int | $sharetype, |
|
|
int | $userid, |
|
|
int | $courseid, |
|
|
?int | $cmid = null ) |
|
static |
Create a new share progress record in the DB.
- Parameters
-
int | $sharetype | The type of share (e.g. TYPE_COURSE). |
int | $userid | The ID of the user performing the share. |
int | $courseid | The associated course id. |
int | null | $cmid | The associated course module id (when sharing activity). |
- Return values
-
int | Returns the inserted record id. |
◆ update_share_progress()
static core\moodlenet\share_recorder::update_share_progress |
( |
int | $shareid, |
|
|
int | $status, |
|
|
?string | $resourceurl = null ) |
|
static |
Update the share progress record in the DB.
- Parameters
-
int | $shareid | The id of the share progress row being updated. |
int | $status | The status of the share progress (e.g. STATUS_SENT). |
string | null | $resourceurl | The resource url returned from MoodleNet. |
The documentation for this class was generated from the following file:
- lib/classes/moodlenet/share_recorder.php