/mod/lti/service/toolsettings/classes/local/service/toolsettings.php
https://gitlab.com/unofficial-mirrors/moodle · PHP · 138 lines · 64 code · 19 blank · 55 comment · 15 complexity · a1198098ac47aac3d9458b56553a4fe4 MD5 · raw file
- <?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/>.
- /**
- * This file contains a class definition for the Tool Settings service
- *
- * @package ltiservice_toolsettings
- * @copyright 2014 Vital Source Technologies http://vitalsource.com
- * @author Stephen Vickers
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- namespace ltiservice_toolsettings\local\service;
- defined('MOODLE_INTERNAL') || die();
- /**
- * A service implementing Tool Settings.
- *
- * @package ltiservice_toolsettings
- * @since Moodle 2.8
- * @copyright 2014 Vital Source Technologies http://vitalsource.com
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class toolsettings extends \mod_lti\local\ltiservice\service_base {
- /**
- * Class constructor.
- */
- public function __construct() {
- parent::__construct();
- $this->id = 'toolsettings';
- $this->name = 'Tool Settings';
- }
- /**
- * Get the resources for this service.
- *
- * @return array
- */
- public function get_resources() {
- if (empty($this->resources)) {
- $this->resources = array();
- $this->resources[] = new \ltiservice_toolsettings\local\resources\systemsettings($this);
- $this->resources[] = new \ltiservice_toolsettings\local\resources\contextsettings($this);
- $this->resources[] = new \ltiservice_toolsettings\local\resources\linksettings($this);
- }
- return $this->resources;
- }
- /**
- * Get the distinct settings from each level by removing any duplicates from higher levels.
- *
- * @param array $systemsettings System level settings
- * @param array $contextsettings Context level settings
- * @param array $linksettings Link level settings
- */
- public static function distinct_settings(&$systemsettings, &$contextsettings, $linksettings) {
- if (!empty($systemsettings)) {
- foreach ($systemsettings as $key => $value) {
- if ((!empty($contextsettings) && array_key_exists($key, $contextsettings)) ||
- (!empty($linksettings) && array_key_exists($key, $linksettings))) {
- unset($systemsettings[$key]);
- }
- }
- }
- if (!empty($contextsettings)) {
- foreach ($contextsettings as $key => $value) {
- if (!empty($linksettings) && array_key_exists($key, $linksettings)) {
- unset($contextsettings[$key]);
- }
- }
- }
- }
- /**
- * Get the JSON representation of the settings.
- *
- * @param array $settings Settings
- * @param boolean $simpleformat <code>true</code> if simple JSON is to be returned
- * @param string $type JSON-LD type
- * @param \mod_lti\local\ltiservice\resource_base $resource Resource handling the request
- *
- * @return string
- */
- public static function settings_to_json($settings, $simpleformat, $type, $resource) {
- $json = '';
- if (!empty($resource)) {
- $indent = '';
- if (!$simpleformat) {
- $json .= " {\n \"@type\":\"{$type}\",\n";
- $json .= " \"@id\":\"{$resource->get_endpoint()}\",\n";
- $json .= " \"custom\":{\n";
- $json .= " \"@id\":\"{$resource->get_endpoint()}/custom\"";
- $indent = ' ';
- }
- $isfirst = $simpleformat;
- if (!empty($settings)) {
- foreach ($settings as $key => $value) {
- if (!$isfirst) {
- $json .= ',';
- } else {
- $isfirst = false;
- }
- $json .= "\n{$indent} \"{$key}\":\"{$value}\"";
- }
- }
- if (!$simpleformat) {
- $json .= "\n{$indent}}\n }";
- }
- }
- return $json;
- }
- }