Cursor rule

1---
2description: 
3globs: 
4alwaysApply: false
5---
6# Moodle Plugin Structure
7 
8## Purpose
9Ensure proper organization and structure for Moodle plugins following Moodle's plugin architecture.
10 
11## Instructions
12When creating or modifying Moodle plugins, follow these structural guidelines:
13 
141. **Plugin Types**: Follow Moodle's plugin type conventions (mod, block, local, auth, etc.)
152. **Directory Structure**: Use standard Moodle plugin directory layout
163. **Version File**: Always include `version.php` with proper version information
174. **Language Files**: Include language strings in `lang/en/` directory
185. **Capabilities**: Define capabilities in `db/access.php` or `db/capabilities.php`
196. **Database Schema**: Use `db/install.xml` for database tables
207. **Settings**: Use `settings.php` for admin settings
218. **Lib Functions**: Place helper functions in `lib.php`
229. **Classes**: Use `classes/` directory for PHP classes
2310. **Templates**: Use `templates/` directory for renderable templates
24 
25## Examples
26 
27```php
28<?php
29// File: ./version.php
30 
31defined('MOODLE_INTERNAL') || die();
32 
33$plugin->component = 'local_myplugin';
34$plugin->version = 2024120100;
35$plugin->requires = 2022112800; // Moodle 4.1
36$plugin->maturity = MATURITY_STABLE;
37$plugin->release = '1.0.0';
38```
39 
40```php
41<?php
42// File: ./db/access.php
43 
44defined('MOODLE_INTERNAL') || die();
45 
46$capabilities = [
47    'local/myplugin:manage' => [
48        'riskbitmask' => RISK_SPAM,
49        'captype' => 'write',
50        'contextlevel' => CONTEXT_SYSTEM,
51        'archetypes' => [
52            'manager' => CAP_ALLOW
53        ]
54    ]
55];
56```
57 
58```php
59<?php
60// File: ./lib.php
61 
62defined('MOODLE_INTERNAL') || die();
63 
64/**
65 * Get plugin data
66 *
67 * @param int $userid User ID
68 * @return stdClass Plugin data
69 */
70function local_myplugin_get_data($userid) {
71    global $DB;
72    
73    return $DB->get_record('local_myplugin_data', ['userid' => $userid]);
74}
75```
76 
77## Exceptions
78- Custom plugins may have different requirements based on functionality
79- Legacy plugins may not follow all conventions but should be updated when possible
80