diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b066e0c --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# OS +.DS_Store +Thumbs.db \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec734d4 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +Contao News Related +===================== + +Simple Contao 4+ bundle for setting related news directly. + +This is different from creating relations via categories or tags, since you have to define the related news for each individual article yourself. Note that the direction of relation goes only one way - so if you want article _A_ to be related to article _B_, but also vice versa, you have to assign the relation in article _B_ as well. + +This bundle is fully compatible with the `news_categories`, `news_sorted` and `news_sorting` extension. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..1582fd2 --- /dev/null +++ b/composer.json @@ -0,0 +1,36 @@ +{ + "name":"fritzmg/contao-news-related", + "description":"Contao 4+ bundle to integrate Swiper.js", + "keywords":["contao", "news", "related"], + "type":"contao-bundle", + "homepage":"http://www.inspiredminds.at", + "license":"LGPL-3.0+", + "authors":[ + { + "name":"Fritz Michael Gschwantner", + "homepage":"http://www.inspiredminds.at", + "email":"fmg@inspiredminds.at", + "role":"Developer" + } + ], + "support":{ + "email":"fmg@inspiredminds.at", + "issues":"https://github.com/fritzmg/contao-news-related/issues", + "source":"https://github.com/fritzmg/contao-news-related", + "forum":"https://community.contao.org/de" + }, + "require":{ + "contao/core-bundle": "~4.4" + }, + "require-dev": { + "contao/manager-plugin": "^2.0" + }, + "autoload": { + "psr-4": { + "ContaoNewsRelatedBundle\\": "src/" + } + }, + "extra": { + "contao-manager-plugin": "ContaoNewsRelatedBundle\\ContaoManager\\Plugin" + } +} diff --git a/src/ContaoManager/Plugin.php b/src/ContaoManager/Plugin.php new file mode 100644 index 0000000..8424465 --- /dev/null +++ b/src/ContaoManager/Plugin.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace ContaoNewsRelatedBundle\ContaoManager; + +use Contao\ManagerPlugin\Bundle\Config\BundleConfig; +use Contao\ManagerPlugin\Bundle\BundlePluginInterface; +use Contao\ManagerPlugin\Bundle\Parser\ParserInterface; + + +/** + * Plugin for the Contao Manager. + * + * @author Fritz Michael Gschwantner + */ +class Plugin implements BundlePluginInterface +{ + /** + * {@inheritdoc} + */ + public function getBundles(ParserInterface $parser) + { + return [ + BundleConfig::create('ContaoNewsRelatedBundle\ContaoNewsRelatedBundle') + ->setLoadAfter(['Contao\CoreBundle\ContaoCoreBundle']) + ]; + } +} diff --git a/src/ContaoNewsRelatedBundle.php b/src/ContaoNewsRelatedBundle.php new file mode 100644 index 0000000..3634e1d --- /dev/null +++ b/src/ContaoNewsRelatedBundle.php @@ -0,0 +1,21 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace ContaoNewsRelatedBundle; + +use Symfony\Component\HttpKernel\Bundle\Bundle; + +/** + * Configures the Contao Swiper Bundle. + */ +class ContaoNewsRelatedBundle extends Bundle +{ +} diff --git a/src/Models/NewsRelatedModel.php b/src/Models/NewsRelatedModel.php new file mode 100644 index 0000000..f5752ab --- /dev/null +++ b/src/Models/NewsRelatedModel.php @@ -0,0 +1,157 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace ContaoNewsRelatedBundle\Models; + + +/** + * Dynamic parent class + */ +if (class_exists('\NewsCategories\NewsModel')) +{ + class ParentModel extends \NewsCategories\NewsModel {} +} +else +{ + class ParentModel extends \Contao\NewsModel {} +} + + +/** + * This class essentially only provides a hook, but no additional findBy methods. + * + * @author Fritz Michael Gschwantner + */ +class NewsRelatedModel extends ParentModel +{ + /** + * newsListFetchItems hook + * + * @param array $newsArchives + * @param boolean $blnFeatured + * @param integer $limit + * @param integer $offset + * @param \ModuleNewsList $objModule + * + * @return Model\Collection|NewsModel|null|boolean + */ + public function newsListFetchItems($newsArchives, $blnFeatured, $limit, $offset, $objModule) + { + // check if filter is active in module + if (!$objModule->relatedOnly) + { + return false; + } + + // check if news archives are defined + if (!$newsArchives) + { + return null; + } + + // get the table and prepare columns, values and options + $t = \NewsModel::getTable(); + $arrColumns = array("$t.pid IN(" . implode(',', array_map('intval', $newsArchives)) . ")"); + $arrValues = array(); + $arrOptions = array(); + + // get the active item + $item = \Config::get('useAutoItem') ? \Input::get('auto_item') : !\Input::get('items'); + + // check if there is an active tem + if (!$item) + { + return null; + } + + // get the news + $objNews = \NewsModel::findByAlias($item); + + // check if news was found + if (!$objNews) + { + return null; + } + + // Get the related news + $arrRelated = deserialize($objNews->relatedNews); + + // Check if any related news are defined + if (!$arrRelated) + { + return null; + } + + // add related news + $arrColumns[] = "$t.id IN(" . implode(',', array_map('intval', $arrRelated )) . ")"; + + // regular news list stuff + if ($blnFeatured === true) + { + $arrColumns[] = "$t.featured='1'"; + } + elseif ($blnFeatured === false) + { + $arrColumns[] = "$t.featured=''"; + } + + if (!BE_USER_LOGGED_IN || TL_MODE == 'BE') + { + $time = \Date::floorToMinute(); + $arrColumns[] = "($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'" . ($time + 60) . "') AND $t.published='1'"; + } + + $arrOptions['limit'] = $limit; + $arrOptions['offset'] = $offset; + + // support for news_sorted and news_sorting + switch ($objModule->news_sorting) + { + case 'list_date_asc': + case 'sort_date_asc': + $arrOptions['order'] = "$t.date ASC"; + break; + + case 'list_headline_asc': + case 'sort_headline_asc': + $arrOptions['order'] = "$t.headline ASC"; + break; + + case 'list_headline_desc': + case 'sort_headline_desc': + $arrOptions['order'] = "$t.headline DESC"; + break; + + case 'list_random': + case 'sort_random': + $arrOptions['order'] = "RAND()"; + break; + + default: + $arrOptions['order'] = "$t.date DESC"; + } + + // support for news_categories + if (class_exists('\NewsCategories\NewsModel')) + { + $GLOBALS['NEWS_FILTER_CATEGORIES'] = $objModule->news_filterCategories ? true : false; + $GLOBALS['NEWS_FILTER_DEFAULT'] = deserialize($objModule->news_filterDefault, true); + $GLOBALS['NEWS_FILTER_PRESERVE'] = $objModule->news_filterPreserve; + + $arrColumns = self::filterByCategories($arrColumns); + + unset($GLOBALS['NEWS_FILTER_CATEGORIES'], $GLOBALS['NEWS_FILTER_DEFAULT'], $GLOBALS['NEWS_FILTER_PRESERVE']); + } + + // Return result + return self::findBy($arrColumns, $arrValues, $arrOptions); + } +} \ No newline at end of file diff --git a/src/Resources/contao/config/config.php b/src/Resources/contao/config/config.php new file mode 100644 index 0000000..4cf8ef5 --- /dev/null +++ b/src/Resources/contao/config/config.php @@ -0,0 +1,23 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +/** + * Hooks + */ +if (isset($GLOBALS['TL_HOOKS']['newsListFetchItems'])) +{ + array_unshift($GLOBALS['TL_HOOKS']['newsListFetchItems'], array('ContaoNewsRelatedBundle\Models\NewsRelatedModel','newsListFetchItems')); +} +else +{ + $GLOBALS['TL_HOOKS']['newsListFetchItems'] = array(array('ContaoNewsRelatedBundle\Models\NewsRelatedModel','newsListFetchItems')); +} diff --git a/src/Resources/contao/dca/tl_module.php b/src/Resources/contao/dca/tl_module.php new file mode 100644 index 0000000..b24c030 --- /dev/null +++ b/src/Resources/contao/dca/tl_module.php @@ -0,0 +1,22 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_DCA']['tl_module']['palettes']['newslist'] = str_replace(',skipFirst', ',skipFirst,relatedOnly', $GLOBALS['TL_DCA']['tl_module']['palettes']['newslist']); + +$GLOBALS['TL_DCA']['tl_module']['fields']['relatedOnly'] = array +( + 'label' => &$GLOBALS['TL_LANG']['tl_module']['relatedOnly'], + 'exclude' => true, + 'inputType' => 'checkbox', + 'eval' => array('tl_class'=>'clr w50'), + 'sql' => "char(1) NOT NULL default ''" +); diff --git a/src/Resources/contao/dca/tl_news.php b/src/Resources/contao/dca/tl_news.php new file mode 100644 index 0000000..12dc666 --- /dev/null +++ b/src/Resources/contao/dca/tl_news.php @@ -0,0 +1,24 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_DCA']['tl_news']['palettes']['default'].= ';{related_news_legend:hide},relatedNews'; + +$GLOBALS['TL_DCA']['tl_news']['fields']['relatedNews'] = array +( + 'label' => &$GLOBALS['TL_LANG']['tl_news']['relatedNews'], + 'exclude' => true, + 'inputType' => 'select', + 'foreignKey' => 'tl_news.headline', + 'eval' => array('multiple'=>true, 'chosen'=>true, 'tl_style'=>'height:auto', 'tl_class'=>'clr'), + 'relation' => array('type'=>'belongsToMany', 'load'=>'lazy'), + 'sql' => "blob NULL" +); diff --git a/src/Resources/contao/languages/de/tl_module.php b/src/Resources/contao/languages/de/tl_module.php new file mode 100644 index 0000000..8271db9 --- /dev/null +++ b/src/Resources/contao/languages/de/tl_module.php @@ -0,0 +1,13 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_LANG']['tl_module']['relatedOnly'] = array('Nur verwandte Einträge anzeigen','Beschränkt die Ausgabe auf verwandte Artikel.'); diff --git a/src/Resources/contao/languages/de/tl_news.php b/src/Resources/contao/languages/de/tl_news.php new file mode 100644 index 0000000..cf789ea --- /dev/null +++ b/src/Resources/contao/languages/de/tl_news.php @@ -0,0 +1,13 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_LANG']['tl_news']['relatedNews'] = array('Verwandte News', 'Wählen Sie andere Beiträge aus, die mit diesem Beitrag verwandt sind.'); diff --git a/src/Resources/contao/languages/en/tl_module.php b/src/Resources/contao/languages/en/tl_module.php new file mode 100644 index 0000000..e1a65bc --- /dev/null +++ b/src/Resources/contao/languages/en/tl_module.php @@ -0,0 +1,13 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_LANG']['tl_module']['relatedOnly'] = array('Show only related entries','Limits the output to related entries.'); diff --git a/src/Resources/contao/languages/en/tl_news.php b/src/Resources/contao/languages/en/tl_news.php new file mode 100644 index 0000000..25e9fe9 --- /dev/null +++ b/src/Resources/contao/languages/en/tl_news.php @@ -0,0 +1,14 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + + +$GLOBALS['TL_LANG']['tl_news']['related_news_legend'] = 'Related news'; +$GLOBALS['TL_LANG']['tl_news']['relatedNews'] = array('Related news', 'Choose any other news entries here, that are related to this entry.');