dan-leech/moodle-php-sdk

PHP SDK for Moodle RESTful APIs

v1.0.0 2020-03-13 20:50 UTC

Requires

• zeptech/annotations: 1.1.0

Requires (Dev)

• nesbot/carbon: ~1.21
• phpunit/phpunit: ^5.0
• vlucas/phpdotenv: *

MIT

• Agustín Rodríguez
• Daniil Kostin

README

PHP SDK for Moodle RESTful APIs

Getting Started

1. Install MoodleSDK

   php composer.phar require agurz/moodle-php-sdk
   

2. Create a RestApiContext instance

   $context = new RestApiContext();
   $context->setUrl('example.com/moodle')
           ->setCredential(new AuthTokenCredential('token'))

3. Create a model object instance, set it's properties and call get, create, update, or delete operations

   $user = new User();
   $user->setUsername('username')
        ->setPassword('Password..01')
        ->setFirstName('first')
        ->setLastName('last')
        ->setFullName('first last')
        ->setEmail('[e-mail]')
        ->create($context)

4. That's all!

Usage example

Creating a user and enrolling him into 'test-course' course

<?php

require_once 'vendor/autoload.php';

use MoodleSDK\Api\Model\Course;
use MoodleSDK\Api\Model\User;
use MoodleSDK\Auth\AuthTokenCredential;
use MoodleSDK\Rest\RestApiContext;

$context = RestApiContext::instance()
                         ->setUrl('example.com/moodle')
                         ->setCredential(new AuthTokenCredential('token'))

$user = User::instance()
            ->setUsername('agurz')
            ->setPassword('Password..01')
            ->setFirstName('Agustn')
            ->setLastName('Rodríguez')
            ->setFullName('Agustn Rodríguez')
            ->setEmail('[e-mail]')
            ->create($context);

$course = Course::instance()
                ->setShortName('test-course')
                ->get($context)
                ->enrolUser($context, $user);