ryan

Module: Video embed for YouTube/Vimeo (TextformatterVideoEmbed)

Recommended Posts

I had several clients request a version of this module that honors the aspect ratio of a video when using the responsive embed method. For now, the module is using a hard-coded 16/9 ratio.

I decided to give it a go myself and forked Ryan's repo. I added functionality to calculate a video's aspect ratio from the oEmbed return values for width and height and made a change to the module's custom db schema to save the aspect ratio. In the (improbable) case the aspect ratio can't be determined, I added a fallback aspect ratio to the module's config. After looking around for a bit, this post about db schema updates for modules with custom databases provided excellent examples on how to handle the schema updates for existing installations. 

The changes have been tested on several live sites (3.0) and the update went without hiccups.

If anyone's interested, here's the commit: https://github.com/[...]/commit/76e9a5e7bba79aef8fae35aaa7a1b7b79e970f90

I'd love to get some feedback on this! Especially from people running this on the 2.7 or 2.8 branch.

If all works well, it'd be great to integrate this into @ryan's official repo at some point.

 

  • Like 6

Share this post


Link to post
Share on other sites

Great module @ryan :) 

Our client wants support for another video site too, though. So I'm just trying to properly create/extend a module/use hooks for the first time, so as to add an extra embed function.

Supposing I wanted to create support for an additional platform, where would I hook this into (I don't see any hookable functions other than install and uninstall in it)? Is this module extendable?

Share this post


Link to post
Share on other sites

It's such a small simple module that I think your best bet is just to edit it directly, and perhaps rename it (to avoid it potentially getting overwritten in the future). Remember to rename both the filename i.e. TextformatterMyVideoEmbed.module, and the class name to match. Then do a Modules > Refresh, and install it. 

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, ryan said:

It's such a small simple module that I think your best bet is just to edit it directly, and perhaps rename it (to avoid it potentially getting overwritten in the future). Remember to rename both the filename i.e. TextformatterMyVideoEmbed.module, and the class name to match. Then do a Modules > Refresh, and install it. 

Okidoki, will do that instead :) Thank you.

  • Like 1

Share this post


Link to post
Share on other sites

This module sort of solves the video embed problem - thank you! - but...

1. It doesn't work in combination with HTML Entity Encoder?
2. You lose all YouTube embed customization options.

Normally I add the following to the iframe embed url:

... ?rel=0&showinfo=0&autohide=1&wmode=transparent&modestbranding=1&color=white

That removes unnecessary stuff and makes the video look less youtubey. Is there no way to do that in Processwire?

Is there really no way to force PW or the text editor to just leave iframe code alone? At least from a few trusted sources.

I have tried adding my customization to the module at return $embedCode. ..., but that doesn't work of course. It comes out like this:

Spoiler

<p><div class='TextformatterVideoEmbed' style='position:relative;padding:30px 0 56.25% 0;height:0;overflow:hidden;'><iframe style='position:absolute;top:0;left:0;width:100%;height:100%;' width="480" height="270" src="https://www.youtube.com/embed/Wl4XiYadV_k?feature=oembed" frameborder="0" allowfullscreen></iframe>?rel=0&showinfo=0&autohide=1&wmode=transparent&modestbranding=1&color=white</div></p>

 

 

Share this post


Link to post
Share on other sites
4 minutes ago, modifiedcontent said:

...Is there really no way to force PW or the text editor to just leave iframe code alone? At least from a few trusted sources.

I am not sure whether this is relevant in your case and it is from a while back but just thought to post to see if it helps:

 

  • Like 2

Share this post


Link to post
Share on other sites

I haven't tried it, but check out this module that allows you to customize the embedded video's settings: 

And regarding this: " It doesn't work in combination with HTML Entity Encoder" - try changing the order of the text formatters.

  • Like 1

Share this post


Link to post
Share on other sites

I would like to combine the module with lazysizes. Is there a way to replace "src" with "data-src" ?

Share this post


Link to post
Share on other sites

@gar1606just make sure to do a modules refresh and look under new modules

