Permalink
Browse files

MDL-25394 Tidied up several things in order to get this integrated

  • Loading branch information...
1 parent 37959dd commit e5824bb9c64272c98f52db6efcda7dcc836761e1 Sam Hemelryk committed May 31, 2011
Showing with 195 additions and 198 deletions.
  1. +1 −0 lang/en/error.php
  2. +7 −3 lib/adminlib.php
  3. +0 −7 lib/db/upgrade.php
  4. +32 −70 lib/moodlelib.php
  5. +15 −20 lib/outputrenderers.php
  6. +35 −15 lib/pagelib.php
  7. +95 −79 theme/index.php
  8. +9 −3 theme/{switch.php → switchdevice.php}
  9. +1 −1 version.php
View
@@ -277,6 +277,7 @@
$string['invalidcoursenameshort'] = 'Invalid short course name';
$string['invaliddata'] = 'Data submitted is invalid';
$string['invaliddatarootpermissions'] = 'Invalid permissions detected in $CFG->dataroot directory, administrator has to fix permissions.';
+$string['invaliddevicetype'] = 'Invalid device type';
$string['invalidelementid'] = 'Incorrect element id!';
$string['invalidentry'] = 'This is not valid entry!';
$string['invalidevent'] = 'Invalid event';
View
@@ -7317,8 +7317,13 @@ public function output_html($data, $query = '') {
class admin_setting_devicedetectregex extends admin_setting {
/**
- * Calls parent::__construct with specific args
- */
+ * Calls parent::__construct with specific args
+ *
+ * @param string $name
+ * @param string $visiblename
+ * @param string $description
+ * @param mixed $defaultsetting
+ */
public function __construct($name, $visiblename, $description, $defaultsetting = '') {
global $CFG;
parent::__construct($name, $visiblename, $description, $defaultsetting);
@@ -7496,7 +7501,6 @@ protected function process_form_data(array $form) {
}
}
-
/**
* Multiselect for current modules
*
View
@@ -6112,13 +6112,6 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2011052300.02);
}
- //set enable theme detection to the new themes setting.
- if ($oldversion < 2011052500.00) {
- set_config('enabledevicedetection', 1);
-
- upgrade_main_savepoint(true, 2011052500.00);
- }
-
return true;
}
View
@@ -7603,7 +7603,6 @@ function check_browser_version($brand, $version = null) {
return false;
}
-
/**
* Returns whether a device/browser combination is mobile, tablet, legacy, default or the result of
* an optional admin specified regular expression. If enabledevicedetection is set to no or not set
@@ -7633,13 +7632,11 @@ function get_device_type() {
//mobile detection PHP direct copy from open source detectmobilebrowser.com
$phonesregex = '/android|avantgo|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i';
$modelsregex = '/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|e\-|e\/|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(di|rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|xda(\-|2|g)|yas\-|your|zeto|zte\-/i';
-
- if (preg_match($phonesregex,$useragent)||preg_match($modelsregex,substr($useragent,0,4))){
+ if (preg_match($phonesregex,$useragent) || preg_match($modelsregex,substr($useragent, 0, 4))){
return 'mobile';
}
$tabletregex = '/Tablet browser|iPad|iProd|GT-P1000|GT-I9000|SHW-M180S|SGH-T849|SCH-I800|Build\/ERE27|sholest/i';
-
if (preg_match($tabletregex, $useragent)) {
return 'tablet';
}
@@ -7651,10 +7648,10 @@ function get_device_type() {
return 'default';
}
-
/**
* Returns a list of the device types supporting by Moodle
- * @param boolean incusertypes includes types specified using the devicedetectregex admin setting
+ *
+ * @param boolean $incusertypes includes types specified using the devicedetectregex admin setting
* @return array $types
*/
function get_device_type_list($incusertypes = true) {
@@ -7673,49 +7670,32 @@ function get_device_type_list($incusertypes = true) {
return $types;
}
-
/**
* Returns the theme selected for a particular device or false if none selected.
- * @param string $themes
+ *
* @param string $devicetype
- * @return string $theme or boolean false
+ * @return string|false The name of the theme to use for the device or the false if not set
*/
function get_selected_theme_for_device_type($devicetype = null) {
global $CFG;
if (empty($devicetype)) {
- $devicetype = get_device_type();
-
- //check if the user has switched theme, change $devicetype to default.
- $switched = get_user_switched_device($devicetype);
-
- if ($switched) {
- $devicetype = $switched;
- }
+ $devicetype = get_user_device_type();
}
$themevarname = get_device_cfg_var_name($devicetype);
-
if (empty($CFG->$themevarname)) {
return false;
}
- //prevent problems if a user installs themes
- if (!is_dir($CFG->dirroot.'/theme/'.$CFG->$themevarname)) {
- if ($devicetype == 'default') {
- return 'standard';
- } else {
- return false;
- }
- }
-
return $CFG->$themevarname;
}
-
/**
* Returns the name of the device type theme var in $CFG (because there is not a standard convention to allow backwards compatability
+ *
* @param string $devicetype
+ * @return string The config variable to use to determine the theme
*/
function get_device_cfg_var_name($devicetype = null) {
if ($devicetype == 'default' || empty($devicetype)) {
@@ -7725,59 +7705,41 @@ function get_device_cfg_var_name($devicetype = null) {
return 'theme' . $devicetype;
}
-
/**
- * Returns device type or false if the user has switched theme to default for a device type
- * @param string $devicetype
+ * Allows the user to switch the device they are seeing the theme for.
+ * This allows mobile users to switch back to the default theme, or theme for any other device.
+ *
+ * @param string $newdevice The device the user is currently using.
+ * @return string The device the user has switched to
*/
-function get_user_switched_device($devicetype = null) {
+function set_user_device_type($newdevice) {
global $USER;
- if (empty($USER)) {
- return false;
- }
-
- if (empty($devicetype)) {
- $devicetype = get_device_type();
- }
-
- $switchdevice = get_user_preferences('switchdevice'.$devicetype);
+ $devicetype = get_device_type();
+ $devicetypes = get_device_type_list();
- if (empty($switchdevice)) {
- return false;
+ if ($newdevice == $devicetype) {
+ unset_user_preference('switchdevice'.$devicetype);
+ } else if (in_array($newdevice, $devicetypes)) {
+ set_user_preference('switchdevice'.$devicetype, $newdevice);
}
-
- return $switchdevice;
}
-
-function switch_device($devicetype = null) {
- global $USER;
-
- if (is_null($devicetype)) {
- $devicetype = get_device_type();
- }
-
- $switcheddevice = get_user_preferences('switchdevice'.$devicetype);
-
- if (!empty($switcheddevice)) {
- $switcheddevice = false;
- } else {
- $pref = optional_param('switchdevice', '', PARAM_TEXT);
-
- if (!empty($pref)) {
- $switcheddevice = $pref;
- } else if ($devicetype == 'default') {
- $switcheddevice = 'mobile';
- } else {
- $switcheddevice = 'default';
- }
+/**
+ * Returns the device the user is currently using, or if the user has chosen to switch devices
+ * for the current device type the type they have switched to.
+ *
+ * @return string The device the user is currently using or wishes to use
+ */
+function get_user_device_type() {
+ $device = get_device_type();
+ $switched = get_user_preferences('switchdevice'.$device, false);
+ if ($switched != false) {
+ return $switched;
}
-
- set_user_preference('switchdevice'.$devicetype, $switcheddevice);
+ return $device;
}
-
/**
* Returns one or several CSS class names that match the user's browser. These can be put
* in the body tag of the page to apply browser-specific rules without relying on CSS hacks
View
@@ -212,8 +212,6 @@ class core_renderer extends renderer_base {
protected $contenttype;
/** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */
protected $metarefreshtag = '';
- /** @var set if the theme links function has been called **/
- protected $switchlinkdisplayed;
/**
* Get the DOCTYPE declaration that should be used with this page. Designed to
@@ -364,11 +362,12 @@ public function standard_footer_html() {
// but some of the content won't be known until later, so we return a placeholder
// for now. This will be replaced with the real content in {@link footer()}.
$output = self::PERFORMANCE_INFO_TOKEN;
- if ($this->page->devicetypeinuse == 'legacy'){
+ if ($this->page->devicetypeinuse == 'legacy') {
// The legacy theme is in use print the notification
$output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
}
+ // Get links to switch device types (only shown for users not on a default device)
$output .= $this->theme_switch_links();
if (!empty($CFG->debugpageinfo)) {
@@ -2502,44 +2501,40 @@ protected function render_custom_menu_item(custom_menu_item $menunode) {
return $content;
}
-
- /*
+ /**
* Renders theme links for switching between default and other themes.
+ *
+ * @return string
*/
protected function theme_switch_links() {
- if ($this->switchlinkdisplayed) {
- return '';
- }
-
- global $USER;
-
- $type = get_device_type();
- $this->switchlinkdisplayed = true;
+ $actualdevice = get_device_type();
+ $currentdevice = $this->page->devicetypeinuse;
+ $switched = ($actualdevice != $currentdevice);
- if ($type == 'default') {
+ if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
+ // The user is using the a default device and hasn't switched so don't shown the switch
+ // device links.
return '';
}
- $switched = get_user_switched_device();
-
if ($switched) {
$linktext = get_string('switchdevicerecommended');
+ $devicetype = $actualdevice;
} else {
$linktext = get_string('switchdevicedefault');
+ $devicetype = 'default';
}
+ $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
- $content = html_writer::start_tag('div', array('id'=>'theme_switch_link'));
- $linkurl = new moodle_url('/theme/switch.php', array('url' => $this->page->url));
-
+ $content = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
$content .= html_writer::link($linkurl, $linktext);
$content .= html_writer::end_tag('div');
return $content;
}
}
-
/// RENDERERS
/**
Oops, something went wrong.

0 comments on commit e5824bb

Please sign in to comment.