From 0d4bf6a208e0a7cf9ef4afc82ccbc9848f9ee73d Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Wed, 12 Aug 2026 17:13:30 +0000 Subject: [PATCH] style: apply Moodle coding standards --- classes/event/backup_performed.php | 4 +- classes/event/backup_restored.php | 4 +- classes/event/response_answer.php | 6 +- classes/event/service_added.php | 6 +- classes/event/service_deleted.php | 4 +- classes/event/service_updated.php | 6 +- classes/handler.php | 4 +- classes/privacy/provider.php | 10 +-- classes/service_edit_form.php | 104 +++++++++++++++++++++++++++++ classes/service_form.php | 77 --------------------- db/events.php | 8 +-- editservice.php | 10 +-- index.php | 20 +++--- lib.php | 10 +-- locallib.php | 20 +++--- restorebackup.php | 2 +- settings.php | 7 +- 17 files changed, 157 insertions(+), 145 deletions(-) create mode 100644 classes/service_edit_form.php diff --git a/classes/event/backup_performed.php b/classes/event/backup_performed.php index b1f7b7e..7965de7 100644 --- a/classes/event/backup_performed.php +++ b/classes/event/backup_performed.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -72,4 +70,4 @@ class backup_performed extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/event/backup_restored.php b/classes/event/backup_restored.php index 83c9ae6..8cf161c 100644 --- a/classes/event/backup_restored.php +++ b/classes/event/backup_restored.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -72,4 +70,4 @@ class backup_restored extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/event/response_answer.php b/classes/event/response_answer.php index 95a3949..626d333 100644 --- a/classes/event/response_answer.php +++ b/classes/event/response_answer.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -59,7 +57,7 @@ class response_answer extends base { * @throws \moodle_exception */ public function get_url() { - return new moodle_url('/local/webhooks/editservice.php', array('serviceid' => $this->objectid)); + return new moodle_url('/local/webhooks/editservice.php', ['serviceid' => $this->objectid]); } /** @@ -70,4 +68,4 @@ class response_answer extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/event/service_added.php b/classes/event/service_added.php index 89d7050..fe4d47b 100644 --- a/classes/event/service_added.php +++ b/classes/event/service_added.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -61,7 +59,7 @@ class service_added extends base { * @throws \moodle_exception */ public function get_url() { - return new moodle_url('/local/webhooks/editservice.php', array('serviceid' => $this->objectid)); + return new moodle_url('/local/webhooks/editservice.php', ['serviceid' => $this->objectid]); } /** @@ -72,4 +70,4 @@ class service_added extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/event/service_deleted.php b/classes/event/service_deleted.php index 0d446e7..66c739c 100644 --- a/classes/event/service_deleted.php +++ b/classes/event/service_deleted.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -72,4 +70,4 @@ class service_deleted extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/event/service_updated.php b/classes/event/service_updated.php index 08b7225..6b23180 100644 --- a/classes/event/service_updated.php +++ b/classes/event/service_updated.php @@ -24,8 +24,6 @@ namespace local_webhooks\event; -defined('MOODLE_INTERNAL') || die(); - use core\event\base; use lang_string; use moodle_url; @@ -61,7 +59,7 @@ class service_updated extends base { * @throws \moodle_exception */ public function get_url() { - return new moodle_url('/local/webhooks/editservice.php', array('serviceid' => $this->objectid)); + return new moodle_url('/local/webhooks/editservice.php', ['serviceid' => $this->objectid]); } /** @@ -72,4 +70,4 @@ class service_updated extends base { $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'local_webhooks_service'; } -} \ No newline at end of file +} diff --git a/classes/handler.php b/classes/handler.php index da41856..f8a0a2e 100644 --- a/classes/handler.php +++ b/classes/handler.php @@ -96,7 +96,7 @@ class handler { */ private static function send($data, $callback) { $curl = new curl(); - $curl->setHeader(array('Content-Type: application/' . $callback->type)); + $curl->setHeader(['Content-Type: application/' . $callback->type]); $curl->post($callback->url, json_encode($data)); $response = $curl->getResponse(); @@ -104,4 +104,4 @@ class handler { return $response; } -} \ No newline at end of file +} diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php index 9fe7bd9..b5b5b15 100644 --- a/classes/privacy/provider.php +++ b/classes/privacy/provider.php @@ -24,19 +24,19 @@ namespace local_webhooks\privacy; -defined('MOODLE_INTERNAL') || die(); - +/** + * Declares that the plugin does not store personal data. + */ class provider implements // This plugin does not store any personal user data. \core_privacy\local\metadata\null_provider { - /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ - public static function get_reason() : string { + public static function get_reason(): string { return 'privacy:metadata'; } -} \ No newline at end of file +} diff --git a/classes/service_edit_form.php b/classes/service_edit_form.php new file mode 100644 index 0000000..b4c40da --- /dev/null +++ b/classes/service_edit_form.php @@ -0,0 +1,104 @@ +. + +/** + * Defines the service editing form. + * + * @package local_webhooks + * @copyright 2017 "Valentin Popov" + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +require_once($CFG->libdir . '/formslib.php'); + +/** + * Description editing form definition. + * + * @copyright 2017 "Valentin Popov" + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class service_edit_form extends moodleform { + /** + * Defines the standard structure of the form. + * + * @throws \coding_exception + */ + protected function definition() { + $mform =& $this->_form; + $size = ['size' => 60]; + + /* Form heading */ + $mform->addElement('header', 'editserviceheader', new lang_string('service', 'webservice')); + + /* Name of the service */ + $mform->addElement('text', 'title', new lang_string('name', 'moodle'), $size); + $mform->addRule('title', null, 'required'); + $mform->setType('title', PARAM_NOTAGS); + + /* Callback address */ + $mform->addElement('text', 'url', new lang_string('url', 'moodle'), $size); + $mform->addRule('url', null, 'required'); + $mform->setType('url', PARAM_URL); + + /* Enabling the service */ + $mform->addElement('advcheckbox', 'enable', new lang_string('enable', 'moodle')); + $mform->setType('enable', PARAM_BOOL); + $mform->setDefault('enable', 1); + $mform->setAdvanced('enable'); + + /* Token */ + $mform->addElement('text', 'token', new lang_string('token', 'webservice'), $size); + $mform->setType('token', PARAM_NOTAGS); + + /* Additional information */ + $mform->addElement('text', 'other', new lang_string('sourceext', 'plugin'), $size); + $mform->setType('other', PARAM_NOTAGS); + $mform->setAdvanced('other'); + + /* Content type */ + $contenttype = [ + 'json' => 'application/json', + 'x-www-form-urlencoded' => 'application/x-www-form-urlencoded', + ]; + + $mform->addElement('select', 'type', 'Content type', $contenttype); + $mform->setAdvanced('type'); + + /* Form heading */ + $mform->addElement('header', 'editserviceheaderevent', new lang_string('edulevel', 'moodle')); + + /* List of events */ + $eventlist = report_eventlist_list_generator::get_all_events_list(); + $events = []; + + /* Formation of the list of elements */ + foreach ($eventlist as $event) { + /* Escaping event names */ + $eventname = base64_encode($event['eventname']); + $events[$event['component']][] =& $mform->createElement('checkbox', $eventname, $event['eventname']); + } + + /* Displays groups of items */ + foreach ($events as $key => $event) { + $mform->addGroup($event, 'events', $key, '
'); + } + + /* Control Panel */ + $this->add_action_buttons(); + } +} diff --git a/classes/service_form.php b/classes/service_form.php index b23cad3..290f156 100644 --- a/classes/service_form.php +++ b/classes/service_form.php @@ -52,80 +52,3 @@ class service_backup_form extends moodleform { $this->add_action_buttons(true, new lang_string('restore', 'moodle')); } } - -/** - * Description editing form definition. - * - * @copyright 2017 "Valentin Popov" - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ -class service_edit_form extends moodleform { - /** - * Defines the standard structure of the form. - * - * @throws \coding_exception - */ - protected function definition() { - $mform =& $this->_form; - $size = ['size' => 60]; - - /* Form heading */ - $mform->addElement('header', 'editserviceheader', new lang_string('service', 'webservice')); - - /* Name of the service */ - $mform->addElement('text', 'title', new lang_string('name', 'moodle'), $size); - $mform->addRule('title', null, 'required'); - $mform->setType('title', PARAM_NOTAGS); - - /* Callback address */ - $mform->addElement('text', 'url', new lang_string('url', 'moodle'), $size); - $mform->addRule('url', null, 'required'); - $mform->setType('url', PARAM_URL); - - /* Enabling the service */ - $mform->addElement('advcheckbox', 'enable', new lang_string('enable', 'moodle')); - $mform->setType('enable', PARAM_BOOL); - $mform->setDefault('enable', 1); - $mform->setAdvanced('enable'); - - /* Token */ - $mform->addElement('text', 'token', new lang_string('token', 'webservice'), $size); - $mform->setType('token', PARAM_NOTAGS); - - /* Additional information */ - $mform->addElement('text', 'other', new lang_string('sourceext', 'plugin'), $size); - $mform->setType('other', PARAM_NOTAGS); - $mform->setAdvanced('other'); - - /* Content type */ - $contenttype = [ - 'json' => 'application/json', - 'x-www-form-urlencoded' => 'application/x-www-form-urlencoded', - ]; - - $mform->addElement('select', 'type', 'Content type', $contenttype); - $mform->setAdvanced('type'); - - /* Form heading */ - $mform->addElement('header', 'editserviceheaderevent', new lang_string('edulevel', 'moodle')); - - /* List of events */ - $eventlist = report_eventlist_list_generator::get_all_events_list(); - $events = []; - - /* Formation of the list of elements */ - foreach ($eventlist as $event) { - /* Escaping event names */ - $eventname = base64_encode($event['eventname']); - $events[$event['component']][] =& $mform->createElement('checkbox', $eventname, $event['eventname']); - } - - /* Displays groups of items */ - foreach ($events as $key => $event) { - $mform->addGroup($event, 'events', $key, '
'); - } - - /* Control Panel */ - $this->add_action_buttons(); - } -} \ No newline at end of file diff --git a/db/events.php b/db/events.php index 7f2733a..ea40889 100644 --- a/db/events.php +++ b/db/events.php @@ -24,12 +24,12 @@ defined('MOODLE_INTERNAL') || die(); -$observers = array( - array( +$observers = [ + [ 'callback' => '\local_webhooks\handler::events', 'eventname' => '*', 'includefile' => null, 'internal' => true, 'priority' => 200, - ), -); \ No newline at end of file + ], +]; diff --git a/editservice.php b/editservice.php index aa3efb8..a1895ba 100644 --- a/editservice.php +++ b/editservice.php @@ -23,7 +23,7 @@ */ require_once(__DIR__ . '/../../config.php'); -require_once(__DIR__ . '/classes/service_form.php'); +require_once(__DIR__ . '/classes/service_edit_form.php'); require_once(__DIR__ . '/lib.php'); require_once($CFG->libdir . '/adminlib.php'); @@ -32,7 +32,7 @@ require_once($CFG->libdir . '/adminlib.php'); $serviceid = optional_param('serviceid', 0, PARAM_INT); /* Link generation */ -$urlparameters = array('serviceid' => $serviceid); +$urlparameters = ['serviceid' => $serviceid]; $baseurl = new moodle_url('/local/webhooks/editservice.php', $urlparameters); $managerservice = new moodle_url('/local/webhooks/index.php'); @@ -54,7 +54,7 @@ if (($editing = (bool) $serviceid) === true) { $servicerecord = local_webhooks_get_record($serviceid); if (is_array($servicerecord->events)) { - $events = array(); + $events = []; /* Escaping event names */ foreach ($servicerecord->events as $eventname => $eventstatus) { @@ -71,7 +71,7 @@ if (($editing = (bool) $serviceid) === true) { /* Processing of received data */ if (!empty($data = $mform->get_data())) { if (is_array($data->events)) { - $events = array(); + $events = []; /* Deciphering event names */ foreach ($data->events as $eventname => $eventstatus) { @@ -102,4 +102,4 @@ echo $OUTPUT->header(); /* Displays the form */ $mform->display(); -echo $OUTPUT->footer(); \ No newline at end of file +echo $OUTPUT->footer(); diff --git a/index.php b/index.php index 5de2101..6a4c4fe 100644 --- a/index.php +++ b/index.php @@ -81,19 +81,19 @@ $table = new flexible_table('webhooks-service-table'); /* Customize the table */ $table->define_columns( - array( + [ 'title', 'url', 'actions', - ) + ] ); $table->define_headers( - array( + [ new lang_string('name', 'moodle'), new lang_string('url', 'moodle'), new lang_string('actions', 'moodle'), - ) + ] ); $table->define_baseurl($baseurl); @@ -113,19 +113,19 @@ foreach ($callbacks as $callback) { } /* Link to enable / disable the service */ - $hideshowlink = new moodle_url($managerservice, array('hideshowid' => $callback->id)); + $hideshowlink = new moodle_url($managerservice, ['hideshowid' => $callback->id]); $hideshowitem = $OUTPUT->action_icon($hideshowlink, new pix_icon($hideshowicon, $hideshowstring)); /* Link for editing */ - $editlink = new moodle_url($editservice, array('serviceid' => $callback->id)); + $editlink = new moodle_url($editservice, ['serviceid' => $callback->id]); $edititem = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', new lang_string('edit', 'moodle'))); /* Link to remove */ - $deletelink = new moodle_url($managerservice, array('deleteid' => $callback->id)); + $deletelink = new moodle_url($managerservice, ['deleteid' => $callback->id]); $deleteitem = $OUTPUT->action_icon($deletelink, new pix_icon('t/delete', new lang_string('delete', 'moodle'))); /* Adding data to the table */ - $table->add_data(array($titlecallback, $urlcallback, $hideshowitem . $edititem . $deleteitem)); + $table->add_data([$titlecallback, $urlcallback, $hideshowitem . $edititem . $deleteitem]); } /* Display the table */ @@ -136,11 +136,11 @@ $addserviceurl = new moodle_url($editservice); echo $OUTPUT->single_button($addserviceurl, new lang_string('addaservice', 'webservice'), 'get'); /* Button to get a backup */ -$backupurl = new moodle_url($managerservice, array('getbackup' => true)); +$backupurl = new moodle_url($managerservice, ['getbackup' => true]); echo $OUTPUT->single_button($backupurl, new lang_string('backup', 'moodle'), 'get'); /* Button for restoring settings */ $restorebackupurl = new moodle_url($restorebackup); echo $OUTPUT->single_button($restorebackupurl, new lang_string('restore', 'moodle'), 'get'); -echo $OUTPUT->footer(); \ No newline at end of file +echo $OUTPUT->footer(); diff --git a/lib.php b/lib.php index 1cf993f..f43da7b 100644 --- a/lib.php +++ b/lib.php @@ -60,7 +60,7 @@ function local_webhooks_get_list_records($limitfrom = 0, $limitnum = 0) { function local_webhooks_get_record($serviceid = 0) { global $DB; - $servicerecord = $DB->get_record('local_webhooks_service', array('id' => $serviceid), '*', MUST_EXIST); + $servicerecord = $DB->get_record('local_webhooks_service', ['id' => $serviceid], '*', MUST_EXIST); if (!empty($servicerecord->events)) { $servicerecord->events = local_webhooks_unarchive_data($servicerecord->events); @@ -91,7 +91,7 @@ function local_webhooks_remove_list_records() { function local_webhooks_remove_record($serviceid = 0) { global $DB; - $DB->delete_records('local_webhooks_service', array('id' => $serviceid)); + $DB->delete_records('local_webhooks_service', ['id' => $serviceid]); local_webhooks_events::service_deleted($serviceid); } @@ -109,7 +109,7 @@ function local_webhooks_update_record($data, $insert = true) { global $DB; if (empty($data->events)) { - $data->events = array(); + $data->events = []; } $data->events = local_webhooks_archiving_data($data->events); @@ -167,7 +167,7 @@ function local_webhooks_restore_backup($listservices = '') { * * @return string */ -function local_webhooks_archiving_data(array $data = array()) { +function local_webhooks_archiving_data(array $data = []) { return base64_encode(gzcompress(serialize($data), 3)); } @@ -180,4 +180,4 @@ function local_webhooks_archiving_data(array $data = array()) { */ function local_webhooks_unarchive_data($data = '') { return unserialize(gzuncompress(base64_decode($data))); -} \ No newline at end of file +} diff --git a/locallib.php b/locallib.php index 39fb00d..9998465 100644 --- a/locallib.php +++ b/locallib.php @@ -22,8 +22,6 @@ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -defined('MOODLE_INTERNAL') || die(); - /** * Description of functions of the call of events * @@ -41,10 +39,10 @@ class local_webhooks_events { $context = context_system::instance(); $event = local_webhooks\event\backup_performed::create( - array( + [ 'context' => $context, 'objectid' => 0, - ) + ] ); $event->trigger(); @@ -60,10 +58,10 @@ class local_webhooks_events { $context = context_system::instance(); $event = local_webhooks\event\backup_restored::create( - array( + [ 'context' => $context, 'objectid' => 0, - ) + ] ); $event->trigger(); @@ -78,7 +76,7 @@ class local_webhooks_events { * @throws \coding_exception * @throws \dml_exception */ - public static function response_answer($objectid = 0, array $response = array()) { + public static function response_answer($objectid = 0, array $response = []) { $context = context_system::instance(); $status = 'Error sending request'; @@ -87,11 +85,11 @@ class local_webhooks_events { } $event = local_webhooks\event\response_answer::create( - array( + [ 'context' => $context, 'objectid' => $objectid, - 'other' => array('status' => $status), - ) + 'other' => ['status' => $status], + ] ); $event->trigger(); @@ -150,4 +148,4 @@ class local_webhooks_events { $event->trigger(); } -} \ No newline at end of file +} diff --git a/restorebackup.php b/restorebackup.php index db052f9..da855cb 100644 --- a/restorebackup.php +++ b/restorebackup.php @@ -61,4 +61,4 @@ echo $OUTPUT->header(); /* Displays the form */ $mform->display(); -echo $OUTPUT->footer(); \ No newline at end of file +echo $OUTPUT->footer(); diff --git a/settings.php b/settings.php index b8d844e..f4120b1 100644 --- a/settings.php +++ b/settings.php @@ -24,14 +24,13 @@ defined('MOODLE_INTERNAL') || die(); -/* @var \admin_root $ADMIN */ - if ($hassiteconfig) { $ADMIN->add( - 'server', new admin_externalpage( + 'server', + new admin_externalpage( 'local_webhooks', new lang_string('pluginname', 'local_webhooks'), new moodle_url('/local/webhooks/index.php') ) ); -} \ No newline at end of file +}