public function definition()
{
global $CFG, $DB;
$strrequired = get_string('required');
$mform =& $this->_form;
$huburl = $this->_customdata['huburl'];
$hubname = $this->_customdata['hubname'];
$password = $this->_customdata['password'];
$admin = get_admin();
$site = get_site();
//retrieve config for this hub and set default if they don't exist
$cleanhuburl = clean_param($huburl, PARAM_ALPHANUMEXT);
$sitename = get_config('hub', 'site_name_' . $cleanhuburl);
if ($sitename === false) {
$sitename = format_string($site->fullname, true, array('context' => context_course::instance(SITEID)));
}
$sitedescription = get_config('hub', 'site_description_' . $cleanhuburl);
if ($sitedescription === false) {
$sitedescription = $site->summary;
}
$contactname = get_config('hub', 'site_contactname_' . $cleanhuburl);
if ($contactname === false) {
$contactname = fullname($admin, true);
}
$contactemail = get_config('hub', 'site_contactemail_' . $cleanhuburl);
if ($contactemail === false) {
$contactemail = $admin->email;
}
$contactphone = get_config('hub', 'site_contactphone_' . $cleanhuburl);
if ($contactphone === false) {
$contactphone = $admin->phone1;
}
$imageurl = get_config('hub', 'site_imageurl_' . $cleanhuburl);
$privacy = get_config('hub', 'site_privacy_' . $cleanhuburl);
$address = get_config('hub', 'site_address_' . $cleanhuburl);
$region = get_config('hub', 'site_region_' . $cleanhuburl);
$country = get_config('hub', 'site_country_' . $cleanhuburl);
if ($country === false) {
$country = $admin->country;
}
$language = get_config('hub', 'site_language_' . $cleanhuburl);
if ($language === false) {
$language = current_language();
}
$geolocation = get_config('hub', 'site_geolocation_' . $cleanhuburl);
$contactable = get_config('hub', 'site_contactable_' . $cleanhuburl);
$emailalert = get_config('hub', 'site_emailalert_' . $cleanhuburl);
$emailalert = $emailalert === 0 ? 0 : 1;
$coursesnumber = get_config('hub', 'site_coursesnumber_' . $cleanhuburl);
$usersnumber = get_config('hub', 'site_usersnumber_' . $cleanhuburl);
$roleassignmentsnumber = get_config('hub', 'site_roleassignmentsnumber_' . $cleanhuburl);
$postsnumber = get_config('hub', 'site_postsnumber_' . $cleanhuburl);
$questionsnumber = get_config('hub', 'site_questionsnumber_' . $cleanhuburl);
$resourcesnumber = get_config('hub', 'site_resourcesnumber_' . $cleanhuburl);
$badgesnumber = get_config('hub', 'site_badges_' . $cleanhuburl);
$issuedbadgesnumber = get_config('hub', 'site_issuedbadges_' . $cleanhuburl);
$mediancoursesize = get_config('hub', 'site_mediancoursesize_' . $cleanhuburl);
$participantnumberaveragecfg = get_config('hub', 'site_participantnumberaverage_' . $cleanhuburl);
$modulenumberaveragecfg = get_config('hub', 'site_modulenumberaverage_' . $cleanhuburl);
//hidden parameters
$mform->addElement('hidden', 'huburl', $huburl);
$mform->setType('huburl', PARAM_URL);
$mform->addElement('hidden', 'hubname', $hubname);
$mform->setType('hubname', PARAM_TEXT);
$mform->addElement('hidden', 'password', $password);
$mform->setType('password', PARAM_RAW);
//the input parameters
$mform->addElement('header', 'moodle', get_string('registrationinfo', 'hub'));
$mform->addElement('text', 'name', get_string('sitename', 'hub'), array('class' => 'registration_textfield'));
$mform->addRule('name', $strrequired, 'required', null, 'client');
$mform->setType('name', PARAM_TEXT);
$mform->setDefault('name', $sitename);
$mform->addHelpButton('name', 'sitename', 'hub');
$options = array();
$registrationmanager = new registration_manager();
$options[HUB_SITENOTPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENOTPUBLISHED);
$options[HUB_SITENAMEPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENAMEPUBLISHED);
$options[HUB_SITELINKPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITELINKPUBLISHED);
$mform->addElement('select', 'privacy', get_string('siteprivacy', 'hub'), $options);
$mform->setDefault('privacy', $privacy);
$mform->setType('privacy', PARAM_ALPHA);
$mform->addHelpButton('privacy', 'privacy', 'hub');
unset($options);
$mform->addElement('textarea', 'description', get_string('sitedesc', 'hub'), array('rows' => 8, 'cols' => 41));
$mform->addRule('description', $strrequired, 'required', null, 'client');
$mform->setDefault('description', $sitedescription);
$mform->setType('description', PARAM_TEXT);
$mform->addHelpButton('description', 'sitedesc', 'hub');
$languages = get_string_manager()->get_list_of_languages();
collatorlib::asort($languages);
$mform->addElement('select', 'language', get_string('sitelang', 'hub'), $languages);
$mform->setType('language', PARAM_ALPHANUMEXT);
$mform->addHelpButton('language', 'sitelang', 'hub');
$mform->setDefault('language', $language);
$mform->addElement('textarea', 'address', get_string('postaladdress', 'hub'), array('rows' => 4, 'cols' => 41));
$mform->setType('address', PARAM_TEXT);
$mform->setDefault('address', $address);
$mform->addHelpButton('address', 'postaladdress', 'hub');
//TODO: use the region array I generated
// $mform->addElement('select', 'region', get_string('selectaregion'), array('-' => '-'));
// $mform->setDefault('region', $region);
$mform->addElement('hidden', 'regioncode', '-');
$mform->setType('regioncode', PARAM_ALPHANUMEXT);
$countries = get_string_manager()->get_list_of_countries();
$mform->addElement('select', 'countrycode', get_string('sitecountry', 'hub'), $countries);
$mform->setDefault('countrycode', $country);
$mform->setType('countrycode', PARAM_ALPHANUMEXT);
$mform->addHelpButton('countrycode', 'sitecountry', 'hub');
$mform->addElement('text', 'geolocation', get_string('sitegeolocation', 'hub'), array('class' => 'registration_textfield'));
$mform->setDefault('geolocation', $geolocation);
$mform->setType('geolocation', PARAM_RAW);
$mform->addHelpButton('geolocation', 'sitegeolocation', 'hub');
$mform->addElement('text', 'contactname', get_string('siteadmin', 'hub'), array('class' => 'registration_textfield'));
$mform->addRule('contactname', $strrequired, 'required', null, 'client');
$mform->setType('contactname', PARAM_TEXT);
$mform->setDefault('contactname', $contactname);
$mform->addHelpButton('contactname', 'siteadmin', 'hub');
$mform->addElement('text', 'contactphone', get_string('sitephone', 'hub'), array('class' => 'registration_textfield'));
$mform->setType('contactphone', PARAM_TEXT);
$mform->addHelpButton('contactphone', 'sitephone', 'hub');
$mform->addElement('text', 'contactemail', get_string('siteemail', 'hub'), array('class' => 'registration_textfield'));
$mform->addRule('contactemail', $strrequired, 'required', null, 'client');
$mform->setType('contactemail', PARAM_EMAIL);
$mform->setDefault('contactemail', $contactemail);
$mform->addHelpButton('contactemail', 'siteemail', 'hub');
$options = array();
$options[0] = get_string("registrationcontactno");
$options[1] = get_string("registrationcontactyes");
$mform->addElement('select', 'contactable', get_string('siteregistrationcontact', 'hub'), $options);
$mform->setDefault('contactable', $contactable);
$mform->setType('contactable', PARAM_INT);
$mform->addHelpButton('contactable', 'siteregistrationcontact', 'hub');
unset($options);
$options = array();
$options[0] = get_string("registrationno");
$options[1] = get_string("registrationyes");
$mform->addElement('select', 'emailalert', get_string('siteregistrationemail', 'hub'), $options);
$mform->setDefault('emailalert', $emailalert);
$mform->setType('emailalert', PARAM_INT);
$mform->addHelpButton('emailalert', 'siteregistrationemail', 'hub');
unset($options);
//TODO site logo
$mform->addElement('hidden', 'imageurl', '');
//TODO: temporary
$mform->setType('imageurl', PARAM_URL);
$mform->addElement('static', 'urlstring', get_string('siteurl', 'hub'), $CFG->wwwroot);
$mform->addHelpButton('urlstring', 'siteurl', 'hub');
$mform->addElement('static', 'versionstring', get_string('siteversion', 'hub'), $CFG->version);
$mform->addElement('hidden', 'moodleversion', $CFG->version);
$mform->setType('moodleversion', PARAM_INT);
$mform->addHelpButton('versionstring', 'siteversion', 'hub');
$mform->addElement('static', 'releasestring', get_string('siterelease', 'hub'), $CFG->release);
$mform->addElement('hidden', 'moodlerelease', $CFG->release);
$mform->setType('moodlerelease', PARAM_TEXT);
$mform->addHelpButton('releasestring', 'siterelease', 'hub');
/// Display statistic that are going to be retrieve by the hub
$coursecount = $DB->count_records('course') - 1;
$usercount = $DB->count_records('user', array('deleted' => 0));
$roleassigncount = $DB->count_records('role_assignments');
$postcount = $DB->count_records('forum_posts');
$questioncount = $DB->count_records('question');
$resourcecount = $DB->count_records('resource');
require_once $CFG->dirroot . "/course/lib.php";
$participantnumberaverage = number_format(average_number_of_participants(), 2);
$modulenumberaverage = number_format(average_number_of_courses_modules(), 2);
require_once $CFG->libdir . '/badgeslib.php';
$badges = $DB->count_records_select('badge', 'status <> ' . BADGE_STATUS_ARCHIVED);
$issuedbadges = $DB->count_records('badge_issued');
if (HUB_MOODLEORGHUBURL != $huburl) {
$mform->addElement('checkbox', 'courses', get_string('sendfollowinginfo', 'hub'), " " . get_string('coursesnumber', 'hub', $coursecount));
$mform->setDefault('courses', $coursesnumber != -1);
$mform->setType('courses', PARAM_INT);
$mform->addHelpButton('courses', 'sendfollowinginfo', 'hub');
$mform->addElement('checkbox', 'users', '', " " . get_string('usersnumber', 'hub', $usercount));
$mform->setDefault('users', $usersnumber != -1);
$mform->setType('users', PARAM_INT);
$mform->addElement('checkbox', 'roleassignments', '', " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
$mform->setDefault('roleassignments', $roleassignmentsnumber != -1);
$mform->setType('roleassignments', PARAM_INT);
$mform->addElement('checkbox', 'posts', '', " " . get_string('postsnumber', 'hub', $postcount));
$mform->setDefault('posts', $postsnumber != -1);
$mform->setType('posts', PARAM_INT);
$mform->addElement('checkbox', 'questions', '', " " . get_string('questionsnumber', 'hub', $questioncount));
$mform->setDefault('questions', $questionsnumber != -1);
$mform->setType('questions', PARAM_INT);
$mform->addElement('checkbox', 'resources', '', " " . get_string('resourcesnumber', 'hub', $resourcecount));
$mform->setDefault('resources', $resourcesnumber != -1);
$mform->setType('resources', PARAM_INT);
$mform->addElement('checkbox', 'badges', '', " " . get_string('badgesnumber', 'hub', $badges));
$mform->setDefault('badges', $badgesnumber != -1);
$mform->setType('resources', PARAM_INT);
$mform->addElement('checkbox', 'issuedbadges', '', " " . get_string('issuedbadgesnumber', 'hub', $issuedbadges));
$mform->setDefault('issuedbadges', $issuedbadgesnumber != -1);
$mform->setType('resources', PARAM_INT);
$mform->addElement('checkbox', 'participantnumberaverage', '', " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
$mform->setDefault('participantnumberaverage', $participantnumberaveragecfg != -1);
$mform->setType('participantnumberaverage', PARAM_FLOAT);
$mform->addElement('checkbox', 'modulenumberaverage', '', " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
$mform->setDefault('modulenumberaverage', $modulenumberaveragecfg != -1);
$mform->setType('modulenumberaverage', PARAM_FLOAT);
} else {
$mform->addElement('static', 'courseslabel', get_string('sendfollowinginfo', 'hub'), " " . get_string('coursesnumber', 'hub', $coursecount));
$mform->addElement('hidden', 'courses', 1);
$mform->setType('courses', PARAM_INT);
$mform->addHelpButton('courseslabel', 'sendfollowinginfo', 'hub');
$mform->addElement('static', 'userslabel', '', " " . get_string('usersnumber', 'hub', $usercount));
$mform->addElement('hidden', 'users', 1);
$mform->setType('users', PARAM_INT);
$mform->addElement('static', 'roleassignmentslabel', '', " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
$mform->addElement('hidden', 'roleassignments', 1);
$mform->setType('roleassignments', PARAM_INT);
$mform->addElement('static', 'postslabel', '', " " . get_string('postsnumber', 'hub', $postcount));
$mform->addElement('hidden', 'posts', 1);
$mform->setType('posts', PARAM_INT);
$mform->addElement('static', 'questionslabel', '', " " . get_string('questionsnumber', 'hub', $questioncount));
$mform->addElement('hidden', 'questions', 1);
$mform->setType('questions', PARAM_INT);
$mform->addElement('static', 'resourceslabel', '', " " . get_string('resourcesnumber', 'hub', $resourcecount));
$mform->addElement('hidden', 'resources', 1);
$mform->setType('resources', PARAM_INT);
$mform->addElement('static', 'badgeslabel', '', " " . get_string('badgesnumber', 'hub', $badges));
$mform->addElement('hidden', 'badges', 1);
$mform->setType('badges', PARAM_INT);
$mform->addElement('static', 'issuedbadgeslabel', '', " " . get_string('issuedbadgesnumber', 'hub', $issuedbadges));
$mform->addElement('hidden', 'issuedbadges', true);
$mform->setType('issuedbadges', PARAM_INT);
$mform->addElement('static', 'participantnumberaveragelabel', '', " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
$mform->addElement('hidden', 'participantnumberaverage', 1);
$mform->setType('participantnumberaverage', PARAM_FLOAT);
$mform->addElement('static', 'modulenumberaveragelabel', '', " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
$mform->addElement('hidden', 'modulenumberaverage', 1);
$mform->setType('modulenumberaverage', PARAM_FLOAT);
}
//check if it's a first registration or update
$hubregistered = $registrationmanager->get_registeredhub($huburl);
if (!empty($hubregistered)) {
$buttonlabel = get_string('updatesite', 'hub', !empty($hubname) ? $hubname : $huburl);
$mform->addElement('hidden', 'update', true);
$mform->setType('update', PARAM_BOOL);
} else {
$buttonlabel = get_string('registersite', 'hub', !empty($hubname) ? $hubname : $huburl);
}
$this->add_action_buttons(false, $buttonlabel);
}
/**
* Display a list of sites
* If $withwriteaccess = true, we display visible field,
* trust/prioritise button, and timecreated/modified information.
* @param array $sites
* @param boolean $withwriteaccess
* @return string
*/
public function site_list($sites, $withwriteaccess = false, $displaysecret = false)
{
global $CFG;
$renderedhtml = '';
$brtag = html_writer::empty_tag('br');
$table = new html_table();
if ($withwriteaccess) {
$table->head = array('', get_string('sitename', 'local_hub'), get_string('sitedesc', 'local_hub'), get_string('sitelang', 'local_hub'), get_string('siteadmin', 'local_hub'), get_string('operation', 'local_hub'), '');
$table->align = array('center', 'left', 'left', 'center', 'center', 'center', 'center', 'center');
$table->size = array('1%', '25%', '40%', '5%', '5%');
} else {
$table->head = array('', get_string('sitename', 'local_hub'), get_string('sitedesc', 'local_hub'), get_string('sitelang', 'local_hub'));
$table->align = array('center', 'left', 'left', 'center');
$table->size = array('10%', '25%', '60%', '5%');
}
if (empty($sites)) {
if (isset($sites)) {
$renderedhtml .= get_string('nosite', 'local_hub');
}
} else {
$table->width = '100%';
$table->data = array();
$table->attributes['class'] = 'sitedirectory';
// iterate through sites and add to the display table
foreach ($sites as $site) {
//create site name with link
$siteurl = new moodle_url($site->url);
$siteatag = html_writer::tag('a', $site->name, array('href' => $siteurl));
$sitenamespan = html_writer::span($siteatag);
$siteurlspan = html_writer::span($siteurl, 'additionaldesc');
$sitenamehtml = $sitenamespan . '<br>' . $siteurlspan;
//create image tag
if (!empty($site->imageurl)) {
$imageurl = new moodle_url($site->imageurl);
$imagehtml = html_writer::empty_tag('img', array('src' => $imageurl, 'alt' => $site->name));
} else {
$imagehtml = '';
}
//create description to display
$deschtml = $site->description;
//the description
/// courses and sites number display under the description, in smaller
$deschtml .= $brtag;
$site->participantnumberavg = number_format($site->participantnumberaverage, 2);
$site->modulenumberavg = number_format($site->modulenumberaverage, 2);
$additionaldesc = get_string('additionaldesc', 'local_hub', $site);
$deschtml .= html_writer::tag('span', $additionaldesc, array('class' => 'additionaldesc'));
/// time registered and time modified only display for administrator
if ($withwriteaccess) {
$admindisplayedinfo = new stdClass();
$admindisplayedinfo->timeregistered = userdate($site->timeregistered);
if (!empty($site->timemodified)) {
$admindisplayedinfo->timemodified = userdate($site->timemodified);
} else {
$admindisplayedinfo->timemodified = '-';
}
$registrationmanager = new registration_manager();
$admindisplayedinfo->privacy = $registrationmanager->get_site_privacy_string($site->privacy);
$admindisplayedinfo->contactable = $site->contactable ? get_string('yes') : get_string('no');
$admindisplayedinfo->emailalert = $site->emailalert ? get_string('yes') : get_string('no');
$additionaladmindesc = $brtag;
$additionaladmindesc .= get_string('additionaladmindesc', 'local_hub', $admindisplayedinfo);
$deschtml .= html_writer::tag('span', $additionaladmindesc, array('class' => 'additionaladmindesc'));
if ($displaysecret) {
$markstolen = new moodle_url('/local/hub/admin/stolensecret.php', array('stolen' => $site->id, 'sesskey' => sesskey()));
$deschtml .= html_writer::tag('span', get_string('secretvalue', 'local_hub', $site->secret) . ' ' . html_writer::tag('a', get_string('markstolen', 'local_hub'), array('href' => $markstolen, 'class' => 'markstolen')), array('class' => 'sitesecret'));
}
}
//retrieve language string
//construct languages array
if (!empty($site->language)) {
$languages = get_string_manager()->get_list_of_languages();
$langcode = str_replace('_utf8', '', $site->language);
$language = isset($languages[$langcode]) ? $languages[$langcode] : '';
} else {
$language = '';
}
//retrieve country string
if (!empty($site->countrycode)) {
$country = get_string_manager()->get_list_of_countries();
$language .= ' (' . $country[$site->countrycode] . ')';
}
if ($withwriteaccess) {
//create site administrator name with email link
$adminnamehtml = html_writer::tag('a', $site->contactname, array('href' => 'mailto:' . $site->contactemail));
//create trust button
if ($site->trusted) {
$trustmsg = get_string('untrustme', 'local_hub');
$trust = false;
} else {
$trustmsg = get_string('trustme', 'local_hub');
$trust = true;
}
$trusturl = new moodle_url("/local/hub/admin/managesites.php", array('sesskey' => sesskey(), 'trust' => $trust, 'id' => $site->id));
$trustedbutton = new single_button($trusturl, $trustmsg);
$trustbuttonhtml = $this->output->render($trustedbutton);
//create prioritise button TODO: MDL-25422
// if ($site->prioritise) {
// $prioritisemsg = get_string('unprioritise', 'local_hub');
// $makeprioritise = false;
// $trustbuttonhtml = '';
// } else {
// $prioritisemsg = get_string('prioritise', 'local_hub');
// $makeprioritise = true;
// }
// $prioritiseurl = new moodle_url("/local/hub/admin/managesites.php",
// array('sesskey' => sesskey(), 'prioritise' => $makeprioritise,
// 'id' => $site->id));
// $prioritisebutton = new single_button($prioritiseurl, $prioritisemsg);
// $prioritisebuttonhtml = $this->output->render($prioritisebutton);
//visible TODO: MDL-25422
// if ($site->visible) {
// $hideimgtag = html_writer::empty_tag('img',
// array('src' => $this->output->pix_url('i/hide'),
// 'class' => 'siteimage', 'alt' => get_string('disable')));
// $makevisible = false;
// } else {
// $hideimgtag = html_writer::empty_tag('img',
// array('src' => $this->output->pix_url('i/show'),
// 'class' => 'siteimage', 'alt' => get_string('enable')));
// $makevisible = true;
// }
// if ($site->privacy != HUB_SITENOTPUBLISHED) {
// $visibleurl = new moodle_url("/local/hub/admin/managesites.php",
// array('sesskey' => sesskey(), 'visible' => $makevisible,
// 'id' => $site->id));
// $visiblehtml = html_writer::tag('a', $hideimgtag,
// array('href' => $visibleurl));
// } else {
// $visiblehtml = get_string('private', 'local_hub');
// }
//delete link
$deleteurl = new moodle_url("/local/hub/admin/managesites.php", array('sesskey' => sesskey(), 'delete' => $site->id));
$deletelinkhtml = html_writer::tag('a', get_string('delete'), array('href' => $deleteurl));
//settings link
$settingsurl = new moodle_url("/local/hub/admin/sitesettings.php", array('sesskey' => sesskey(), 'id' => $site->id));
$settingslinkhtml = html_writer::tag('a', get_string('settings'), array('href' => $settingsurl));
// add a row to the table
$cells = array($imagehtml, $sitenamehtml, $deschtml, $language, $adminnamehtml, $deletelinkhtml . $brtag . $trustbuttonhtml, $settingslinkhtml);
} else {
// add a row to the table
$cells = array($imagehtml, $sitenamehtml, $deschtml, $languages[$site->language]);
}
$row = new html_table_row($cells);
if ($site->prioritise) {
$row->attributes['class'] = 'prioritisetr';
} else {
if ($site->trusted) {
$row->attributes['class'] = 'trustedtr';
}
}
$table->data[] = $row;
}
$renderedhtml .= html_writer::table($table);
}
return $renderedhtml;
}
