Cursor rule

1---
2description: 
3globs: 
4alwaysApply: false
5---
6---
7name: Moodle PHP Coding Standards
8---
9 
10# Moodle PHP Coding Standards
11 
12## Purpose
13Ensure consistent PHP coding standards across all Moodle-related PHP files in the project.
14 
15## Instructions
16When working with PHP files in this Moodle project, follow these coding standards:
17 
181. **PSR-12 Compliance**: Follow PSR-12 coding standards for all PHP code
192. **Moodle Coding Style**: Adhere to Moodle's specific coding conventions
203. **Indentation**: Use 4 spaces for indentation, never tabs
214. **Line Length**: Keep lines under 132 characters when possible
225. **Naming Conventions**:
23   - Classes: PascalCase (e.g., `MoodlePlugin`)
24   - Methods: camelCase (e.g., `getUserData()`)
25   - Variables: camelCase (e.g., `$userData`)
26   - Constants: UPPER_CASE (e.g., `MOODLE_VERSION`)
276. **File Structure**: Always include proper PHP opening tag `<?php` and no closing tag
287. **Comments**: Use PHPDoc blocks for classes, methods, and functions
298. **Error Handling**: Use Moodle's exception handling patterns
30 
31## Examples
32 
33```php
34<?php
35// File: ./includes/classes/moodle_plugin.php
36 
37/**
38 * Example Moodle plugin class following coding standards
39 *
40 * @package    moodle
41 * @category   core
42 * @copyright  2024 Your Name
43 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44 */
45class moodle_plugin {
46    
47    /** @var string Plugin name */
48    private $pluginname;
49    
50    /**
51     * Constructor
52     *
53     * @param string $pluginname The name of the plugin
54     */
55    public function __construct($pluginname) {
56        $this->pluginname = $pluginname;
57    }
58    
59    /**
60     * Get plugin data
61     *
62     * @return array Plugin data
63     * @throws moodle_exception If plugin not found
64     */
65    public function getPluginData() {
66        if (empty($this->pluginname)) {
67            throw new moodle_exception('pluginnotfound', 'core');
68        }
69        
70        return [
71            'name' => $this->pluginname,
72            'version' => MOODLE_VERSION
73        ];
74    }
75}
76```
77 
78## Exceptions
79- Legacy code may not follow all standards but should be updated when modified
80- Third-party libraries should maintain their original coding style
81