ba1f804ffa
This has been generated running the following Sniffs, all them part of the Moodle's CodeSniffer standard: - PSR12.Functions.ReturnTypeDeclaration - PSR12.Functions.NullableTypeDeclaration - moodle.Methods.MethodDeclarationSpacing - Squiz.Whitespace.ScopeKeywordSpacing All them are, exclusively, about correct spacing, so the changes are, all them, only white space changes. Only exceptions to the above are 3 changes what were setting the return type in a new line, and, when that happens, the closing parenthesis (bracket) has to go to the same line than the colon.
102 lines
2.8 KiB
PHP
102 lines
2.8 KiB
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/>.
|
|
|
|
/**
|
|
* User profile set indicator.
|
|
*
|
|
* @package core_user
|
|
* @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_user\analytics\indicator;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* User profile set indicator.
|
|
*
|
|
* @package core_user
|
|
* @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class user_profile_set extends \core_analytics\local\indicator\linear {
|
|
|
|
/**
|
|
* Returns the name.
|
|
*
|
|
* If there is a corresponding '_help' string this will be shown as well.
|
|
*
|
|
* @return \lang_string
|
|
*/
|
|
public static function get_name(): \lang_string {
|
|
return new \lang_string('indicator:completeduserprofile');
|
|
}
|
|
|
|
/**
|
|
* required_sample_data
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public static function required_sample_data() {
|
|
return array('user');
|
|
}
|
|
|
|
/**
|
|
* calculate_sample
|
|
*
|
|
* @param int $sampleid
|
|
* @param string $sampleorigin
|
|
* @param int $starttime
|
|
* @param int $endtime
|
|
* @return float
|
|
*/
|
|
protected function calculate_sample($sampleid, $sampleorigin, $starttime = false, $endtime = false) {
|
|
global $CFG;
|
|
|
|
$user = $this->retrieve('user', $sampleid);
|
|
|
|
// Nothing set results in -1.
|
|
$calculatedvalue = self::MIN_VALUE;
|
|
|
|
if (\core_user::awaiting_action($user)) {
|
|
return self::MIN_VALUE;
|
|
}
|
|
|
|
if (!$user->confirmed) {
|
|
return self::MIN_VALUE;
|
|
}
|
|
|
|
if ($user->description != '') {
|
|
$calculatedvalue += 1;
|
|
}
|
|
|
|
if ($user->picture != '') {
|
|
$calculatedvalue += 1;
|
|
}
|
|
|
|
// 0.2 for any of the following fields being set (some of them may even be compulsory or have a default).
|
|
$fields = array('institution', 'department', 'address', 'city', 'country');
|
|
foreach ($fields as $fieldname) {
|
|
if ($user->{$fieldname} != '') {
|
|
$calculatedvalue += 0.2;
|
|
}
|
|
}
|
|
|
|
return $this->limit_value($calculatedvalue);
|
|
}
|
|
}
|