Jump to content
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 jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...