detectmobilebrowser Follow @yiiframework

handles detecting mobile browsers

Handles detecting mobile browsers. Results are stored locally for caching calls within the same request, and stored in a cookie for caching across requests. Detection regex used from http://detectmobilebrowsers.com/

Requirements ¶

Tested on Yii 1.1.8 - 1.1.12, should work on all versions.

Usage ¶

Install as an application component, in your config:

'components' => array(
    'detectMobileBrowser' => array(
        'class' => 'ext.yii-detectmobilebrowser.XDetectMobileBrowser',
    ),
),

You can get the current user preference like this:

if (Yii::app()->detectMobileBrowser->showMobile) {
    // do something, like using a different layout/theme
}

By default it will use the automatically detected value. You can also set the preference yourself like this:

public function actionShowMobile() {
    Yii::app()->detectMobileBrowser->showMobile = true;
    $this->redirect(array('/site/index'));
}

Resources ¶

Google Code

Total 10 comments

#11105

marcovtwout at 2012/12/17 03:50am

Re: Session lose only @mobile devices.

This problem does not seem related to this extension. Please create a topic in the forums if you seek help.

#11068

sirin k at 2012/12/13 08:55pm

Session lose only @mobile devices.

hi, im facing an issue when im taking my app in mobile device ie losing session.i have a login feature in app that works fine but after login all of my session values are disappeared.no idea why.

#11034

Cade at 2012/12/11 07:16am

Re: didn't work for me in base directory

wow that was quick, awesome work with the extension.

Really helpful and so simple to use.

#11017

marcovtwout at 2012/12/10 11:37am

Re: Re: Re: didn't work for me in base directory

I've used part of your changes in the new 1.1 release, thanks again!

What's new:

separately store isMobile and showMobile
added functions to reset cookies
updated detection regex to latest version

#11000

marcovtwout at 2012/12/10 03:55am

Re: didn't work for me in base directory

Thanks for your feedback, I will review your code additions and consider adding them to the source code.

It's being maintained on Google Code: https://code.google.com/p/yii-detectmobilebrowser/

#10980

Cade at 2012/12/07 06:16pm

didn't work for me in base directory

I found that the setCookie function wasn't working for me when I had my page in the base public_html directory.

I had to change the following line in setCookie function from: $cookie->path = Yii::app()->baseUrl; to: $cookie->path = Yii::app()->baseUrl . '/';

In addition to this, I have also made some minor changes: 1) Added support to know the actual device type and desired device type (i.e. if you allow toggling of device type) 2) Added latest detection code 3) Added a reset function for resetting of the getShowMobile function

class XDetectMobileBrowser extends CApplicationComponent
{
    /**
     * Cookie name for storing result
     */
    const COOKIE_NAME_SHOW = 'showMobile';
    const COOKIE_NAME_IS   = 'isMobile';
 
    /**
     * @var boolean show mobile version to the client?
     */
    protected $showMobile;
    protected $isMobile;
 
    /**
     * Call isMobileBrowser, store result in $isMobile.
     * Across requests, store result in cookie.
     */
    public function getIsMobile()
    {
        if (!isset($this->isMobile)) {
            $cookie = Yii::app()->request->cookies[self::COOKIE_NAME_IS];
            if (isset($cookie)) {
                $this->isMobile = (bool)$cookie->value;
            } else {
                $this->isMobile = $this->isMobileBrowser();
                $this->setCookie(self::COOKIE_NAME_IS, $this->isMobile);
            }
        }
        return $this->isMobile;
    }
 
    /**
     * Call isMobileBrowser, store result in $showMobile.
     * Across requests, store result in cookie.
     */
    public function getShowMobile()
    {
        if (!isset($this->showMobile)) {
            $cookie = Yii::app()->request->cookies[self::COOKIE_NAME_SHOW];
            if (isset($cookie)) {
                $this->showMobile = (bool)$cookie->value;
            } else {
                $this->showMobile = $this->isMobileBrowser();
                $this->setCookie(self::COOKIE_NAME_SHOW, $this->showMobile);
            }
        }
        return $this->showMobile;
    }
 
 
    /**
     * Explicitly set value for isMobile. Store in cookie.
     * @param bool $value
     */
    public function setShowMobile($value)
    {
        unset(Yii::app()->request->cookies[self::COOKIE_NAME_SHOW]);
        $this->showMobile = (bool)$value;
        $this->setCookie(self::COOKIE_NAME_SHOW, $this->showMobile);
    }
 
 
    /**
     * Clears the cached result with the actual value
     */
     // Check if it can also be reset with:
     // ShowMobile = isMobileBrowser
    public function ResetMobile()
    {
        unset(Yii::app()->request->cookies[self::COOKIE_NAME_SHOW]);
    }
 
 
    /**
     * Set cookie for storing isMobile
     */
    private function setCookie($cookie_name, $value)
    {
        $cookie = new CHttpCookie($cookie_name, (int)$value);
        $cookie->expire = time()+(3600*24*365); //1 year
        $cookie->path = Yii::app()->baseUrl . '/';
        Yii::app()->request->cookies[$cookie_name] = $cookie;
    }
 
    /**
     * Performs a regexp check on the User Agent string to determine if this is a mobile browser.
     * Last updated: 28-2-2012
     * @see http://detectmobilebrowsers.com/
     * @return bool is mobile
     */
    public function isMobileBrowser()
    {
        $useragent=$_SERVER['HTTP_USER_AGENT'];
        return preg_match('/android.+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|meego.+mobile|midp|mmp|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i',$useragent)||preg_match('/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|\-[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|yas\-|your|zeto|zte\-/i',substr($useragent,0,4));
    }
}

#9600

petko at 2012/08/28 04:50am

How to update

You can use the latest regex by downloading it from here: http://detectmobilebrowsers.com/

#9583

Cade at 2012/08/25 09:06am

application component change

I'm still fairly new to Yii, so I'm not sure if I did something wrong, but when I put this under: protected/extensions/yii-detectmobilebrowser it didn't work with the suggested main.php config changes

I looked up in http://www.yiiframework.com/doc/guide/1.1/en/extension.use and put the following in the main.php config to get it to work:

'class' => 'ext.yii-detectmobilebrowser.XDetectMobileBrowser',

instead of the suggestion:

'class' => 'wabbit.extensions.yii-detectmobilebrowser.XDetectMobileBrowser',

just thought I would mention it incase others are having similar issues.

If someone knows of something I did wrong, then please let me know.

Cheers

#6961

marcovtwout at 2012/02/16 03:03am

Re: E.g. for browser switch in SiteController

I would set it in Controller->beforeRender(). If you need to set it sooner, I recommend beforeAction().

#6684

PinkBrainPlan at 2012/01/28 09:07am

E.g. for browser switch in SiteController

Hope this helps someone... took me a view hours to find out;)

class SiteController extends Controller    
{
 
        //to change the main layout, depending on a mobile or none mobile device
        public function init(){
            if (Yii::app()->detectMobileBrowser->showMobile) {
                $this->layout='//layouts/mobile';
            }            
        }
}

Please login to leave your comment.

detectmobilebrowser Follow @yiiframework

Requirements ¶

Usage ¶

Resources ¶

Total 10 comments

Leave a comment

Yii Supporters