joomla
/
weblinks
mirror of https://github.com/joomla-extensions/weblinks.git
30
1
Fork 0
Code Issues Releases Activity

Merge branch '4.0-dev' into convert_finder_weblinks_plugin

This commit is contained in:
Tuan Pham Ngoc 2023-03-16 17:50:04 +07:00
parent 6262e22a18 4c2f6f5d7e
commit 1451e89e98
9 changed files with 223 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/administrator/components/com_weblinks/script.php
View File

@ -48,6 +48,8 @@ class Com_WeblinksInstallerScript
'/language/en-GB/en-GB.mod_weblinks.sys.ini',
'/language/en-GB/en-GB.pkg_weblinks.sys.ini',
'/modules/mod_weblinks/helper.php',
'/modules/mod_weblinks/mod_weblinks.php',
'/plugins/search/weblinks/weblinks.php',
];
$folders = [

24
src/modules/mod_weblinks/mod_weblinks.php
View File

@ -1,24 +0,0 @@
<?php
/**
* @package Joomla.Administrator
* @subpackage Weblinks
*
* @copyright Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
use Joomla\CMS\Helper\ModuleHelper;
use Joomla\Module\Weblinks\Site\Helper\WeblinksHelper;
$list = WeblinksHelper::getList($params, $app);
if (empty($list))
{
return;
}
$moduleclass_sfx = htmlspecialchars($params->get('moduleclass_sfx'));
require ModuleHelper::getLayoutPath('mod_weblinks', $params->get('layout', 'default'));

1
src/modules/mod_weblinks/mod_weblinks.xml
View File

@ -12,7 +12,6 @@
<namespace path="src">Joomla\Module\Weblinks</namespace>
<files>
##MODULE_FILES##
<file module="mod_weblinks">mod_weblinks.php</file>
</files>
<languages folder="language">
##LANGUAGE_FILES##

41
src/modules/mod_weblinks/services/provider.php Normal file
View File

@ -0,0 +1,41 @@
<?php
/**
* @package Joomla.Site
* @subpackage mod_weblinks
*
* @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
use Joomla\CMS\Extension\Service\Provider\HelperFactory;
use Joomla\CMS\Extension\Service\Provider\Module;
use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
/**
* The weblinks module services provider.
*
* @since __DEPLOY_VERSION__
*/
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since __DEPLOY_VERSION__
*/
public function register(Container $container)
{
$container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\Weblinks'));
$container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\Weblinks\\Site\\Helper'));
$container->registerServiceProvider(new Module());
}
};

50
src/modules/mod_weblinks/src/Dispatcher/Dispatcher.php Normal file
View File

@ -0,0 +1,50 @@
<?php
/**
* @package Joomla.Site
* @subpackage mod_weblinks
*
* @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Module\Weblinks\Site\Dispatcher;
use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
use Joomla\CMS\Helper\HelperFactoryAwareInterface;
use Joomla\CMS\Helper\HelperFactoryAwareTrait;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Dispatcher class for mod_weblinks
*
* @since __DEPLOY_VERSION__
*/
class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
{
use HelperFactoryAwareTrait;
/**
* Returns the layout data.
*
* @return array
*
* @since __DEPLOY_VERSION__
*/
protected function getLayoutData()
{
$data = parent::getLayoutData();
$data['list'] = $this->getHelperFactory()->getHelper('WeblinksHelper')->getWeblinks(
$data['params'],
$this->getApplication()
);
$data['moduleclass_sfx'] = htmlspecialchars($data['params']->get('moduleclass_sfx', ''));
return $data;
}
}

28
src/modules/mod_weblinks/src/Helper/WeblinksHelper.php
View File

@ -29,14 +29,13 @@ class WeblinksHelper
* @param Registry $params The module parameters
* @param CMSApplicationInterface $app The application
*
* @return mixed Null if no weblinks based on input parameters else an array containing all the weblinks.
* @return array Array containing all the weblinks.
*
* @since 1.5
* @since __DEPLOY_VERSION__
**/
public static function getList($params, $app)
public function getWeblinks($params, $app)
{
// @var \Joomla\Component\Weblinks\Site\Model\CategoryModel $model
$model = $app->bootComponent('com_weblinks')->getMVCFactory()
->createModel('Category', 'Site', ['ignore_request' => true]);
@ -73,7 +72,7 @@ class WeblinksHelper
$case_when1 .= $query->charLength('a.alias', '!=', '0');
$case_when1 .= ' THEN ';
$a_id = $query->castAs('CHAR', 'a.id');
$case_when1 .= $query->concatenate(array($a_id, 'a.alias'), ':');
$case_when1 .= $query->concatenate([$a_id, 'a.alias'], ':');
$case_when1 .= ' ELSE ';
$case_when1 .= $a_id . ' END as slug';
@ -81,7 +80,7 @@ class WeblinksHelper
$case_when2 .= $query->charLength('c.alias', '!=', '0');
$case_when2 .= ' THEN ';
$c_id = $query->castAs('CHAR', 'c.id');
$case_when2 .= $query->concatenate(array($c_id, 'c.alias'), ':');
$case_when2 .= $query->concatenate([$c_id, 'c.alias'], ':');
$case_when2 .= ' ELSE ';
$case_when2 .= $c_id . ' END as catslug';
@ -120,4 +119,21 @@ class WeblinksHelper
return [];
}
/**
* Retrieve list of weblinks
*
* @param Registry $params The module parameters
* @param CMSApplicationInterface $app The application
*
* @return mixed Null if no weblinks based on input parameters else an array containing all the weblinks.
*
* @since 1.5
*
* @deprecated 5.0 Use the none static function getWeblinks
**/
public static function getList($params, $app)
{
return (new self())->getWeblinks($params, $app);
}
}

