globaloxs/yii2-video-embed-widget

Yii2 Extension for Generating Video Embed Codes from Video URLs

dev-master 2016-04-01 16:56 UTC

Requires

• embed/embed: dev-master

MIT

• Caleb Crosby

• extension
• video
• widget
• embed
• yii2

README

Yii2 Extension for Generating Video Embed Codes from Video URLs.

This widget will return the video embed code when passed a valid video url. It's compatible with any web service, such as youtube, vimeo, dailymotion, hulu, etc.

This widget accepts the following parameters:

• url: ** required **
• resonsive: defaults to true
• container_id: defaults to "" empty string
• container_class: defaults to "" empty string
• show_errors: defaults to false

NOTE: This extension depends on the [embed/embed] (https://github.com/oscarotero/Embed) package, created by Oscar Otero. Oscar's Embed class does all the heavy lifting in generating the video embed code based on the supplied video URL. I've simply created a Yii2 wrapper widget with some additional settings.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require cics/yii2-video-embed-widget "dev-master"

or add

"cics/yii2-video-embed-widget": "dev-master"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by adding

<?= \cics\widgets\VideoEmbed::widget(['url' => 'http://www.youtube.com/watch?v=NMjA5N7kbEQ', 'show_errors' => true]); ?>

or add the namespace first and only reference the class name when echoing the returned embed code

use cics\widgets\VideoEmbed;
...
<?= VideoEmbed::widget(['url' => 'http://www.youtube.com/watch?v=NMjA5N7kbEQ']); ?>

Responsiveness

Responsive video display is enabled by default, but to display the video responsively on your page, you'll need to add the following CSS rules to your stylesheet:

.video-container {
    position: relative;
    padding-bottom: 56.25%;
    padding-top: 30px; height: 0; overflow: hidden;
}
 
.video-container iframe,
.video-container object,
.video-container embed {
    position: absolute;
    top: 0;
    left: 0;
    width: 100%;
    height: 100%;
}

NOTE: If you don't want the video to display responsively, you can disable responsive display by setting the responsive parameter to false, or by simply not including the above CSS in your stylesheet.

<?= VideoEmbed::widget(['responsive' => false, 'url' => 'http://www.youtube.com/watch?v=NMjA5N7kbEQ']); ?>

Custom Container ID and Class Settings

You can set a custom container ID or custom container classes by passing the respective parameters.

<?= VideoEmbed::widget([
		'url' => 'http://www.youtube.com/watch?v=NMjA5N7kbEQ',
		'container_id' => 'yourCustomId',
		'container_class' => 'your-custom-class a-second-custom-class',
	]); ?>