Current File : /home/vacivi36/ava/message/classes/output/messagearea/user_search_results.php
<?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/>.
/**
* Contains class used to display user search results.
*
* TODO: This file should be removed once the related web services go through final deprecation.
* Followup: MDL-63261
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_message\output\messagearea;
defined('MOODLE_INTERNAL') || die();
use renderable;
use templatable;
/**
* Class used to display user search results.
*
* @package core_message
* @copyright 2016 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class user_search_results implements templatable, renderable {
/**
* @var array The list of contacts.
*/
public $contacts;
/**
* @var array The list of courses.
*/
public $courses;
/**
* @var array The list of non-contacts.
*/
public $noncontacts;
/**
* Constructor.
*
* @param array $contacts list of contacts.
* @param array $courses list of courses.
* @param array $noncontacts list of nonconcat users.
*/
public function __construct($contacts, $courses = array(), $noncontacts = array()) {
$this->contacts = $contacts;
$this->courses = $courses;
$this->noncontacts = $noncontacts;
}
public function export_for_template(\renderer_base $output) {
// Set the defaults for the data we are going to export.
$data = new \stdClass();
$data->hascontacts = false;
$data->contacts = array();
$data->hascourses = false;
$data->courses = array();
$data->hasnoncontacts = false;
$data->noncontacts = array();
// Check if there are any contacts.
if (!empty($this->contacts)) {
$data->hascontacts = true;
foreach ($this->contacts as $contact) {
$contact = new contact($contact);
$data->contacts[] = $contact->export_for_template($output);
}
}
// Check if there are any courses.
if (!empty($this->courses)) {
$data->hascourses = true;
$data->courses = [];
foreach ($this->courses as $course) {
$coursecontext = \context_course::instance($course->id);
$course->shortname = external_format_string($course->shortname, $coursecontext->id, true);
$course->fullname = external_format_string($course->fullname, $coursecontext->id, true);
$data->courses[] = $course;
}
}
// Check if there are any non-contacts.
if (!empty($this->noncontacts)) {
$data->hasnoncontacts = true;
foreach ($this->noncontacts as $noncontact) {
$noncontact = new contact($noncontact);
$data->noncontacts[] = $noncontact->export_for_template($output);
}
}
return $data;
}
}
Mini Shell