50
src/plugins/search/weblinks/services/provider.php Normal file
View File

@ -0,0 +1,50 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Search.weblinks
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Search\Weblinks\Extension\Weblinks;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since __DEPLOY_VERSION__
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$app = Factory::getApplication();
$dispatcher = $container->get(DispatcherInterface::class);
$database = $container->get(DatabaseInterface::class);
return new Weblinks(
$dispatcher,
(array) PluginHelper::getPlugin('finder', 'weblinks'),
$app,
$database
);
}
);
}
};

107
src/plugins/search/weblinks/weblinks.php → src/plugins/search/weblinks/src/Extension/Weblinks.php
View File

@ -7,37 +7,28 @@
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
namespace Joomla\Plugin\Search\Weblinks\Extension;
use Joomla\CMS\Application\CMSApplicationInterface;
use Joomla\CMS\Language\Multilanguage;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Component\Search\Administrator\Helper\SearchHelper;
use Joomla\Component\Weblinks\Site\Helper\RouteHelper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\ParameterType;
use Joomla\Event\DispatcherInterface;
defined('_JEXEC') or die;
/**
* Weblinks search plugin.
*
* @since 1.6
*/
class PlgSearchWeblinks extends CMSPlugin
final class Weblinks extends CMSPlugin
{
/**
* Application object
*
* @var \Joomla\CMS\Application\CMSApplicationInterface
* @since 4.0.0
*/
protected $app;
/**
* Database Driver Instance
*
* @var \Joomla\Database\DatabaseDriver
* @since 4.0.0
*/
protected $db;
use DatabaseAwareTrait;
/**
* Load the language file on instantiation.
@ -47,6 +38,22 @@ class PlgSearchWeblinks extends CMSPlugin
*/
protected $autoloadLanguage = true;
/**
* Constructor
*
* @param DispatcherInterface $dispatcher
* @param array $config
* @param CMSApplicationInterface $application
* @param DatabaseInterface $database
*/
public function __construct(DispatcherInterface $dispatcher, array $config, CMSApplicationInterface $application, DatabaseInterface $database)
{
parent::__construct($dispatcher, $config);
$this->setApplication($application);
$this->setDatabase($database);
}
/**
* Determine areas searchable by this plugin.
*
@ -56,9 +63,9 @@ class PlgSearchWeblinks extends CMSPlugin
*/
public function onContentSearchAreas()
{
static $areas = array(
'weblinks' => 'PLG_SEARCH_WEBLINKS_WEBLINKS'
);
static $areas = [
'weblinks' => 'PLG_SEARCH_WEBLINKS_WEBLINKS',
];
return $areas;
}
@ -80,23 +87,22 @@ class PlgSearchWeblinks extends CMSPlugin
*/
public function onContentSearch($text, $phrase = '', $ordering = '', $areas = null)
{
$db = $this->db;
$groups = $this->app->getIdentity()->getAuthorisedViewLevels();
$app = $this->getApplication();
$db = $this->getDatabase();
$groups = $app->getIdentity()->getAuthorisedViewLevels();
$searchText = $text;
if (is_array($areas))
if (is_array($areas)
&& !array_intersect($areas, array_keys($this->onContentSearchAreas())))
{
if (!array_intersect($areas, array_keys($this->onContentSearchAreas())))
{
return array();
}
return [];
}
$sContent = $this->params->get('search_content', 1);
$sContent = $this->params->get('search_content', 1);
$sArchived = $this->params->get('search_archived', 1);
$limit = $this->params->def('search_limit', 50);
$state = array();
$limit = $this->params->def('search_limit', 50);
$state = [];
if ($sContent)
{
@ -110,14 +116,14 @@ class PlgSearchWeblinks extends CMSPlugin
if (empty($state))
{
return array();
return [];
}
$text = trim($text);
if ($text == '')
{
return array();
return [];
}
$searchWeblinks = Text::_('PLG_SEARCH_WEBLINKS');
@ -125,28 +131,28 @@ class PlgSearchWeblinks extends CMSPlugin
switch ($phrase)
{
case 'exact':
$text = $db->quote('%' . $db->escape($text, true) . '%', false);
$wheres2 = array();
$text = $db->quote('%' . $db->escape($text, true) . '%', false);
$wheres2 = [];
$wheres2[] = 'a.url LIKE ' . $text;
$wheres2[] = 'a.description LIKE ' . $text;
$wheres2[] = 'a.title LIKE ' . $text;
$where = '(' . implode(') OR (', $wheres2) . ')';
$where = '(' . implode(') OR (', $wheres2) . ')';
break;
case 'all':
case 'any':
default:
$words = explode(' ', $text);
$wheres = array();
$words = explode(' ', $text);
$wheres = [];
foreach ($words as $word)
{
$word = $db->quote('%' . $db->escape($word, true) . '%', false);
$wheres2 = array();
$word = $db->quote('%' . $db->escape($word, true) . '%', false);
$wheres2 = [];
$wheres2[] = 'a.url LIKE ' . $word;
$wheres2[] = 'a.description LIKE ' . $word;
$wheres2[] = 'a.title LIKE ' . $word;
$wheres[] = implode(' OR ', $wheres2);
$wheres[] = implode(' OR ', $wheres2);
}
$where = '(' . implode(($phrase == 'all' ? ') AND (' : ') OR ('), $wheres) . ')';
@ -182,21 +188,21 @@ class PlgSearchWeblinks extends CMSPlugin
$caseWhen = ' CASE WHEN ';
$caseWhen .= $query->charLength('a.alias', '!=', '0');
$caseWhen .= ' THEN ';
$a_id = $query->castAs('CHAR', 'a.id');
$caseWhen .= $query->concatenate(array($a_id, 'a.alias'), ':');
$a_id = $query->castAs('CHAR', 'a.id');
$caseWhen .= $query->concatenate([$a_id, 'a.alias'], ':');
$caseWhen .= ' ELSE ';
$caseWhen .= $a_id . ' END as slug';
$caseWhen1 = ' CASE WHEN ';
$caseWhen1 .= $query->charLength('c.alias', '!=', '0');
$caseWhen1 .= ' THEN ';
$c_id = $query->castAs('CHAR', 'c.id');
$caseWhen1 .= $query->concatenate(array($c_id, 'c.alias'), ':');
$c_id = $query->castAs('CHAR', 'c.id');
$caseWhen1 .= $query->concatenate([$c_id, 'c.alias'], ':');
$caseWhen1 .= ' ELSE ';
$caseWhen1 .= $c_id . ' END as catslug';
$query->select('a.title AS title, a.created AS created, a.url, a.description AS text, ' . $caseWhen . "," . $caseWhen1)
->select($query->concatenate(array($db->quote($searchWeblinks), 'c.title'), " / ") . ' AS section')
->select($query->concatenate([$db->quote($searchWeblinks), 'c.title'], " / ") . ' AS section')
->select('\'1\' AS browsernav')
->from('#__weblinks AS a')
->join('INNER', '#__categories as c ON c.id = a.catid')
@ -207,9 +213,10 @@ class PlgSearchWeblinks extends CMSPlugin
->order($order);
// Filter by language.
if ($this->app->isClient('site') && Multilanguage::isEnabled())
if ($app->isClient('site') && Multilanguage::isEnabled())
{
$languages = [$this->app->getLanguage()->getTag(), '*'];
$languages = [$app->getLanguage()->getTag(), '*'];
$query->whereIn($db->quoteName('a.language'), $languages, ParameterType::STRING)
->whereIn($db->quoteName('c.language'), $languages, ParameterType::STRING);
}
@ -217,7 +224,7 @@ class PlgSearchWeblinks extends CMSPlugin
$db->setQuery($query, 0, $limit);
$rows = $db->loadObjectList();
$return = array();
$return = [];
if ($rows)
{
@ -228,7 +235,7 @@ class PlgSearchWeblinks extends CMSPlugin
foreach ($rows as $weblink)
{
if (SearchHelper::checkNoHTML($weblink, $searchText, array('url', 'text', 'title')))
if (\searchHelper::checkNoHTML($weblink, $searchText, ['url', 'text', 'title']))
{
$return[] = $weblink;
}

1
src/plugins/search/weblinks/weblinks.xml
View File

@ -9,6 +9,7 @@
<authorUrl>www.joomla.org</authorUrl>
<version>##VERSION##</version>
<description>PLG_SEARCH_WEBLINKS_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Search\Weblinks</namespace>
<files>
##FILES##
</files>