Pré-requis de bienveillance
J'invite à une bienveillance de mes lecteurs quant aux modes de diffusion de ce module. En effet, j'ignore totalement comment fabriquer un package de distribution et d'installation de modules Joomla, j'utilise toujours le mode "Découverte". Mais contactez-moi si vous avez un tuto ou pour m'expliquer comment packager un module et le rendre distribuable.
C'est quoi ?
Il apparait que sur mon site, je me suis interessé (et je m'interesse toujours) aux API du web. J'ai écris plusieurs articles pour expliquer dans les grandes lignes les API que le site Youtube vous fourni. et il y en a une passez sympa, encore faut-il l'appeler une API car c'est est pas trop une (encore que), c'est le fil RSS d'une chaine Youtube. Sur mon autre site Aujourd'hui à Nancy, j'écris régulièrement des articles sur des artistes du web. Et beaucoup d'entre eux, si se n'est pas pour dire tous, ont une chaine youtube alimentée régulièrement. Le problème auquel je me heurtais était simple : mes articles étant intemporel, je peux (et je le fais) intégrer des vidéos dont le code d'intégration est fourni par Youtube. Pour une vidéo spécifique dans un article, c'est pas mal. Mais quid pour parler d'une chaine ? La vidéo va - elle rester ? sera-t-elle supprimée ou censurée sur la plateforme collaborative de vidéos ?
Autant de questions auxquelles mon module répond puisqu'il se base sur le flux RSS d'une et une seule chaine, Le résultat est un article (si le module est intégré à l'article) à jours avec les dernières vidéos de la chaine.
Tu as tout écrit ?
Alors je sais que je suis une bille complète en programmation orientée objet, mais je m'y mets (oui oui, moi qui était (et le suis encore un peu) réfractaire à la POO et y'a un truc de feignasse (il faut bien le dire) mis à la disposition des développeurs : l'héritage. Alors tout réécrire ? jamais. Je suis parti du module mod_feed fourrni dans Joomla, module de base du CMS, que j'ai dupliqué, renommé ainsi que le fichier XML de description, auquel j'ai ajouté un test sur une fonctionnalité spécifique du fil RSS de Youtube : la présenced es références des vidéos. Ce module, vous l'aurez compris, dépend totalement sde l'API, qui peut évvoluer dans le temps !
Pour faire simple, je regarde si l'URL du fil RSS contient la chaine "youtube" et si tel est le cas, je pars du principe que c'est un bon fil RSS fourni par Youtube. Alors oui je sais, le test est léger, il faudrait plutôt tester avec des regex le contenu du flux, mais les regex, je maitrise pas.
Ca fait quoi alors par rapport à mod_feed ?
Lorsqu'on donne en pâtrue un fil RSS youtube à mod_feed, aucune des vidéos n'est intégrée dans le flux, prêtes à être jouée. Et bien avec mon module, elle le sont. Je vous ai concocté ci(dessous un module d'exemple, basé sur la chaine Youtube UC4YtERl4WGwN8dFzn28FHMg (enfin France TV Arts mais je ne doute pas que vous avirez reconnus la référence :-)
Comme vous pouvez le voir sur la copie d'écran, ce module liste toutes les dernière vidéos contenues dans le flux (alors j'ai regardé très rapidement dans l'API Youtube et n'ai pas trouvé si on pouvait régler le nombre d'items du fils RSS youtube, peut être que oui), et le module les affiche les unes sous les autres. Et bien entendu, en cliquant sur le palyer, il se met en route.
Style ?
Y'a pas qu'en POO où je suis une bille, en infographie aussi. Mais je vous ai prévu un fichier CSS à personnaliser à loisir pour faire ressortir vos vidéos. Si vous faites vos propres fichier de styles, envoyez les moi et ca sera avec plaisir que je les joindrais (avec accréditation et références de votre choix) à cet article !
What else ?
Rien d'autre, juste un p'tit café pour fêter la fin de developpement ?
Petit bémol
Ayant développé le module à partir du module existant sans en faire d'héritage (oh le con), il faut peut etre recorriger le fichier xml si vous voulez en faire un autre type de module. En revanche, si vous l''"écrasez" par héritage dans votre Joomla, ca devrait marcher.
style.php
.youtube-feed .youtube-feed-title .youtube-titre{
font-size:150%;
padding-top:20px;
padding-bottom:20px;
}
.youtube-feed .youtube-feed-title iframe{
border:3px solid red;
}
.youtube-vide{
text-align:center;
width:100%;
}
? helper.php
<?php
/**
* @package Joomla.Site
* @subpackage mod_feed
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
/**
* Helper for mod_feed
*
* @since 1.5
*/
class ModFeedHelper
{
/**
* Retrieve feed information
*
* @param \Joomla\Registry\Registry $params module parameters
*
* @return JFeedReader|string
*/
public static function getFeed($params)
{
// Module params
$rssurl = $params->get('rssurl', '');
// Get RSS parsed object
try
{
$feed = new JFeedFactory;
$rssDoc = $feed->getFeed($rssurl);
}
catch (Exception $e)
{
return JText::_('MOD_FEED_ERR_FEED_NOT_RETRIEVED');
}
if (empty($rssDoc))
{
return JText::_('MOD_FEED_ERR_FEED_NOT_RETRIEVED');
}
if ($rssDoc)
{
return $rssDoc;
}
}
}
⏼ mod_feed.xml
<?xml version="1.0" encoding="utf-8"?>
<extension type="module" version="3.1" client="site" method="upgrade">
<name>mod_feed</name>
<author>Joomla! Project</author>
<creationDate>July 2005</creationDate>
<copyright>Copyright (C) 2005 - 2020 Open Source Matters. All rights reserved.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>MOD_FEED_XML_DESCRIPTION</description>
<files>
<filename module="mod_feed">mod_feed.php</filename>
<folder>tmpl</folder>
<filename>helper.php</filename>
</files>
<languages>
<language tag="en-GB">en-GB.mod_feed.ini</language>
<language tag="en-GB">en-GB.mod_feed.sys.ini</language>
</languages>
<help key="JHELP_EXTENSIONS_MODULE_MANAGER_FEED_DISPLAY" />
<config>
<fields name="params">
<fieldset name="basic">
<field
name="rssurl"
type="url"
label="MOD_FEED_FIELD_RSSURL_LABEL"
description="MOD_FEED_FIELD_RSSURL_DESC"
size="50"
filter="url"
required="true"
validate="url"
/>
<field
name="rssrtl"
type="radio"
label="MOD_FEED_FIELD_RTL_LABEL"
description="MOD_FEED_FIELD_RTL_DESC"
class="btn-group btn-group-yesno"
default="0"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rsstitle"
type="radio"
label="MOD_FEED_FIELD_RSSTITLE_LABEL"
description="MOD_FEED_FIELD_RSSTITLE_DESC"
class="btn-group btn-group-yesno"
default="1"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rssdesc"
type="radio"
label="MOD_FEED_FIELD_DESCRIPTION_LABEL"
description="MOD_FEED_FIELD_DESCRIPTION_DESC"
class="btn-group btn-group-yesno"
default="1"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rssdate"
type="radio"
label="MOD_FEED_FIELD_DATE_LABEL"
description="MOD_FEED_FIELD_DATE_DESC"
class="btn-group btn-group-yesno"
default="0"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rssimage"
type="radio"
label="MOD_FEED_FIELD_IMAGE_LABEL"
description="MOD_FEED_FIELD_IMAGE_DESC"
class="btn-group btn-group-yesno"
default="1"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rssitems"
type="number"
label="MOD_FEED_FIELD_ITEMS_LABEL"
description="MOD_FEED_FIELD_ITEMS_DESC"
default="3"
filter="integer"
/>
<field
name="rssitemdesc"
type="radio"
label="MOD_FEED_FIELD_ITEMDESCRIPTION_LABEL"
description="MOD_FEED_FIELD_ITEMDESCRIPTION_DESC"
class="btn-group btn-group-yesno"
default="1"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="rssitemdate"
type="radio"
label="MOD_FEED_FIELD_ITEMDATE_LABEL"
description="MOD_FEED_FIELD_ITEMDATE_DESC"
class="btn-group btn-group-yesno"
default="0"
filter="integer"
>
<option value="1">JYES</option>
<option value="0">JNO</option>
</field>
<field
name="word_count"
type="text"
label="MOD_FEED_FIELD_WORDCOUNT_LABEL"
description="MOD_FEED_FIELD_WORDCOUNT_DESC"
size="6"
default="0"
filter="integer"
/>
</fieldset>
<fieldset name="advanced">
<field
name="layout"
type="modulelayout"
label="JFIELD_ALT_LAYOUT_LABEL"
description="JFIELD_ALT_MODULE_LAYOUT_DESC"
validate="moduleLayout"
/>
<field
name="moduleclass_sfx"
type="textarea"
label="COM_MODULES_FIELD_MODULECLASS_SFX_LABEL"
description="COM_MODULES_FIELD_MODULECLASS_SFX_DESC"
rows="3"
/>
<field
name="cache"
type="list"
label="COM_MODULES_FIELD_CACHING_LABEL"
description="COM_MODULES_FIELD_CACHING_DESC"
default="1"
filter="integer"
>
<option value="1">JGLOBAL_USE_GLOBAL</option>
<option value="0">COM_MODULES_FIELD_VALUE_NOCACHING</option>
</field>
<field
name="cache_time"
type="number"
label="COM_MODULES_FIELD_CACHE_TIME_LABEL"
description="COM_MODULES_FIELD_CACHE_TIME_DESC"
default="900"
filter="integer"
/>
</fieldset>
</fields>
</config>
</extension>
✎ style.css
.youtube-feed .youtube-feed-title .youtube-titre{
font-size:150%;
padding-top:20px;
padding-bottom:20px;
}
.youtube-feed .youtube-feed-title iframe{
border:3px solid red;
}
.youtube-vide{
text-align:center;
width:100%;
}
? tmpl/default.php
<?php
/**
* @package Joomla.Site
* @subpackage mod_feed
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
?>
<?php
$document = JFactory::getDocument()->addStyleSheet("modules/mod_feed/style.css");
if (!empty($feed) && is_string($feed))
{
echo $feed;
}
else
{
$lang = JFactory::getLanguage();
$myrtl = $params->get('rssrtl', 0);
$direction = ' ';
$isRtl = $lang->isRtl();
if ($isRtl && $myrtl == 0)
{
$direction = ' redirect-rtl';
}
// Feed description
elseif ($isRtl && $myrtl == 1)
{
$direction = ' redirect-ltr';
}
elseif ($isRtl && $myrtl == 2)
{
$direction = ' redirect-rtl';
}
elseif ($myrtl == 0)
{
$direction = ' redirect-ltr';
}
elseif ($myrtl == 1)
{
$direction = ' redirect-ltr';
}
elseif ($myrtl == 2)
{
$direction = ' redirect-rtl';
}
if ($feed !== false)
{
?>
<div style="direction: <?php echo $rssrtl ? 'rtl' :'ltr'; ?>; text-align: <?php echo $rssrtl ? 'right' :'left'; ?> !important" class="feed<?php echo $moduleclass_sfx; ?>">
<?php
// Feed description
if ($feed->title !== null && $params->get('rsstitle', 1))
{
?>
<h2 class="<?php echo $direction; ?>">
<div class="youtube-titre">
<a href="/<?php echo htmlspecialchars($rssurl, ENT_COMPAT, 'UTF-8'); ?>" target="_blank">
<?php echo $feed->title; ?>
</a>
</div>
</h2>
<?php
}
// Feed date
if ($params->get('rssdate', 1)) : ?>
<h3>
<?php echo JHtml::_('date', $feed->publishedDate, JText::_('DATE_FORMAT_LC3')); ?>
</h3>
<?php endif;
// Feed description
if ($params->get('rssdesc', 1))
{
?>
<?php echo $feed->description; ?>
<?php
}
// Feed image
if ($feed->image && $params->get('rssimage', 1)) :
?>
<img src="/<?php echo $feed->image->uri; ?>" alt="<?php echo $feed->image->title; ?>"/>
<?php endif; ?>
<!-- Show items -->
<?php if (!empty($feed))
{ ?>
<div class="youtube-feed<?php echo $params->get('moduleclass_sfx'); ?>">
<?php for ($i = 0, $max = min(count($feed), $params->get('rssitems', 3)); $i < $max; $i++) { ?>
<?php
$uri = $feed[$i]->uri || !$feed[$i]->isPermaLink ? trim($feed[$i]->uri) : trim($feed[$i]->guid);
$uri = !$uri || stripos($uri, 'http') !== 0 ? $rssurl : $uri;
$text = $feed[$i]->content !== '' ? trim($feed[$i]->content) : '';
?>
<?php if (!empty($uri)) : ?>
<span class="feed-link youtube-feed-title">
<?php
if (strpos(strtolower($rssurl), 'youtube')>0)
{
$URL = $feed[$i]->uri;
$e = explode("=",$URL);
$youtubeID = $e[1];
echo '<div class="youtube-titre">'.trim($feed[$i]->title).'</div>';
echo '<div class="youtube-vide"><iframe width="560" height="315" src="https://www.youtube.com/embed/'.$youtubeID.'" title="'.trim($feed[$i]->title).'" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>';
}
?></span>
<?php else : ?>
<span class="feed-title"><?php echo trim($feed[$i]->title); ?></span>
<?php endif; ?>
<?php if ($params->get('rssitemdate', 0)) : ?>
<div class="feed-item-date">
<?php echo JHtml::_('date', $feed[$i]->publishedDate, JText::_('DATE_FORMAT_LC3')); ?>
</div>
<?php endif; ?>
<?php if ($params->get('rssitemdesc', 1) && $text !== '') : ?>
<div class="feed-item-description">
<?php
// Strip the images.
$text = JFilterOutput::stripImages($text);
$text = JHtml::_('string.truncate', $text, $params->get('word_count', 0));
echo str_replace(''', "'", $text);
?>
</div>
<?php endif; ?>
<?php } ?>
</div>
<?php } ?>
</div>
<?php }
}