Share this post


Link to post
Share on other sites
15 hours ago, PWaddict said:

I would like to combine the module with lazysizes. Is there a way to replace "src" with "data-src" ?

I found a way how to apply lazysizes. Sharing it here in case anyone wants to do the same thing. With the below javascript code you are replacing iframe's "src" with "data-src" and of course adding the lazyload class and you are 100% ready :)

var iframeEl = document.getElementsByTagName('iframe');
for (var i=0; i<iframeEl.length; i++) {
    if(iframeEl[i].getAttribute('src')) {
       iframeEl[i].setAttribute('data-src',iframeEl[i].getAttribute('src'));
       iframeEl[i].removeAttribute('src');
    }
}

$('iframe').addClass('lazyload');

 

Share this post


Link to post
Share on other sites

I don't think this is a good solution. By the time your Js runs the iframe may start to load so making it useless.

I think it would be better to edit the module itself, and maybe rename the module to avoid overwrite it later when updating. Or even better, submit a PR with a new setting for lazy load :)

  • Like 2

Share this post


Link to post
Share on other sites

@PWaddict

I also think you shouldn't use javascript, instead do the formatting on the server. I feel I wouldn't trust the JS solution because it might not work as expected under certain circumstances.

I put together a regular expression which might help you build another Textformatter which replaces "src" with "data-src" if thats the only thing to do:

Have a look at the demo here: http://www.phpliveregex.com/p/jkp (On the right, click on preg_replace to see the replacement.)

This is the code:

<?php
preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $input_lines);

(During my research I learned from: http://stackoverflow.com/questions/4898192/preg-replace-how-to-replace-only-matching-xxx1yyy-pattern-inside-the-selector)

Hope that helps,
if you need more advice you can also DM me and we will post the result later -

cheers!

PS:

Or like @tpr mentioned you may put that modification directly into a copy of TextformatterVideoEmbed. That way you would have more control. (TextformatterVideoEmbed itself gets the embed code from an oembed url, so you can't easily intercept there ...)

PPS:

Oh, actually a simple str_replace("src=", "data-src=", $embedCode) in a copy of TextformatterVideoEmbed might actually be sufficient!

  • Like 3

Share this post


Link to post
Share on other sites

Thanks @tpr & @blynx for the help.

I replaced the 129 line of the module with this and it's working:

$out = preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out);
$out = str_ireplace('<iframe ', "<iframe class='lazyload' style='position:absolute;top:0;left:0;width:100%;height:100%;' ", $out);

BUT on some fields I'm using the TextformatterMakeLinks module and the videos on that fields aren't loading cause it adds the video links with href inside of data-src.

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, PWaddict said:

BUT on some fields I'm using the TextformatterMakeLinks module and the videos on that fields aren't loading cause it adds the video links with href inside of data-src.

Maybe changing the order of the Textformatters would help? (Putting TextformatterMakeLinks at the bottom / after VideoEmbed)?

Share this post


Link to post
Share on other sites
1 hour ago, blynx said:

Maybe changing the order of the Textformatters would help? (Putting TextformatterMakeLinks at the bottom / after VideoEmbed)?

On that order I have it and it doesn't work.

Share this post


Link to post
Share on other sites

TextformatterMakeLinks thinks the iframe with the data-src attribute is a text to parse for links. (http://www.phpliveregex.com/p/jkU) It does not get caught by the first regular expression there ...

Either that bug has to be fixed (huh, thats a rather long reg-exp there -.-) - try to contact @interrobang there:

Or you could seperate this 

preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out)

into a new Textformatter and use the original VideoEmbed again.
Then, the order should be:

VideoEmbed
MakeLinks
ThatFormatterWhichMakesTheDataSrc

I think this should work, since MakeLinks detects "src" in an iframe correctly - but not "data-src"

Good luck :)

Share this post


Link to post
Share on other sites

@blynx Actually I've unistalled TextformatterMakeLinks cause I don't really need it so problem solved. Thanks again for the help.

