├── .gitignore
├── tests
    ├── config.php.example
    ├── MoodleTestCase.php
    └── services
    │   └── CourseTest.php
├── phpunit.xml.example
├── src
    ├── Entities
    │   ├── SummaryFormatType.php
    │   ├── CourseCollection.php
    │   ├── Entity.php
    │   ├── Dto
    │   │   └── Course.php
    │   └── Course.php
    ├── Clients
    │   ├── ClientAdapterInterface.php
    │   ├── Adapters
    │   │   ├── SoapClient.php
    │   │   └── RestClient.php
    │   └── BaseAdapter.php
    ├── Exceptions
    │   └── ApiException.php
    ├── GenericCollection.php
    ├── Connection.php
    └── Services
    │   ├── Service.php
    │   └── Course.php
├── composer.json
├── LICENSE
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /phpunit.xml
3 | /tests/config.php
4 | .idea


--------------------------------------------------------------------------------
/tests/config.php.example:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | return [
4 |     'connection' => [
5 |         'url'   => '',
6 |         'token' => '',
7 |     ],
8 | ];
9 | 


--------------------------------------------------------------------------------
/phpunit.xml.example:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <phpunit bootstrap="vendor/autoload.php" colors="true">
3 |     <testsuites>
4 |         <testsuite name="Main">
5 |             <directory>tests</directory>
6 |         </testsuite>
7 |     </testsuites>
8 | </phpunit>
9 | 


--------------------------------------------------------------------------------
/src/Entities/SummaryFormatType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Entities;
 4 | 
 5 | /**
 6 |  * Class SummaryFormatType
 7 |  * @package Ozq\MoodleClient\Entities
 8 |  */
 9 | class SummaryFormatType
