mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 00:46:50 +02:00
MDL-49409 mod_data: Create exporters for record and content
This commit is contained in:
Juan Leyva
parent
31aae5d459
commit
5b901787db
2 changed files with 230 additions and 0 deletions
106
mod/data/classes/external/content_exporter.php
vendored
Normal file
106
mod/data/classes/external/content_exporter.php
vendored
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Class for exporting content associated to a record.
|
||||
*
|
||||
* @package mod_data
|
||||
* @copyright 2017 Juan Leyva <juan@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace mod_data\external;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
use core\external\exporter;
|
||||
use renderer_base;
|
||||
use external_files;
|
||||
use external_util;
|
||||
|
||||
/**
|
||||
* Class for exporting content associated to a record.
|
||||
*
|
||||
* @copyright 2017 Juan Leyva <juan@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class content_exporter extends exporter {
|
||||
|
||||
protected static function define_properties() {
|
||||
|
||||
return array(
|
||||
'id' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'Content id.',
|
||||
),
|
||||
'fieldid' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'The field type of the content.',
|
||||
'default' => 0,
|
||||
),
|
||||
'recordid' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'The record this content belongs to.',
|
||||
'default' => 0,
|
||||
),
|
||||
'content' => array(
|
||||
'type' => PARAM_RAW,
|
||||
'description' => 'Contents.',
|
||||
'null' => NULL_ALLOWED,
|
||||
),
|
||||
'content1' => array(
|
||||
'type' => PARAM_RAW,
|
||||
'description' => 'Contents.',
|
||||
'null' => NULL_ALLOWED,
|
||||
),
|
||||
'content2' => array(
|
||||
'type' => PARAM_RAW,
|
||||
'description' => 'Contents.',
|
||||
'null' => NULL_ALLOWED,
|
||||
),
|
||||
'content3' => array(
|
||||
'type' => PARAM_BOOL,
|
||||
'description' => 'Contents.',
|
||||
'null' => NULL_ALLOWED,
|
||||
),
|
||||
'content4' => array(
|
||||
'type' => PARAM_BOOL,
|
||||
'description' => 'Contents.',
|
||||
'null' => NULL_ALLOWED,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
protected static function define_related() {
|
||||
return array(
|
||||
'context' => 'context',
|
||||
);
|
||||
}
|
||||
|
||||
protected static function define_other_properties() {
|
||||
return array(
|
||||
'files' => array(
|
||||
'type' => external_files::get_properties_for_exporter(),
|
||||
'multiple' => true,
|
||||
'optional' => true,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
protected function get_other_values(renderer_base $output) {
|
||||
$values = ['files' => external_util::get_area_files($this->related['context']->id, 'mod_data', 'content', $this->data->id)];
|
||||
|
||||
return $values;
|
||||
}
|
||||
}
|
||||
124
mod/data/classes/external/record_exporter.php
vendored
Normal file
124
mod/data/classes/external/record_exporter.php
vendored
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
/**
|
||||
* Class for exporting record data.
|
||||
*
|
||||
* @package mod_data
|
||||
* @copyright 2017 Juan Leyva <juan@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace mod_data\external;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
use core\external\exporter;
|
||||
use renderer_base;
|
||||
|
||||
/**
|
||||
* Class for exporting record data.
|
||||
*
|
||||
* @copyright 2017 Juan Leyva <juan@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class record_exporter extends exporter {
|
||||
|
||||
protected static function define_properties() {
|
||||
|
||||
return array(
|
||||
'id' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'Record id.',
|
||||
),
|
||||
'userid' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'The id of the user who created the record.',
|
||||
'default' => 0,
|
||||
),
|
||||
'groupid' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'The group id this record belongs to (0 for no groups).',
|
||||
'default' => 0,
|
||||
),
|
||||
'dataid' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'The database id this record belongs to.',
|
||||
'default' => 0,
|
||||
),
|
||||
'timecreated' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'Time the record was created.',
|
||||
'default' => 0,
|
||||
),
|
||||
'timemodified' => array(
|
||||
'type' => PARAM_INT,
|
||||
'description' => 'Last time the record was modified.',
|
||||
'default' => 0,
|
||||
),
|
||||
'approved' => array(
|
||||
'type' => PARAM_BOOL,
|
||||
'description' => 'Whether the entry has been approved (if the database is configured in that way).',
|
||||
'default' => 0,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
protected static function define_related() {
|
||||
return array(
|
||||
'database' => 'stdClass',
|
||||
'user' => 'stdClass',
|
||||
'context' => 'context',
|
||||
'contents' => 'stdClass[]?',
|
||||
);
|
||||
}
|
||||
|
||||
protected static function define_other_properties() {
|
||||
return array(
|
||||
'canmanageentry' => array(
|
||||
'type' => PARAM_BOOL,
|
||||
'description' => 'Whether the current user can manage this entry',
|
||||
),
|
||||
'fullname' => array(
|
||||
'type' => PARAM_TEXT,
|
||||
'description' => 'The user who created the entry fullname.',
|
||||
),
|
||||
'contents' => array(
|
||||
'type' => content_exporter::read_properties_definition(),
|
||||
'description' => 'The record contents.',
|
||||
'multiple' => true,
|
||||
'optional' => true,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
protected function get_other_values(renderer_base $output) {
|
||||
global $PAGE;
|
||||
|
||||
$values = array(
|
||||
'canmanageentry' => data_user_can_manage_entry($this->data, $this->related['database'], $this->related['context']),
|
||||
'fullname' => fullname($this->related['user']),
|
||||
);
|
||||
if (!empty($this->related['contents'])) {
|
||||
$contents = [];
|
||||
foreach ($this->related['contents'] as $content) {
|
||||
$related = array('context' => $this->related['context']);
|
||||
$exporter = new content_exporter($content, $related);
|
||||
$contents[] = $exporter->export($PAGE->get_renderer('core'));
|
||||
}
|
||||
$values['contents'] = $contents;
|
||||
}
|
||||
return $values;
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue