14. External REST Web Services: db/services.php, External API Functions & Mobile App Interop • Moodle LMS: Enterprise Architecture & Plugin Development • Rishabh Ki Kaksha

Moodle LMS: Enterprise Architecture & Plugin Development › 14. External REST Web Services: db/services.php, External API Functions & Mobile App Interop

50 mins

← Prev Next →

Course Syllabus

Module 1: Moodle Core Architecture, Directory Structure & $CFG

01. Moodle Core Architecture: Modular Architecture, Directory Tree, $CFG & $SITE 02. Moodle Request Lifecycle: setup.php, config.php, $PAGE & $OUTPUT Renderers 03. The Frankenstyle Component Naming Convention & Plugin Types Taxonomy

Part 1: Core Architecture, Database & Plugin Dev

Module 2: Database Layer ($DB API) & XMLDB Schema Management

04. Moodle Database API ($DB): get_records, insert_record, execute & Safe Parameter Binding 05. XMLDB Schema Architecture: db/install.xml, upgrade.php & Automated Database Migrations 06. Complex SQL Queries with Recordsets, Pagination & Memory-Efficient Iterators

Part 2: Web Services, High-Scale MUC & AI Subsystem

Module 3: Plugin Development Lifecycle: Block, Local & Activity Modules

07. Building Custom Block Plugins (blocks/): Structure, view.php, Capabilities & Settings 08. Building Custom Local Plugins (local/): System Hooks, Navigation Injection & Cron Tasks 09. Building Custom Activity Modules (mod/): mod_form.php, Grades Integration & Completion API 10. Moodle Form API (moodleform): Validation Rules, File Manager & AJAX Elements

Module 4: Security, Access Control (Access API) & Authentication

11. Moodle Access API: Contexts Hierarchy, Roles, Capabilities (db/access.php) & has_capability() 12. Authentication Plugins (auth/): Single Sign-On (SSO), OAuth2, SAML & Active Directory Sync 13. Enrollment Plugins (enrol/): Automated Course Enrollment, Webhook Triggers & Subscriptions

Module 5: Web Services, Events & High-Scale Caching (MUC)

14. External REST Web Services: db/services.php, External API Functions & Mobile App Interop 15. Moodle Events API: Observer Pattern, Custom Events (core\event) & Triggering Webhooks 16. Moodle Task API: Ad-hoc Tasks vs Scheduled Cron Tasks with Queuing & Logging 17. Moodle Universal Cache (MUC): Definition of Cache (db/caches.php), Redis & Memory Scaling

Module 6: Enterprise AI Integration, Performance & Cloud Clustering

18. Moodle AI Subsystem (core_ai): Pluggable AI Providers, Course Summaries & Smart AI Tutors 19. Moodle Multi-Tier Enterprise Performance: Redis Session Caching, NFS Moodledata & Read Replicas 20. Production High-Availability Cloud Deployment: Dockerized Moodle, Nginx Tuning & MySQL Clustering

Interactive Lesson Studio

# 14. External REST Web Services: db/services.php, External API Functions & Mobile App Interop

> Moodle LMS Enterprise Notes by Rishabh - Topic 14

---

### 1. Declaring Web Services in `db/services.php` 🌐

```php
$functions = [
    'local_boost_get_user_progress' => [
        'classname' => 'local_boost\external\get_user_progress',
        'methodname' => 'execute',
        'description' => 'Returns course completion metrics for mobile app',
        'type' => 'read',
        'ajax' => true,
        'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
];
```

---

### 2. `external_api` Parameter Validation Architecture

```php
namespace local_boost\external;
use external_api, external_function_parameters, external_value, external_single_structure;

class get_user_progress extends external_api {
    public static function execute_parameters(): external_function_parameters {
        return new external_function_parameters([
            'courseid' => new external_value(PARAM_INT, 'Course ID'),
        ]);
    }

public static function execute(int $courseid): array {
        $params = self::validate_parameters(self::execute_parameters(), ['courseid' => $courseid]);
        return ['progress' => 95, 'completed' => true];
    }
}
```

---

### 3. Interview Ke 3 Sawal Is Topic Se

1. **`PARAM_*` data cleaning constants (`PARAM_INT`, `PARAM_ALPHANUM`, `PARAM_RAW`) kyu mandatory hain?** -> Strict type casting aur automated SQL/XSS input sanitization provide karna.
2. **Mobile Web Services token generation lifecycle kaise chalta hai?** -> User credentials `/login/token.php?service=moodle_mobile_app` par verify hokar stateless long-lived WSToken generate karte hain.
3. **External API responses me Capabilities validation kyu zaroori hai?** -> Taaki API direct bypass karke unauthorized users ko internal quiz answers ya hidden courses expose na kare.

---
**Next Topic:** 15. Moodle Events API: Observer Pattern, Custom Events (core\event) & Triggering Webhooks

Loading lesson content...

PHP 8.3

Full IDE

Live Execution Terminal

Click "Execute Live" to run code.
                

Lesson Mastery AI Quiz

AI Doubt Solver

CERTIFICATE OF COMPLETION

Rishabh Gehlot

PHP 8+ & Laravel 11 Master Track