10 | {
11 |     const TYPE_MOODLE = 0;
12 |     const TYPE_HTML = 1;
13 |     const TYPE_PLAIN = 2;
14 |     const TYPE_MARKDOWN = 4;
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Clients/ClientAdapterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Clients;
 4 | 
 5 | /**
 6 |  * Interface ClientAdapterInterface
 7 |  * @package Ozq\MoodleClient\Clients
 8 |  */
 9 | interface ClientAdapterInterface
10 | {
11 |     /**
12 |      * Send API request
13 |      * @param $function
14 |      * @param array $arguments
15 |      * @return mixed
16 |      */
17 |     public function sendRequest($function, array $arguments = []);
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Exceptions/ApiException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | /**
 8 |  * Class ApiException
 9 |  * @package Ozq\MoodleClient\Exceptions
10 |  */
11 | class ApiException extends Exception
12 | {
13 |     const ERROR_CODE_INVALID_TOKEN = 'invalidtoken';
14 |     const ERROR_CODE_REGISTRATION_DISABLED = 'registrationdisabled';
15 |     const ERROR_CODE_ACCESS_EXCEPTION = 'accessexception';
16 | 
17 |     //TODO: add logic for API exceptions!
18 | }
19 | 


--------------------------------------------------------------------------------
/src/GenericCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient;
 4 | 
 5 | use IteratorAggregate;
 6 | use ArrayIterator;
 7 | 
 8 | /**
 9 |  * Class GenericCollection
10 |  * @package Ozq\MoodleClient\Entities
11 |  */
12 | abstract class GenericCollection implements IteratorAggregate
13 | {
14 |     /**
15 |      * @var array
16 |      */
17 |     protected $items;
18 | 
19 |     /**
20 |      * Get collection items
21 |      * @return array
22 |      */
23 |     public function toArray()
24 |     {
25 |         return $this->items;
26 |     }
27 | 
28 |     /**
29 |      * Get iterator
30 |      * @return ArrayIterator
31 |      */
32 |     public function getIterator()
33 |     {
34 |         return new ArrayIterator($this->items);
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "ozq/moodle-client",
 3 |     "description": "Moodle client",
 4 |     "license": "MIT",
 5 |     "version": "1.0.0",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Sergey Volkov"
 9 |         }
10 |     ],
11 |     "minimum-stability": "dev",
12 |     "prefer-stable": true,
13 |     "require": {
14 |         "guzzlehttp/guzzle": "5.x",
15 |         "beberlei/assert": "2.7.x"
16 |     },
17 |     "require-dev": {
18 |         "phpunit/phpunit": "5.x"
19 |     },
20 |     "autoload": {
21 |         "psr-4": {
22 |             "Ozq\\MoodleClient\\": "src/"
23 |         }
24 |     },
25 |     "autoload-dev": {
26 |         "psr-4": {
27 |             "Ozq\\MoodleClient\\Tests\\": "tests/"
28 |         }
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/tests/MoodleTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Tests;
 4 | 
 5 | use Ozq\MoodleClient\Connection;
 6 | use PHPUnit\Framework\TestCase;
 7 | 
 8 | /**
 9 |  * Class MoodleTestCase
10 |  * @package Ozq\MoodleClient\Tests
11 |  */
12 | class MoodleTestCase extends TestCase
13 | {
14 |     /**
15 |      * @var array
16 |      */
17 |     private $config = [];
18 | 
19 |     /**
20 |      * @var Connection
21 |      */
22 |     private $connection;
23 | 
24 |     /**
25 |      * Setup TestCase
26 |      */
27 |     public function setUp()
28 |     {
29 |         $this->config = require('config.php');
30 |         $this->connection = new Connection($this->config['connection']['url'], $this->config['connection']['token']);
31 |     }
32 | 
33 |     /**
34 |      * @return array|mixed
35 |      */
36 |     public function getConfig()
37 |     {
38 |         return $this->config;
39 |     }
40 | 
41 |     /**
42 |      * @return Connection
43 |      */
44 |     public function getConnection()
45 |     {
46 |         return $this->connection;
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Entities/CourseCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Entities;
 4 | 
 5 | use Ozq\MoodleClient\GenericCollection;
 6 | 
 7 | /**
 8 |  * Class CourseCollection
 9 |  * @package Ozq\MoodleClient\Entities
10 |  */
11 | class CourseCollection extends GenericCollection
12 | {
13 |     /**
14 |      * CourseCollection constructor.
15 |      * @param Course[] ...$courses
16 |      */
17 |     public function __construct(Course ...$courses)
18 |     {
19 |         $this->items = $courses;
20 |     }
21 | 
22 |     /**
23 |      * Add course to collection
24 |      * @param Course $item
25 |      */
26 |     public function add(Course $item)
27 |     {
28 |         $this->items[$item->id] = $item;
29 |     }
30 | 
31 |     /**
32 |      * Remove course from collection
33 |      * @param Course|integer $course
34 |      */
35 |     public function remove($course)
36 |     {
37 |         $id = ($course instanceof Course) ? $course->id : $course;
38 |         if (array_key_exists($id, $this->items)) {
39 |             unset($this->items[$id]);
40 |         }
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 Sergey Volkov
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/Connection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient;
 4 | 
 5 | use Assert\Assertion;
 6 | 
 7 | /**
 8 |  * Class Connection
 9 |  * @package Ozq\MoodleClient
10 |  */
11 | class Connection
12 | {
13 |     /**
14 |      * @var string
15 |      */
16 |     protected $url;
17 | 
18 |     /**
19 |      * @var string
20 |      */
21 |     protected $token;
22 | 
23 |     /**
24 |      * Connection constructor.
25 |      * @param string $url
26 |      * @param string $token
27 |      */
28 |     public function __construct($url, $token)
29 |     {
30 |         $this->setUrl($url);
31 |         $this->token = $token;
32 |     }
33 | 
34 |     /**
35 |      * Set URL
36 |      * @param string $url
37 |      */
38 |     protected function setUrl($url)
39 |     {
40 |         Assertion::url($url);
41 |         $this->url = trim($url, '/');
42 |     }
43 | 
44 |     /**
45 |      * Get URL
46 |      * @return string
47 |      */
48 |     public function getUrl()
49 |     {
50 |         return $this->url;
51 |     }
52 | 
53 |     /**
54 |      * Get token
55 |      * @return string
56 |      */
57 |     public function getToken()
58 |     {
59 |         return $this->token;
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/src/Clients/Adapters/SoapClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Clients\Adapters;
 4 | 
 5 | use Ozq\MoodleClient\Clients\BaseAdapter;
 6 | use \SoapClient as BaseSoapClient;
 7 | 
 8 | /**
 9 |  * Class SoapClient
10 |  * @package Ozq\MoodleClient\Clients\Adapters
11 |  *
12 |  * @method BaseSoapClient getClient()
13 |  */
14 | class SoapClient extends BaseAdapter
15 | {
16 |     const OPTION_WSDL = 'wsdl';
17 | 
18 |     /**
19 |      * Send API request
20 |      * @param $function
21 |      * @param array $arguments
22 |      * @return mixed
23 |      */
24 |     public function sendRequest($function, array $arguments = [])
25 |     {
26 |         $response = $this->getClient()->__soapCall($function, $arguments);
27 | 
28 |         $this->handleException($response);
29 | 
30 |         return $response;
31 |     }
32 | 
33 |     /**
34 |      * Build client instance
35 |      * @return BaseSoapClient
36 |      */
37 |     protected function buildClient()
38 |     {
39 |         $endPoint = $this->getEndPoint([
40 |             self::OPTION_WSDL  => 1,
41 |             self::OPTION_TOKEN => $this->getConnection()->getToken(),
42 |         ]);
43 | 
44 |         return new BaseSoapClient($endPoint);
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Entities/Entity.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Entities;
 4 | 
 5 | /**
 6 |  * Class Entity
 7 |  * @package Ozq\MoodleClient\Entities
 8 |  */
 9 | abstract class Entity
10 | {
11 |     /**
12 |      * Entity constructor.
13 |      * @param array $data
14 |      */
15 |     public function __construct(array $data = [])
16 |     {
17 |         $this->fill($data);
18 |     }
19 | 
20 |     /**
21 |      * Fill entity properties from array
22 |      * @param array $data
23 |      * @return $this
24 |      */
25 |     public function fill(array $data)
26 |     {
27 |         if (!empty($data)) {
28 |             $properties = $this->getProperties();
29 |             foreach ($properties as $property => $value) {
30 |                 $incomingProperty = strtolower($property);
31 |                 if (array_key_exists($incomingProperty, $data)) {
32 |                     $this->{$property} = $data[$incomingProperty];
33 |                 }
34 |             }
35 |         }
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * Get available entity properties
42 |      * @return array
43 |      */
44 |     public function getProperties()
45 |     {
46 |         return get_object_vars($this);
47 |     }
48 | 
49 |     /**
50 |      * Convert entity to array
51 |      * @return array
52 |      */
53 |     public function toArray()
54 |     {
55 |         return (array)$this;
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Services/Service.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Services;
 4 | 
 5 | use Ozq\MoodleClient\Clients\ClientAdapterInterface;
 6 | use Ozq\MoodleClient\Entities\Entity;
 7 | use ReflectionClass;
 8 | 
 9 | /**
10 |  * Class Service
11 |  * @package Ozq\MoodleClient\Services
12 |  */
13 | abstract class Service
14 | {
15 |     /**
16 |      * @var ClientAdapterInterface
17 |      */
18 |     private $client;
19 | 
20 |     /**
21 |      * Service constructor.
22 |      * @param ClientAdapterInterface $client
23 |      */
24 |     public function __construct(ClientAdapterInterface $client)
25 |     {
26 |         $this->client = $client;
27 |     }
28 | 
29 |     /**
30 |      * Get service alias
31 |      * @return string
32 |      */
33 |     public function getAlias()
34 |     {
35 |         $reflectionClass = new ReflectionClass(static::class);
36 |         return strtolower($reflectionClass->getShortName());
37 |     }
38 | 
39 |     /**
40 |      * Get array of converted to arrays entities
41 |      * Each entity data contains only filled entity properties
42 |      * @param Entity[] ...$entities
43 |      * @return array
44 |      */
45 |     protected function prepareEntityForSending(Entity ...$entities)
46 |     {
47 |         $convertedEntities = [];
48 | 
49 |         foreach ($entities as $entity) {
50 |             $filledData = [];
51 |             $entityData = $entity->toArray();
52 |             foreach ($entityData as $property => $value) {
53 |                 if (!empty($value)) {
54 |                     $filledData[strtolower($property)] = $value;
55 |                 }
56 |             }
57 | 
58 |             $convertedEntities[] = $filledData;
59 |         }
60 | 
61 |         return $convertedEntities;
62 |     }
63 | 
64 |     /**
65 |      * Send API request
66 |      * @param $function
67 |      * @param array $arguments
68 |      * @return array
69 |      */
70 |     final protected function sendRequest($function, array $arguments = [])
71 |     {
72 |         $response = $this->client->sendRequest($function, $arguments);
73 | 
74 |         return (array)$response;
75 |     }
76 | }
77 | 


--------------------------------------------------------------------------------
/src/Clients/Adapters/RestClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Clients\Adapters;
 4 | 
 5 | use Ozq\MoodleClient\Clients\BaseAdapter;
 6 | use Ozq\MoodleClient\Connection;
 7 | use Assert\Assertion;
 8 | use GuzzleHttp\Client as HttpClient;
 9 | 
10 | /**
11 |  * Class RestClient
12 |  * @package Ozq\MoodleClient\Clients
13 |  *
14 |  * @method HttpClient getClient()
15 |  */
16 | class RestClient extends BaseAdapter
17 | {
18 |     const OPTION_FORMAT = 'moodlewsrestformat';
19 |     const RESPONSE_FORMAT_JSON = 'json';
20 |     const RESPONSE_FORMAT_XML = 'xml';
21 | 
22 |     /**
23 |      * @var string
24 |      */
25 |     protected $responseFormat;
26 | 
27 |     /**
28 |      * RestClient constructor.
29 |      * @param Connection $connection
30 |      * @param string $responseFormat
31 |      */
32 |     public function __construct(Connection $connection, $responseFormat = self::RESPONSE_FORMAT_JSON)
33 |     {
34 |         parent::__construct($connection);
35 |         $this->setResponseFormat($responseFormat);
36 |     }
37 | 
38 |     /**
39 |      * Send API request
40 |      * @param $function
41 |      * @param array $arguments
42 |      * @return array|bool|float|int|\SimpleXMLElement|string
43 |      */
44 |     public function sendRequest($function, array $arguments = [])
45 |     {
46 |         $configuration = [
47 |             self::OPTION_FUNCTION => $function,
48 |             self::OPTION_FORMAT   => $this->responseFormat,
49 |             self::OPTION_TOKEN    => $this->getConnection()->getToken(),
50 |         ];
51 | 
52 |         $response = $this->getClient()->post(null, ['body' => array_merge($configuration, $arguments)]);
53 |         $this->handleException($response);
54 | 
55 |         $formattedResponse = $this->responseFormat === self::RESPONSE_FORMAT_JSON ?
56 |             $response->json() :
57 |             $response->xml();
58 | 
59 |         return $formattedResponse;
60 |     }
61 | 
62 |     /**
63 |      * Build client instance
64 |      * @return HttpClient
65 |      */
66 |     protected function buildClient()
67 |     {
68 |         return new HttpClient(['base_url' => $this->getEndPoint()]);
69 |     }
70 | 
71 |     /**
72 |      * Set response format
73 |      * @param string $format
74 |      */
75 |     protected function setResponseFormat($format)
76 |     {
77 |         Assertion::inArray($format, [self::RESPONSE_FORMAT_JSON, self::RESPONSE_FORMAT_XML]);
78 |         $this->responseFormat = $format;
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/Services/Course.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Ozq\MoodleClient\Services;
 4 | 
 5 | use Ozq\MoodleClient\Entities\Course as CourseItem;
 6 | use Ozq\MoodleClient\Entities\Dto\Course as CourseDto;
 7 | use Ozq\MoodleClient\Entities\CourseCollection;
 8 | 
 9 | /**
10 |  * Class Course
11 |  * @package Ozq\MoodleClient\Services
12 |  */
13 | class Course extends Service
14 | {
15 |     /**
16 |      * Get all courses by ids
17 |      * @param array $ids
18 |      * @return CourseCollection
19 |      */
20 |     public function getAll(array $ids = [])
21 |     {
22 |         $response = $this->sendRequest('core_course_get_courses', ['options' => ['ids' => $ids]]);
23 | 
24 |         return $this->getCourseCollection($response);
25 |     }
26 | 
27 |     /**
28 |      * Get course by field
29 |      * @param $field
30 |      * @param $value
31 |      * @return CourseCollection
32 |      */
33 |     public function getByField($field, $value)
34 |     {
35 |         $arguments = [
36 |             'field' => $field,
37 |             'value' => $value,
38 |         ];
39 | 
40 |         $response = $this->sendRequest('core_course_get_courses_by_field', $arguments);
41 | 
42 |         return $this->getCourseCollection($response['courses']);
43 |     }
44 | 
45 |     /**
46 |      * Create new course
47 |      * @param \Ozq\MoodleClient\Entities\Dto\Course[] ...$courses
48 |      * @return CourseCollection
49 |      */
50 |     public function create(CourseDto ...$courses)
51 |     {
52 |         $response = $this->sendRequest(
53 |             'core_course_create_courses',
54 |             [
55 |                 'courses' => $this->prepareEntityForSending(...$courses)
56 |             ]
57 |         );
58 | 
59 |         return $this->getCourseCollection($response);
60 |     }
61 | 
62 |     /**
63 |      * Delete courses by ids
64 |      * @param array $ids
65 |      * @return mixed
66 |      */
67 |     public function delete(array $ids = [])
68 |     {
69 |         $response = $this->sendRequest('core_course_delete_courses', ['courseids' => $ids]);
70 | 
71 |         return $response;
72 |     }
73 | 
74 |     /**
75 |      * Get course collection by course array
76 |      * @param array $courses
77 |      * @return CourseCollection
78 |      */
79 |     protected function getCourseCollection(array $courses)
80 |     {
81 |         $courseItems = [];
82 |         foreach ($courses as $courseItem) {
83 |             $courseItems[] = new CourseItem($courseItem);
84 |         }
85 | 
86 |         return new CourseCollection(...$courseItems);
87 |     }
88 | }
89 | 


--------------------------------------------------------------------------------
/src/Entities/Dto/Course.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Ozq\MoodleClient\Entities\Dto;
  4 | 
  5 | use Ozq\MoodleClient\Entities\Entity;
  6 | 
  7 | /**
  8 |  * Class Course
  9 |  * @package Ozq\MoodleClient\Entities\Dto
 10 |  */
 11 | class Course extends Entity
 12 | {
 13 |     /**
 14 |      * @var string
 15 |      */
 16 |     public $shortName;
 17 | 
 18 |     /**
 19 |      * @var integer
 20 |      */
 21 |     public $categoryId;
 22 | 
 23 |     /**
 24 |      * @var string
 25 |      */
 26 |     public $fullName;
 27 | 
 28 |     /**
 29 |      * @var integer
 30 |      */
 31 |     public $idNumber;
 32 | 
 33 |     /**
 34 |      * @var string
 35 |      */
 36 |     public $summary;
 37 | 
 38 |     /**
 39 |      * Summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
 40 |      * @var integer
 41 |      */
 42 |     public $summaryFormat;
 43 | 
 44 |     /**
 45 |      * Course format: weeks, topics, social, site, etc...
 46 |      * @var string
 47 |      */
 48 |     public $format;
 49 | 
 50 |     /**
 51 |      * If grades are shown
 52 |      * @var integer
 53 |      */
 54 |     public $showGrades;
 55 | 
 56 |     /**
 57 |      * Number of recent items appearing on the course page
 58 |      * @var integer
 59 |      */
 60 |     public $newsItems;
 61 | 
 62 |     /**
 63 |      * Timestamp when the course start
 64 |      * @var integer
 65 |      */
 66 |     public $startDate;
 67 | 
 68 |     /**
 69 |      * Timestamp when the course end
 70 |      * @var integer
 71 |      */
 72 |     public $endDate;
 73 | 
 74 |     /**
 75 |      * @var integer
 76 |      */
 77 |     public $numSections;
 78 | 
 79 |     /**
 80 |      * Largest size of file that can be uploaded into the course
 81 |      * @var integer
 82 |      */
 83 |     public $maxBytes;
 84 | 
 85 |     /**
 86 |      * Are activity report shown
 87 |      * @var integer
 88 |      */
 89 |     public $showReports;
 90 | 
 91 |     /**
 92 |      * Is course available for students
 93 |      * @var integer
 94 |      */
 95 |     public $visible;
 96 | 
 97 |     /**
 98 |      * @var integer
 99 |      */
100 |     public $groupMode;
101 | 
102 |     /**
103 |      * @var integer
104 |      */
105 |     public $groupModeForce;
106 | 
107 |     /**
108 |      * @var integer
109 |      */
110 |     public $defaultGroupingId;
111 | 
112 |     /**
113 |      * @var integer
114 |      */
115 |     public $enableCompletion;
116 | 
117 |     /**
118 |      * @var integer
119 |      */
120 |     public $completionNotify;
121 | 
122 |     /**
123 |      * @var string
124 |      */
125 |     public $lang;
126 | 
127 |     /**
128 |      * @var string
129 |      */
130 |     public $forceTheme;
131 | 
132 |     /**
133 |      * @var array
134 |      */
135 |     public $courseFormatOptions = [];
136 | }
137 | 


--------------------------------------------------------------------------------
/src/Entities/Course.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Ozq\MoodleClient\Entities;
  4 | 
  5 | /**
  6 |  * Class Course
  7 |  * @package Ozq\MoodleClient\Entities
  8 |  */
  9 | class Course extends Entity
 10 | {
 11 |     /**
 12 |      * @var integer
 13 |      */
 14 |     public $id;
 15 | 
 16 |     /**
 17 |      * @var string
 18 |      */
 19 |     public $shortName;
 20 | 
 21 |     /**
 22 |      * @var integer
 23 |      */
 24 |     public $categoryId;
 25 | 
 26 |     /**
 27 |      * @var integer
 28 |      */
 29 |     public $categorySortOrder;
 30 | 
 31 |     /**
 32 |      * @var string
 33 |      */
 34 |     public $fullName;
 35 | 
 36 |     /**
 37 |      * @var string
 38 |      */
 39 |     public $displayName;
 40 | 
 41 |     /**
 42 |      * @var integer
 43 |      */
 44 |     public $idNumber;
 45 | 
 46 |     /**
 47 |      * @var string
 48 |      */
 49 |     public $summary;
 50 | 
 51 |     /**
 52 |      * Summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
 53 |      * @var integer
 54 |      */
 55 |     public $summaryFormat;
 56 | 
 57 |     /**
 58 |      * Course format: weeks, topics, social, site, etc...
 59 |      * @var string
 60 |      */
 61 |     public $format;
 62 | 
 63 |     /**
 64 |      * If grades are shown
 65 |      * @var integer
 66 |      */
 67 |     public $showGrades;
 68 | 
 69 |     /**
 70 |      * Number of recent items appearing on the course page
 71 |      * @var integer
 72 |      */
 73 |     public $newsItems;
 74 | 
 75 |     /**
 76 |      * Timestamp when the course start
 77 |      * @var integer
 78 |      */
 79 |     public $startDate;
 80 | 
 81 |     /**
 82 |      * Timestamp when the course end
 83 |      * @var integer
 84 |      */
 85 |     public $endDate;
 86 | 
 87 |     /**
 88 |      * @var integer
 89 |      */
 90 |     public $numSections;
 91 | 
 92 |     /**
 93 |      * Largest size of file that can be uploaded into the course
 94 |      * @var integer
 95 |      */
 96 |     public $maxBytes;
 97 | 
 98 |     /**
 99 |      * Are activity report shown
100 |      * @var integer
101 |      */
102 |     public $showReports;
103 | 
104 |     /**
105 |      * Is course available for students
106 |      * @var integer
107 |      */
108 |     public $visible;
109 | 
110 |     /**
111 |      * @var integer
112 |      */
113 |     public $groupMode;
114 | 
115 |     /**
116 |      * @var integer
117 |      */
118 |     public $groupModeForce;
119 | 
120 |     /**
121 |      * @var integer
122 |      */
123 |     public $defaultGroupingId;
124 | 
125 |     /**
126 |      * @var integer
127 |      */
128 |     public $timeCreated;
129 | 
130 |     /**
131 |      * @var integer
132 |      */
133 |     public $timeModified;
134 | 
135 |     /**
136 |      * @var integer
137 |      */
138 |     public $enableCompletion;
139 | 
140 |     /**
141 |      * @var integer
142 |      */
143 |     public $completionNotify;
144 | 
145 |     /**
146 |      * @var string
147 |      */
148 |     public $lang;
149 | 
150 |     /**
151 |      * @var string
152 |      */
153 |     public $forceTheme;
154 | 
155 |     /**
156 |      * @var array
157 |      */
158 |     public $courseFormatOptions = [];
159 | }
160 | 


--------------------------------------------------------------------------------
/src/Clients/BaseAdapter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Ozq\MoodleClient\Clients;
  4 | 
  5 | use Ozq\MoodleClient\Connection;
  6 | use Ozq\MoodleClient\Exceptions\ApiException;
  7 | use ReflectionClass;
  8 | 
  9 | /**
 10 |  * Class BaseAdapter
 11 |  * @package Ozq\MoodleClient\Clients
 12 |  */
 13 | abstract class BaseAdapter implements ClientAdapterInterface
 14 | {
 15 |     const SERVER_SCRIPT_PATH_TEMPLATE = 'webservice/%s/server.php';
 16 |     const OPTION_TOKEN = 'wstoken';
 17 |     const OPTION_FUNCTION = 'wsfunction';
 18 | 
 19 |     /**
 20 |      * @var Connection
 21 |      */
 22 |     private $connection;
 23 | 
 24 |     /**
 25 |      * @var mixed
 26 |      */
 27 |     protected $client;
 28 | 
 29 |     /**
 30 |      * Build client instance
 31 |      * @return mixed
 32 |      */
 33 |     abstract protected function buildClient();
 34 | 
 35 |     /**
 36 |      * Client constructor.
 37 |      * @param Connection $connection
 38 |      */
 39 |     public function __construct(Connection $connection)
 40 |     {
 41 |         $this->connection = $connection;
 42 |         $this->client = $this->buildClient();
 43 |     }
 44 | 
 45 |     /**
 46 |      * Get client
 47 |      * @return mixed
 48 |      */
 49 |     protected function getClient()
 50 |     {
 51 |         return $this->client;
 52 |     }
 53 | 
 54 |     /**
 55 |      * Get connection
 56 |      * @return Connection
 57 |      */
 58 |     protected function getConnection()
 59 |     {
 60 |         return $this->connection;
 61 |     }
 62 | 
 63 |     /**
 64 |      * Get endpoint
 65 |      * @param array $options
 66 |      * @return string
 67 |      */
 68 |     protected function getEndPoint(array $options = [])
 69 |     {
 70 |         $url = $this->connection->getUrl() . '/' . $this->getScriptPath();
 71 | 
 72 |         return $options ? $url . '?' . http_build_query($options) : $url;
 73 |     }
 74 | 
 75 |     /**
 76 |      * Get client script path depends on protocol type
 77 |      * @return string
 78 |      */
 79 |     protected function getScriptPath()
 80 |     {
 81 |         return sprintf(self::SERVER_SCRIPT_PATH_TEMPLATE, $this->getProtocolType());
 82 |     }
 83 | 
 84 |     /**
 85 |      * Get client protocol type
 86 |      * @return string
 87 |      */
 88 |     protected function getProtocolType()
 89 |     {
 90 |         return $this->recognizeClientType();
 91 |     }
 92 | 
 93 |     /**
 94 |      * Recognize client type by client class name
 95 |      * @return string
 96 |      */
 97 |     protected function recognizeClientType()
 98 |     {
 99 |         $reflectionClass = new ReflectionClass(static::class);
100 |         return str_replace('client', '', strtolower($reflectionClass->getShortName()));
101 |     }
102 | 
103 |     /**
104 |      * Check if response contains exceptions
105 |      * @param mixed $response
106 |      * @throws ApiException
107 |      */
108 |     protected function handleException($response)
109 |     {
110 |         //TODO: convert response to array!
111 | 
112 |         if (array_key_exists('exception', $response)) {
113 |             throw new ApiException($response['errorcode'] . ': ' . $response['message']);
114 |         }
115 |     }
116 | }
117 | 


--------------------------------------------------------------------------------
/tests/services/CourseTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Ozq\MoodleClient\Tests\Services;
  4 | 
  5 | use Ozq\MoodleClient\Clients\Adapters\RestClient;
  6 | use Ozq\MoodleClient\Clients\ClientAdapterInterface;
  7 | use Ozq\MoodleClient\Services\Course;
  8 | use Ozq\MoodleClient\Tests\MoodleTestCase;
  9 | use Ozq\MoodleClient\Entities\CourseCollection;
 10 | use Ozq\MoodleClient\Entities\Dto\Course as CourseDto;
 11 | use Ozq\MoodleClient\Entities\Course as CourseEntity;
 12 | 
 13 | /**
 14 |  * Class CourseTest
 15 |  * @package Ozq\MoodleClient\Tests\Services
 16 |  */
 17 | class CourseTest extends MoodleTestCase
 18 | {
 19 |     /**
 20 |      * @var ClientAdapterInterface
 21 |      */
 22 |     protected $client;
 23 | 
 24 |     /**
 25 |      * @var Course
 26 |      */
 27 |     protected $service;
 28 | 
 29 |     public function setUp()
 30 |     {
 31 |         parent::setUp();
 32 | 
 33 |         $this->client = new RestClient($this->getConnection());
 34 |         $this->service = new Course($this->client);
 35 |     }
 36 | 
 37 |     public function testGetAll()
 38 |     {
 39 |         $allCourses = $this->service->getAll();
 40 | 
 41 |         $courseDto = new CourseDto();
 42 |         $properties = $courseDto->getProperties();
 43 | 
 44 |         /** @var CourseEntity $course */
 45 |         foreach ($allCourses->toArray() as $course) {
 46 |             foreach ($properties as $property => $value) {
 47 |                 $courseData = $course->toArray();
 48 |                 $this->assertArrayHasKey($property, $courseData);
 49 |             }
 50 |         }
 51 |     }
 52 | 
 53 |     /**
 54 |      * @return CourseCollection
 55 |      */
 56 |     public function testCreate()
 57 |     {
 58 |         $courseDto = $this->buildCourse();
 59 |         $createdCourses = $this->service->create($courseDto);
 60 | 
 61 |         /** @var CourseEntity $course */
 62 |         foreach ($createdCourses as $course) {
 63 |             $courseData = $course->toArray();
 64 |             $this->assertArrayHasKey('id', $courseData);
 65 |             $this->assertEquals($course->shortName, $courseDto->shortName);
 66 |         }
 67 | 
 68 |         return $createdCourses;
 69 |     }
 70 | 
 71 |     /**
 72 |      * @param CourseCollection $courses
 73 |      * @depends testCreate
 74 |      */
 75 |     public function testGetByField($courses)
 76 |     {
 77 |         $createdCourses = $courses->toArray();
 78 | 
 79 |         /** @var CourseEntity $course */
 80 |         $createdCourse = $createdCourses[0];
 81 | 
 82 |         $allCourses = $this->service->getByField('shortname', $createdCourse->shortName);
 83 | 
 84 |         foreach ($allCourses as $course) {
 85 |             $this->assertEquals($createdCourse->shortName, $course->shortName);
 86 |         }
 87 |     }
 88 | 
 89 |     /**
 90 |      * @param CourseCollection
 91 |      * @depends testCreate
 92 |      */
 93 |     public function testDelete($courses)
 94 |     {
 95 |         $ids = [];
 96 |         /** @var CourseEntity $course */
 97 |         foreach ($courses as $course) {
 98 |             $ids[] = $course->id;
 99 |         }
100 | 
101 |         $this->service->delete($ids);
102 |         $courses = $this->service->getAll($ids);
103 | 
104 |         $this->assertEquals($courses->toArray(), []);
105 |     }
106 | 
107 |     /**
108 |      * @return CourseDto
109 |      */
110 |     protected function buildCourse()
111 |     {
112 |         $courseDto = new CourseDto();
113 |         $courseDto->shortName = 'shortName_' . uniqid();
114 |         $courseDto->fullName = 'fullName_' . uniqid();
115 |         $courseDto->categoryId = 1;
116 | 
117 |         return $courseDto;
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # MOODLE PHP CLIENT
  2 | 
  3 | ## Installation
  4 | The recommended way to install the library is through Composer:
  5 | 
  6 | ```
  7 | $ composer require ozq/moodle-client:dev-master
  8 | ```
  9 |  
 10 | ## Usage
 11 | Create instance of connection with your moodle service: 
 12 | ```php
 13 | $connection = new Connection('http://url-to-moodle-service.com', 'Y0uR!tOken');
 14 | ```
 15 | 
 16 | Create instance of one of available moodle clients, e.g. REST client:
 17 | ```php
 18 | $client = new RestClient($connection);
 19 | ```
 20 | 
 21 | Now, you can use moodle services. There are available some build in ready to use moodle entities.
 22 | All logic and API working encapsulated in moodle services and entities. Let's create instance of Course service.
 23 |  
 24 | Create instance:
 25 |  ```
 26 |  $courseService = new Course($client);
 27 |  ```
 28 | 
 29 | Get all courses:
 30 | ```php
 31 | $courses = $courseService->getAll();
 32 | ```
 33 | 
 34 | Delete courses with ids: 1, 2, 3:
 35 | ```php
 36 | $courses = $courseService->delete([1, 2, 3]);
 37 | ```
 38 | 
 39 | If you have to send some specific structured data, e.g., when you create new course, it is better to use special DTO's objects:  
 40 | ```php
 41 | $courseDto = new Course();
 42 | $courseDto->name = 'Test Course';
 43 | $courseDto->fullName = 'Test Course fullname';
 44 | ...
 45 | $courseService->create($courseDto);
 46 | ```
 47 | 
 48 | If there is no build in needed services and entities, you can create it.  
 49 | Services must extend Service abstract class, entities (as DTO's) must extend Entity abstract class.  
 50 | 
 51 | Also, you can use moodle client without service layer:
 52 | ```php
 53 | $courses = $client->sendRequest('core_course_get_courses');
 54 | ```
 55 | 
 56 | ## Example of Laravel integration
 57 | 1. Create config file (config/moodle.php) for moodle service with content:  
 58 | ```php
 59 | <?php
 60 | 
 61 | return [
 62 |     'connection' => [
 63 |         'url'   => 'http://url-to-moodle-service.com',
 64 |         'token' => 'Y0uR!tOken',
 65 |     ],
 66 | ];
 67 | ```
 68 | 
 69 | 2. Create service provider:  
 70 | ```
 71 | $ php artisan make:provider MoodleServiceProvider
 72 | ```
 73 | Example of MoodleServiceProvider register method:
 74 | ```php
 75 | public function register()
 76 | {
 77 |     $this->app->singleton(ClientAdapterInterface::class, function () {
 78 |         $connection = new Connection(config('moodle.connection.url'), config('moodle.connection.token'));
 79 |         return new RestClient($connection);
 80 |     });
 81 | }
 82 | ```
 83 | 
 84 | 3. Register MoodleServiceProvider:  
 85 | Edit your config/app.php, add ```\App\Providers\MoodleServiceProvider::class```, to 'providers' array.
 86 | 
 87 | 4. Clear config cache:
 88 | ```
 89 | $ php artisan clear-compiled
 90 | $ php artisan config:clear
 91 | ```
 92 | 
 93 | 5. Now you can use Moodle services in your project:
 94 | ```php
 95 | <?php
 96 | 
 97 | namespace App\Http\Controllers;
 98 | 
 99 | use Ozq\MoodleClient\Services\Course;
100 | 
101 | /**
102 |  * Class CourseController
103 |  * @package App\Http\Controllers
104 |  */
105 | class CourseController extends Controller
106 | {
107 |     /**
108 |      * @var Course
109 |      */
110 |     protected $courseService;
111 | 
112 |     /**
113 |      * CourseController constructor.
114 |      * @param Course $courseService
115 |      */
116 |     public function __construct(Course $courseService)
117 |     {
118 |         $this->courseService = $courseService;
119 |     }
120 | 
121 |     /**
122 |      * Display a listing of the resource.
123 |      *
124 |      * @return \Illuminate\Http\Response
125 |      */
126 |     public function index()
127 |     {
128 |         $courses = $this->courseService->getAll();
129 |         return view('courses.index', ['courses' => $courses]);
130 |     }
131 | }
132 | ```


--------------------------------------------------------------------------------