mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 20:42:22 +02:00
Code Issues Projects Releases Wiki Activity

MDL-64820 core: Exporter read_definition

Browse Source 
Modified the read_properties_definition to recursively check and set the default array values expected.
This commit is contained in:
Peter 2019-03-11 09:21:54 +08:00 committed by Ryan Wyllie
parent 3271c39c74
commit 432cdac4bd
2 changed files with 29 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
lib/classes/external/exporter.php vendored
View File

@ -261,16 +261,32 @@ abstract class exporter {
final public static function read_properties_definition() {
$properties = static::properties_definition();
$customprops = static::define_other_properties();
foreach ($customprops as $property => $definition) {
$customprops = static::format_properties($customprops);
$properties += $customprops;
return $properties;
}
/**
* Recursively formats a given property definition with the default fields required.
*
* @param array $properties List of properties to format
* @return array Formatted array
*/
final public static function format_properties($properties) {
foreach ($properties as $property => $definition) {
// Ensures that null is set to its default.
if (!isset($definition['null'])) {
$customprops[$property]['null'] = NULL_NOT_ALLOWED;
$properties[$property]['null'] = NULL_NOT_ALLOWED;
}
if (!isset($definition['description'])) {
$customprops[$property]['description'] = $property;
$properties[$property]['description'] = $property;
}
// If an array is provided, it may be a nested array that is unformatted so rinse and repeat.
if (is_array($definition['type'])) {
$properties[$property]['type'] = static::format_properties($definition['type']);
}
}
$properties += $customprops;
return $properties;
}

9
lib/tests/exporter_test.php
View File

@ -179,6 +179,8 @@ class core_exporter_testcase extends advanced_testcase {
$this->assertEquals('otherstring description', $properties['otherstring']['description']);
// Other properties default description.
$this->assertEquals('otherstrings', $properties['otherstrings']['description']);
// Assert nested elements are formatted correctly.
$this->assertEquals('id', $properties['nestedarray']['type']['id']['description']);
}
}
@ -228,6 +230,13 @@ class core_testable_exporter extends \core\external\exporter {
'otherstrings' => array(
'type' => PARAM_TEXT,
'multiple' => true
),
'nestedarray' => array(
'multiple' => true,
'optional' => true,
'type' => [
'id' => ['type' => PARAM_INT]
]
)
);
}