Tubular Yii2 Extension

This yii2 extension is a wrapper around the [jQuery Tubular Plugin] jQuery tubular is a plugin that places a YouTube video of your choice into your page as a background., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist julien101/yii2-tubular-widget "*"

or add, _(*4)

"julien101/yii2-tubular-widget": "*"

to the require section of your composer.json file., _(*5)

Usage

Once the extension is installed, simply use it in your code like for instance in the examples below., _(*6)

Start a video on the background of element .youtube_wrapper., _(*7)

This is the simplest approach. The argument is the youtube video code you want to use as a background. In order to be visible (and manage z-index), all visible content should be wrapped into an element with class .youtube_wrapper, _(*8)

    julien101\widget\tubular\Tubular::widget([
        'youtubecode' => 'pQG-oIbJfKs'
    ]);

To attach Tubular on a custom wrapper element, _(*9)

In this case, we defined a custom selector for the main wrapper element. Default settings are used to initialize the plugin., _(*10)

    julien101\widget\tubular\Tubular::widget([
        'selector' => '#custom_tubular_wrapper',
        'youtubecode' => 'pQG-oIbJfKs'
    ]);

Include the wrapper into your layout, _(*11)

The easiest way to integrate the wrapper, is to add it's class to your yii2 layout in /views/layouts/main.php . So that all the content will be visible over the background video. There is an example where we added youtube_wrapper class to the default layout provided by yii2., _(*12)

<body>
    <?php $this->beginBody() ?>
    <div class="wrap youtube_wrapper">
    ...

For complete documentation please refer to the jquery-tubular page, _(*13)

Howto fallback on mobile and tablets?

By design, most mobile phones and tablets (depending on the os / browser), won't be able to play the youtube video. The result will be a black background. The video won't be able to autoplay and there is not much we can do about this., _(*14)

When I use this plugin, I always use a fallback solution (static background image, background diaporama ...). For instance, you can use a server approach to identify the device:, _(*15)

$useragent=$_SERVER['HTTP_USER_AGENT'];
if(preg_match('/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|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|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(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))) {
    // manage the mobile case by showing only a background image
    // ...
} else {
    julien101\widget\tubular\Tubular::widget([
        'selector' => '#custom_tubular_wrapper',
        'youtubecode' => 'pQG-oIbJfKs'
    ]);
}

License

yii2-tubular-widget is released under the BSD 3-Clause License. See the bundled LICENSE.md for details., _(*16)

10/06 2015

dev-master

9999999-dev

Wrapper around the Tubular JQuery plugin

Sources Download

BSD-3-Clause

The Requires

yiisoft/yii2 *

by Julien Muller

extension yii2 video background

yii2-extension yii2-tubular-widget