@ryan Can you update the module with a new option for lazy load? On the module config there must be 2 new fields. A checkbox field for the lazy loading option and a text field with the css class name from the lazy script used. Eg. I'm using lazysizes so the class name is lazyload.

Here is the replaced code on the 129 line of the module:

$out = preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out);
$out = str_ireplace('<iframe ', "<iframe class='lazyload' style='position:absolute;top:0;left:0;width:100%;height:100%;' ", $out);

 

Share this post


Link to post
Share on other sites

Hi, i need youtube video id 

Is there any way to get this id from template file.?

I was looking into TextformatterVideoEmbed.module file

public function format(&$str) {
		$this->embedYoutube($str);
		$this->embedVimeo($str);
	}

	/**
	 * Check for Youtube URLS and embed when found
	 *
	 */
	protected function embedYoutube(&$str) {

		// perform a strpos fast check before performing regex check
		if(strpos($str, '://www.youtube.com/watch') === false && strpos($str, '://www.youtube.com/v/') === false && strpos($str, '://youtu.be/') === false) return;

		//               1: full URL                                                 2:video id    3: query string (optional)
		$regex = '#<p>\s*(https?://(?:www\.)?youtu(?:.be|be.com)+/(?:watch/?\?v=|v/)?([^\s&<\'"]+))(&[-_,.=&;a-zA-Z0-9]*)?.*?</p>#';
		if(!preg_match_all($regex, $str, $matches)) return;

		foreach($matches[0] as $key => $line) { 

			$oembedURL = 
				"$this->http://www.youtube.com/oembed?url=" . urlencode($matches[1][$key]) . 
				"&format=json&maxwidth={$this->maxWidth}&maxheight={$this->maxHeight}"; 

			$videoID = $matches[2][$key]; 
			$queryString = isset($matches[3][$key]) ? $matches[3][$key] : '';
			$embedCode = $this->getEmbedCode($oembedURL, $videoID); 

 

Can i use something like below  from my template file

$page->video->$videoID;

 

There are hundreds of youtube video fields  entered with TextformatterVideoEmbed module . And i can not get these url with 

Quote

echo $page->video;

because it embed iframe and shows youtube video not the url

If i can grab video url i can get the id from there.

I want to keep working this way but i need this url or video id for use on amp-youtube tag

Share this post


Link to post
Share on other sites

Videos not showing up.:'(

PW Version: 3.0.57

TextformatterVideoEmbed Version: 1.1.1

The module is installed. I have added the "Video embed for YouTube/Vimeo" Text formatter to the body field. I put a link with the format "https://www.youtube.com/watch?v=xxxxxx" into the body surrounded by <p></p> tags. However, when I view the site, I just see the text for the link.

What am I missing?

Thanks!

Share this post


Link to post
Share on other sites
3 hours ago, artaylor said:

Videos not showing up.:'(

PW Version: 3.0.57

TextformatterVideoEmbed Version: 1.1.1

The module is installed. I have added the "Video embed for YouTube/Vimeo" Text formatter to the body field. I put a link with the format "https://www.youtube.com/watch?v=xxxxxx" into the body surrounded by <p></p> tags. However, when I view the site, I just see the text for the link.

What am I missing?

Thanks!

Make sure your link added as plain text not as clickable link. Also try chaning the order of the text formatters. "Video embed for YouTube/Vimeo" should be on top.

Share this post


Link to post
Share on other sites

@PWaddict: Thanks. The link is plain text and "Video embed..." is the first text formatter. I tried removing the Hanna Code textformatter to see if it was causing a conflict but it still did not work.

 

 

Share this post


Link to post
Share on other sites
15 minutes ago, artaylor said:

@PWaddict: Thanks. The link is plain text and "Video embed..." is the first text formatter. I tried removing the Hanna Code textformatter to see if it was causing a conflict but it still did not work.

 

 

Is the field textarea? Is the Inputfield Type: CKEditor?

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By anderson
      Hi all,
      I'm a new to website building. Learned some CRASH course of js,jquery,php. Then I found CMS. Still learning around forum, youtube....
      Anyway, please help me with some beginer questions:
      1, About template - please correct me if I understand wrong : every page should be (or recommended) built on a template. So if in total I'll have 10 pages, 2 of them have same layout, I'll need 9 templates.  And, what fields a page includes, is not defined in page, but defined in the template that page uses. 
      2,  Where to see what modules I've installed? is it in "Modules - Site"? 
      3, I installed "PageTable Extended", then what?  As in a youtube tutorial, it should appear in Setup tab, but it doesn't.  What's in there: templates,fields,logs,comments. (I installed "Uikit 3 site_blog profile".)
      4, I did a search in Processwire website for the famous "repeater matrix" module, and can not find it, there's a Repeater, as well as a Matrix. Is it not a module?
      5, I watched this youtube tuts: https://www.youtube.com/watch?v=IHqnLQy9R1A
      Anybody familiar with this tuts please help: 
      After he analysed a target webpage layout he wanted to mimic, he created some fields, some template, then based on those he created a page and input some "content" in there, then clicked "view", it's just some text. So, here comes my question, he copied a folder "assets" (subfolders are: css,fonts,js,img) over, then the page have the appearance/layout he wanted to mimic. Where does that assets folder come from?
      Appreciate any help.
    • By mtwebit
      I've created a set of modules for importing (manipulating and displaying) data from external resources. A key requirement was to handle large (100k+) number of pages easily.
      Main features
      import data from CSV and XML sources in the background (using Tasker) purge, update or overwrite existing pages using selectors user configurable input <-> field mappings on-the-fly data conversion and composition (e.g. joining CSV columns into a single field) download external resources (files, images) during import handle page references by any (even numeric) fields How it works
      You can upload CSV or XML files to DataSet pages and specify import rules in their description.
      The module imports the content of the file and creates/updates child pages automatically.
      How to use it
      Create a DataSet page that stores the source file. The file's description field specifies how the import should be done:
      After saving the DataSet page an import button should appear below the file description.

      When you start the import the DataSet module creates a task (executed by Tasker) that will import the data in the background.
      You can monitor its execution and check its logs for errors.

      See the module's wiki for more details.
      The module was already used in three projects to import and handle large XML and CSV datasets. It has some rough edges and I'm sure it needs improvement so comments are welcome.
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By Robin S
      Pages At Bottom
      Keeps selected pages at the bottom of their siblings.
      A "bottom page" will stay at the bottom even if it is drag-sorted to a different location or another page is drag-sorted below it (after Page List is refreshed the bottom page will still be at the bottom).
      Newly added sibling pages will not appear below a bottom page.
      The module also prevents the API methods $pages->sort() and $pages->insertAfter() from affecting the position of bottom pages.
      Note: the module only works when the sort setting for children on the parent page/template is "Manual drag-n-drop".
      Why?
      Because you want some pages to always be at the bottom of their siblings for one reason or another. And someone requested it. 🙂
      Usage
      Install the Pages At Bottom module.
      Select one or more pages to keep at the bottom of their siblings. If you select more than one bottom page per parent then their sort order in the page list will be the same as the sort order in the module config.

       
      https://github.com/Toutouwai/PagesAtBottom
      https://modules.processwire.com/modules/pages-at-bottom/
    • By Robin S
      Another little admin helper module...
      Template Field Widths
      Adds a "Field widths" field to Edit Template that allows you to quickly set the widths of inputfields in the template.

      Why?
      When setting up a new template or trying out different field layouts I find it a bit slow and tedious to have to open each field individually in a modal just to set the width. This module speeds up the process.
      Installation
      Install the Template Field Widths module.
      Config options
      You can set the default presentation of the "Field widths" field to collapsed or open. You can choose Name or Label as the primary identifier shown for the field. The unchosen alternative will become the title attribute shown on hover. You can choose to show the original field width next to the template context field width.  
      https://github.com/Toutouwai/TemplateFieldWidths
      https://modules.processwire.com/modules/template-field-widths/