moodle_local_treestudyplan/classes/success.php

117 lines
3.2 KiB
PHP
Raw Normal View History

<?php
2023-08-24 23:02:41 +02:00
// This file is part of the Studyplan plugin for Moodle
//
// 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 <https://www.gnu.org/licenses/>.
/**
2023-08-27 22:20:17 +02:00
* Webservice return value to describe a single event as successful or not
2023-08-24 23:02:41 +02:00
* @package local_treestudyplan
* @copyright 2023 P.M. Kuipers
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace local_treestudyplan;
2023-08-27 15:12:54 +02:00
/**
* Describes a webservice result a successful or not with optional message
*/
class success {
2023-08-27 15:12:54 +02:00
/**
* Success (true) or failed (false)
* @var bool
*/
private $success;
2023-08-27 15:12:54 +02:00
/**
* Messsage passed with result
* @var string
*/
private $msg;
2023-08-27 15:12:54 +02:00
/**
* Create new successful result with optional message
* @param array|object $data Custom data to pass to receiver
2023-08-27 15:12:54 +02:00
*/
2024-06-02 19:23:40 +02:00
public static function success($data=[]): self {
return new self(true, 'success', $data);
}
2023-08-27 15:12:54 +02:00
/**
* Create new failed result with optional message
* @param string $msg Message to add to result
* @param array|object $data Custom data to pass to receiver
2023-08-27 15:12:54 +02:00
*/
2024-06-02 19:23:40 +02:00
public static function fail($msg = "", $data=[]): self {
return new self(false, $msg, $data);
}
2023-08-27 15:12:54 +02:00
/**
* Create new succes result
* @param bool $success Whether result is succesful or not
* @param string $msg Message to add to result
* @param array|object $data Custom data to pass to receiver
2023-08-27 15:12:54 +02:00
*/
public function __construct($success, $msg, $data=[]) {
2024-06-02 23:23:32 +02:00
$this->success = ($success) ? true : false;
$this->msg = $msg;
$this->data = json_encode($data);
}
2023-08-27 15:12:54 +02:00
/**
2023-08-27 17:00:23 +02:00
* Describe the result for the webservice model
2023-08-27 15:12:54 +02:00
*/
2024-06-02 19:23:40 +02:00
public static function structure(): \external_description {
return new \external_single_structure([
"success" => new \external_value(PARAM_BOOL, 'operation completed succesfully'),
2023-11-11 20:17:45 +01:00
"msg" => new \external_value(PARAM_RAW, 'message'),
"data" => new \external_value(PARAM_RAW, 'message'),
]);
}
2023-08-27 15:12:54 +02:00
/**
* Make the webservice result model
* @return array Webservice value
*/
public function model() {
return ["success" => $this->success, "msg" => $this->msg, "data" => $this->data];
}
2023-08-27 15:12:54 +02:00
/**
* Get success status of object
*
* @return bool If this success is successful or not
*/
2023-08-24 23:02:41 +02:00
public function successful() {
return $this->success;
}
2023-08-27 15:12:54 +02:00
/**
* Get message
*
* @return string Message
*/
2023-08-24 23:02:41 +02:00
public function msg() {
return $this->msg;
}
/**
* Get data
*
* @return string Message
*/
public function data() {
return json_decode($this->data);
}
2023-08-25 11:52:05 +02:00
}