MDL-57898 core_customfield: coding style fixes

course/classes/customfield/course_handler.php

@@ -104,7 +104,7 @@ public function can_edit(field_controller $field, int $instanceid = 0) : bool {
      * @param int $instanceid id of the course to test edit permission
      * @return bool true if the current can edit custom fields, false otherwise
      */
-    public function can_view(field_controller $field, int $instanceid): bool {
+    public function can_view(field_controller $field, int $instanceid) : bool {
         $visibility = $field->get_configdata_property('visibility');
         if ($visibility == self::NOTVISIBLE) {
             return false;
@@ -146,7 +146,7 @@ protected function get_parent_context() : \context {
      *
      * @return \context the context for configuration
      */
-    public function get_configuration_context(): \context {
+    public function get_configuration_context() : \context {
         return \context_system::instance();
     }
 
@@ -155,7 +155,7 @@ public function get_configuration_context(): \context {
      *
      * @return \moodle_url The URL to configure custom fields for this component
      */
-    public function get_configuration_url(): \moodle_url {
+    public function get_configuration_url() : \moodle_url {
         return new \moodle_url('/course/customfield.php');
     }
 
@@ -165,7 +165,7 @@ public function get_configuration_url(): \moodle_url {
      * @param int $instanceid id of the record to get the context for
      * @return \context the context for the given record
      */
-    public function get_instance_context(int $instanceid = 0): \context {
+    public function get_instance_context(int $instanceid = 0) : \context {
         if ($instanceid > 0) {
             return \context_course::instance($instanceid);
         } else {
@@ -230,7 +230,7 @@ public function restore_instance_data_from_backup(\restore_task $task, array $da
      * @param field_controller $field
      * @return string page heading
      */
-    public function setup_edit_page(field_controller $field): string {
+    public function setup_edit_page(field_controller $field) : string {
         global $CFG, $PAGE;
         require_once($CFG->libdir.'/adminlib.php');
 

course/classes/list_element.php

@@ -205,7 +205,7 @@ public function get_course_contacts() {
      *
      * @return \core_customfield\data_controller[]
      */
-    public function get_custom_fields(): array {
+    public function get_custom_fields() : array {
         if (!isset($this->record->customfields)) {
             $this->record->customfields = \core_course\customfield\course_handler::create()->get_instance_data($this->id);
         }
@@ -217,7 +217,7 @@ public function get_custom_fields(): array {
      *
      * @return bool
      */
-    public function has_custom_fields(): bool {
+    public function has_custom_fields() : bool {
         $customfields = $this->get_custom_fields();
         return !empty($customfields);
     }

course/externallib.php

@@ -682,7 +682,8 @@ public static function get_courses_returns() {
                                 new external_single_structure(
                                     ['name' => new external_value(PARAM_TEXT, 'The name of the custom field'),
                                      'shortname' => new external_value(PARAM_ALPHANUMEXT, 'The shortname of the custom field'),
-                                     'type'  => new external_value(PARAM_COMPONENT, 'The type of the custom field - text, checkbox...'),
+                                     'type'  => new external_value(PARAM_COMPONENT,
+                                         'The type of the custom field - text, checkbox...'),
                                      'value' => new external_value(PARAM_RAW, 'The value of the custom field')]
                                 ), 'Custom fields and associated values', VALUE_OPTIONAL),
                         ), 'course'
@@ -2548,8 +2549,10 @@ protected static function get_course_structure($onlypublicdata = true) {
                 new external_single_structure(
                     array(
                         'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
-                        'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
-                        'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
+                        'shortname' => new external_value(PARAM_RAW,
+                            'The shortname of the custom field - to be able to build the field class in the code'),
+                        'type'  => new external_value(PARAM_ALPHANUMEXT,
+                            'The type of the custom field - text field, checkbox...'),
                         'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
                     )
                 ), 'Custom fields', VALUE_OPTIONAL),

course/tests/externallib_test.php

@@ -409,7 +409,7 @@ public function test_create_courses() {
         // Enable course themes.
         set_config('allowcoursethemes', 1);
 
-        // Custom fields
+        // Custom fields.
         $fieldcategory = self::getDataGenerator()->create_custom_field_category(['name' => 'Other fields']);
 
         $customfield = ['shortname' => 'test', 'name' => 'Custom field', 'type' => 'text',

customfield/classes/api.php

@@ -54,7 +54,7 @@ class api {
      *     If ($adddefaults): All fieldids are present, some data_controller objects may have 'id', some not.
      *     If (!$adddefaults): Only fieldids with data are present, all data_controller objects have 'id'.
      */
-    public static function get_instance_fields_data(array $fields, int $instanceid, bool $adddefaults = true): array {
+    public static function get_instance_fields_data(array $fields, int $instanceid, bool $adddefaults = true) : array {
         return self::get_instances_fields_data($fields, [$instanceid], $adddefaults)[$instanceid];
     }
 
@@ -69,7 +69,7 @@ public static function get_instance_fields_data(array $fields, int $instanceid,
      *     If (!$adddefaults): All instanceids are present but only fieldids with data are present, all
      *         data_controller objects have 'id'.
      */
-    public static function get_instances_fields_data(array $fields, array $instanceids, bool $adddefaults = true): array {
+    public static function get_instances_fields_data(array $fields, array $instanceids, bool $adddefaults = true) : array {
         global $DB;
 
         // Create the results array where instances and fields order is the same as in the input arrays.
@@ -230,7 +230,7 @@ public static function move_field(field_controller $field, int $categoryid, int
      *
      * @param field_controller $field
      */
-    public static function delete_field_configuration(field_controller $field): bool {
+    public static function delete_field_configuration(field_controller $field) : bool {
         $event = field_deleted::create_from_object($field);
         get_file_storage()->delete_area_files($field->get_handler()->get_configuration_context()->id, 'core_customfield',
             'description', $field->get('id'));
@@ -318,7 +318,7 @@ public static function save_category(category_controller $category) {
      * @param category_controller $category
      * @return bool
      */
-    public static function delete_category(category_controller $category): bool {
+    public static function delete_category(category_controller $category) : bool {
         $event = category_deleted::create_from_object($category);
 
         // Delete all fields.
@@ -339,7 +339,7 @@ public static function delete_category(category_controller $category): bool {
      * @param int $itemid
      * @return category_controller[]
      */
-    public static function get_categories_with_fields(string $component, string $area, int $itemid): array {
+    public static function get_categories_with_fields(string $component, string $area, int $itemid) : array {
         global $DB;
 
         $categories = [];
@@ -397,7 +397,7 @@ public static function get_categories_with_fields(string $component, string $are
      * @param field_controller $field
      * @return \stdClass
      */
-    public static function prepare_field_for_config_form(field_controller $field): \stdClass {
+    public static function prepare_field_for_config_form(field_controller $field) : \stdClass {
         if ($field->get('id')) {
             $formdata = $field->to_record();
             $formdata->configdata = $field->get('configdata');

customfield/classes/category.php

@@ -46,7 +46,7 @@ class category extends persistent {
      *
      * @return array
      */
-    protected static function define_properties(): array {
+    protected static function define_properties() : array {
         return array(
                 'name' => [
                         'type' => PARAM_TEXT,

customfield/classes/category_controller.php

@@ -77,7 +77,7 @@ protected function __construct(int $id = 0, \stdClass $record = null) {
      * @throws \moodle_exception
      * @throws \coding_exception
      */
-    public static function create(int $id, \stdClass $record = null, handler $handler = null): category_controller {
+    public static function create(int $id, \stdClass $record = null, handler $handler = null) : category_controller {
         global $DB;
         if ($id && $record) {
             // This warning really should be in persistent as well.
@@ -180,7 +180,7 @@ public function add_field(field_controller $field) {
      *
      * @return handler
      */
-    public function get_handler(): handler {
+    public function get_handler() : handler {
         if ($this->handler === null) {
             $this->handler = handler::get_handler($this->get('component'), $this->get('area'), $this->get('itemid'));
         }
@@ -224,7 +224,7 @@ final public function to_record() {
      *
      * @return string
      */
-    public function get_formatted_name(): string {
+    public function get_formatted_name() : string {
         $context = $this->get_handler()->get_configuration_context();
         return format_string($this->get('name'), true, ['context' => $context]);
     }

customfield/classes/data.php

@@ -47,7 +47,7 @@ class data extends persistent {
      *
      * @return array
      */
-    protected static function define_properties(): array {
+    protected static function define_properties() : array {
         return array(
                 'fieldid'        => [
                         'type' => PARAM_INT,

customfield/classes/data_controller.php

@@ -82,7 +82,7 @@ public function __construct(int $id, \stdClass $record) {
      * @throws \coding_exception
      * @throws \moodle_exception
      */
-    public static function create(int $id, \stdClass $record = null, field_controller $field = null): data_controller {
+    public static function create(int $id, \stdClass $record = null, field_controller $field = null) : data_controller {
         global $DB;
         if ($id && $record) {
             // This warning really should be in persistent as well.
@@ -122,7 +122,7 @@ public static function create(int $id, \stdClass $record = null, field_controlle
      *
      * @return string
      */
-    protected function get_form_element_name(): string {
+    protected function get_form_element_name() : string {
         return 'customfield_' . $this->get_field()->get('shortname');
     }
 
@@ -185,7 +185,7 @@ public function save() {
      *
      * @return field_controller
      */
-    public function get_field(): field_controller {
+    public function get_field() : field_controller {
         return $this->field;
     }
 
@@ -223,7 +223,7 @@ public function instance_form_before_set_data(\stdClass $instance) {
      * @param mixed $value
      * @return bool
      */
-    protected function is_empty($value): bool {
+    protected function is_empty($value) : bool {
         if ($this->datafield() === 'value' || $this->datafield() === 'charvalue' || $this->datafield() === 'shortcharvalue') {
             return '' . $value === '';
         }
@@ -236,7 +236,7 @@ protected function is_empty($value): bool {
      * @param mixed $value
      * @return bool
      */
-    protected function is_unique($value): bool {
+    protected function is_unique($value) : bool {
         global $DB;
         $datafield = $this->datafield();
         $where = "fieldid = ? AND {$datafield} = ?";
@@ -255,7 +255,7 @@ protected function is_unique($value): bool {
      * @param array $files
      * @return array array of errors
      */
-    public function instance_form_validation(array $data, array $files): array {
+    public function instance_form_validation(array $data, array $files) : array {
         $errors = [];
         $elementname = $this->get_form_element_name();
         if ($this->get_field()->get_configdata_property('uniquevalues') == 1) {
@@ -281,7 +281,7 @@ public function instance_form_definition_after_data(\MoodleQuickForm $mform) {
      *
      * @return string
      */
-    public function display(): string {
+    public function display() : string {
         global $PAGE;
         $output = $PAGE->get_renderer('core_customfield');
         return $output->render(new field_data($this));

customfield/classes/event/category_created.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param category_controller $category
      * @return category_created
      */
-    public static function create_from_object(category_controller $category): category_created {
+    public static function create_from_object(category_controller $category) : category_created {
         $eventparams = [
             'objectid' => $category->get('id'),
             'context'  => $category->get_handler()->get_configuration_context(),

customfield/classes/event/category_deleted.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param category_controller $category
      * @return category_deleted
      */
-    public static function create_from_object(category_controller $category): category_deleted {
+    public static function create_from_object(category_controller $category) : category_deleted {
         $eventparams = [
             'objectid' => $category->get('id'),
             'context'  => $category->get_handler()->get_configuration_context(),

customfield/classes/event/category_updated.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param category_controller $category
      * @return category_updated
      */
-    public static function create_from_object(category_controller $category): category_updated {
+    public static function create_from_object(category_controller $category) : category_updated {
         $eventparams = [
             'objectid' => $category->get('id'),
             'context'  => $category->get_handler()->get_configuration_context(),

customfield/classes/event/field_created.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param field_controller $field
      * @return field_created
      */
-    public static function create_from_object(field_controller $field): field_created {
+    public static function create_from_object(field_controller $field) : field_created {
         $eventparams = [
             'objectid' => $field->get('id'),
             'context'  => $field->get_handler()->get_configuration_context(),

customfield/classes/event/field_deleted.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param field_controller $field
      * @return field_deleted
      */
-    public static function create_from_object(field_controller $field): field_deleted {
+    public static function create_from_object(field_controller $field) : field_deleted {
         $eventparams = [
             'objectid' => $field->get('id'),
             'context'  => $field->get_handler()->get_configuration_context(),

customfield/classes/event/field_updated.php

@@ -53,7 +53,7 @@ protected function init() {
      * @param field_controller $field
      * @return field_updated
      */
-    public static function create_from_object(field_controller $field): field_updated {
+    public static function create_from_object(field_controller $field) : field_updated {
         $eventparams = [
             'objectid' => $field->get('id'),
             'context'  => $field->get_handler()->get_configuration_context(),

customfield/classes/field.php

@@ -47,7 +47,7 @@ class field extends persistent {
      *
      * @return array
      */
-    protected static function define_properties(): array {
+    protected static function define_properties() : array {
         return array(
                 'name' => [
                         'type' => PARAM_TEXT,
@@ -91,7 +91,7 @@ protected static function define_properties(): array {
      *
      * @return array
      */
-    protected function get_configdata(): array {
+    protected function get_configdata() : array {
         return json_decode($this->raw_get('configdata'), true) ?? array();
     }
 }

customfield/classes/field_controller.php

@@ -81,7 +81,7 @@ public function __construct(int $id = 0, \stdClass $record = null) {
      * @throws \coding_exception
      * @throws \moodle_exception
      */
-    public static function create(int $id, \stdClass $record = null, category_controller $category = null): field_controller {
+    public static function create(int $id, \stdClass $record = null, category_controller $category = null) : field_controller {
         global $DB;
         if ($id && $record) {
             // This warning really should be in persistent as well.
@@ -132,7 +132,7 @@ public static function create(int $id, \stdClass $record = null, category_contro
      * @param array $files
      * @return array associative array of error messages
      */
-    public function config_form_validation(array $data, $files = array()): array {
+    public function config_form_validation(array $data, $files = array()) : array {
         return array();
     }
 
@@ -167,7 +167,7 @@ final public function set($property, $value) {
      *
      * @return bool
      */
-    public function delete(): bool {
+    public function delete() : bool {
         global $DB;
         $DB->delete_records('customfield_data', ['fieldid' => $this->get('id')]);
         return $this->field->delete();
@@ -196,7 +196,7 @@ final public function to_record() {
      *
      * @return category_controller
      */
-    public final function get_category(): category_controller {
+    public final function get_category() : category_controller {
         return $this->category;
     }
 
@@ -219,7 +219,7 @@ public function get_configdata_property(string $property) {
      *
      * @return handler
      */
-    public final function get_handler(): handler {
+    public final function get_handler() : handler {
         return $this->get_category()->get_handler();
     }
 
@@ -245,7 +245,7 @@ public abstract function config_form_definition(\MoodleQuickForm $mform);
      *
      * @return string
      */
-    public function get_formatted_name(): string {
+    public function get_formatted_name() : string {
         $context = $this->get_handler()->get_configuration_context();
         return format_string($this->get('name'), true, ['context' => $context]);
     }