namespacing: \Shaarli\Bookmark\LinkFilter

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-12-03 01:22:45 +01:00 · 2018-12-03 01:22:45 +01:00 · 6696729b88
parent f24896b237
commit 6696729b88
8 changed files with 66 additions and 50 deletions
--- a/application/Updater.php
+++ b/application/Updater.php
@ -1,6 +1,7 @@
 <?php

 use Shaarli\Bookmark\LinkDB;
+use Shaarli\Bookmark\LinkFilter;
 use Shaarli\Config\ConfigJson;
 use Shaarli\Config\ConfigPhp;
 use Shaarli\Config\ConfigManager;
--- a/application/bookmark/LinkDB.php
+++ b/application/bookmark/LinkDB.php
@ -6,8 +6,8 @@ use ArrayAccess;
 use Countable;
 use DateTime;
 use Iterator;
-use LinkFilter;
-use LinkNotFoundException;
+use Shaarli\Bookmark\LinkFilter;
+use Shaarli\Bookmark\Exception\LinkNotFoundException;
 use Shaarli\Exceptions\IOException;
 use Shaarli\FileUtils;

@ -107,10 +107,10 @@ class LinkDB implements Iterator, Countable, ArrayAccess
     *
     * Checks if the datastore exists; else, attempts to create a dummy one.
     *
-     * @param string $datastore datastore file path.
-     * @param boolean $isLoggedIn is the user logged in?
-     * @param boolean $hidePublicLinks if true all links are private.
-     * @param string $redirector link redirector set in user settings.
+     * @param string  $datastore        datastore file path.
+     * @param boolean $isLoggedIn       is the user logged in?
+     * @param boolean $hidePublicLinks  if true all links are private.
+     * @param string  $redirector       link redirector set in user settings.
     * @param boolean $redirectorEncode Enable urlencode on redirected urls (default: true).
     */
    public function __construct(
@ -426,12 +426,12 @@ You use the community supported version of the original Shaarli project, by Seba
    /**
     * Filter links according to search parameters.
     *
-     * @param array $filterRequest Search request content. Supported keys:
+     * @param array  $filterRequest  Search request content. Supported keys:
     *                                - searchtags: list of tags
     *                                - searchterm: term search
-     * @param bool $casesensitive Optional: Perform case sensitive filter
-     * @param string $visibility return only all/private/public links
-     * @param string $untaggedonly return only untagged links
+     * @param bool   $casesensitive  Optional: Perform case sensitive filter
+     * @param string $visibility     return only all/private/public links
+     * @param bool   $untaggedonly   return only untagged links
     *
     * @return array filtered links, all links if no suitable filter was provided.
     */
@ -457,8 +457,8 @@ You use the community supported version of the original Shaarli project, by Seba
    /**
     * Returns the list tags appearing in the links with the given tags
     *
-     * @param array $filteringTags tags selecting the links to consider
-     * @param string $visibility process only all/private/public links
+     * @param array  $filteringTags tags selecting the links to consider
+     * @param string $visibility    process only all/private/public links
     *
     * @return array tag => linksCount
     */
@ -500,7 +500,7 @@ You use the community supported version of the original Shaarli project, by Seba
     * Rename or delete a tag across all links.
     *
     * @param string $from Tag to rename
-     * @param string $to New tag. If none is provided, the from tag will be deleted
+     * @param string $to   New tag. If none is provided, the from tag will be deleted
     *
     * @return array|bool List of altered links or false on error
     */
--- a/application/bookmark/LinkFilter.php
+++ b/application/bookmark/LinkFilter.php
@ -1,6 +1,9 @@
 <?php

-use Shaarli\Bookmark\LinkDB;
+namespace Shaarli\Bookmark;
+
+use Exception;
+use Shaarli\Bookmark\Exception\LinkNotFoundException;

 /**
 * Class LinkFilter.
@ -12,22 +15,22 @@ class LinkFilter
    /**
     * @var string permalinks.
     */
-    public static $FILTER_HASH   = 'permalink';
+    public static $FILTER_HASH = 'permalink';

    /**
     * @var string text search.
     */
-    public static $FILTER_TEXT   = 'fulltext';
+    public static $FILTER_TEXT = 'fulltext';

    /**
     * @var string tag filter.
     */
-    public static $FILTER_TAG    = 'tags';
+    public static $FILTER_TAG = 'tags';

    /**
     * @var string filter by day.
     */
-    public static $FILTER_DAY    = 'FILTER_DAY';
+    public static $FILTER_DAY = 'FILTER_DAY';

    /**
     * @var string Allowed characters for hashtags (regex syntax).
@ -60,7 +63,7 @@ class LinkFilter
     */
    public function filter($type, $request, $casesensitive = false, $visibility = 'all', $untaggedonly = false)
    {
-        if (! in_array($visibility, ['all', 'public', 'private'])) {
+        if (!in_array($visibility, ['all', 'public', 'private'])) {
            $visibility = 'all';
        }

@ -119,7 +122,7 @@ class LinkFilter
        foreach ($this->links as $key => $value) {
            if ($value['private'] && $visibility === 'private') {
                $out[$key] = $value;
-            } elseif (! $value['private'] && $visibility === 'public') {
+            } elseif (!$value['private'] && $visibility === 'public') {
                $out[$key] = $value;
            }
        }
@ -134,7 +137,7 @@ class LinkFilter
     *
     * @return array $filtered array containing permalink data.
     *
-     * @throws LinkNotFoundException if the smallhash doesn't match any link.
+     * @throws \Shaarli\Bookmark\Exception\LinkNotFoundException if the smallhash doesn't match any link.
     */
    private function filterSmallHash($smallHash)
    {
@ -171,7 +174,7 @@ class LinkFilter
     *  - see https://github.com/shaarli/Shaarli/issues/75 for examples
     *
     * @param string $searchterms search query.
-     * @param string $visibility Optional: return only all/private/public links.
+     * @param string $visibility  Optional: return only all/private/public links.
     *
     * @return array search results.
     */
@ -209,7 +212,7 @@ class LinkFilter
        foreach ($this->links as $id => $link) {
            // ignore non private links when 'privatonly' is on.
            if ($visibility !== 'all') {
-                if (! $link['private'] && $visibility === 'private') {
+                if (!$link['private'] && $visibility === 'private') {
                    continue;
                } elseif ($link['private'] && $visibility === 'public') {
                    continue;
@ -252,7 +255,9 @@ class LinkFilter

    /**
     * generate a regex fragment out of a tag
+     *
     * @param string $tag to to generate regexs from. may start with '-' to negate, contain '*' as wildcard
+     *
     * @return string generated regex fragment
     */
    private static function tag2regex($tag)
@ -336,7 +341,7 @@ class LinkFilter
            // check level of visibility
            // ignore non private links when 'privateonly' is on.
            if ($visibility !== 'all') {
-                if (! $link['private'] && $visibility === 'private') {
+                if (!$link['private'] && $visibility === 'private') {
                    continue;
                } elseif ($link['private'] && $visibility === 'public') {
                    continue;
@ -379,7 +384,7 @@ class LinkFilter
        $filtered = [];
        foreach ($this->links as $key => $link) {
            if ($visibility !== 'all') {
-                if (! $link['private'] && $visibility === 'private') {
+                if (!$link['private'] && $visibility === 'private') {
                    continue;
                } elseif ($link['private'] && $visibility === 'public') {
                    continue;
@ -408,7 +413,7 @@ class LinkFilter
     */
    public function filterDay($day)
    {
-        if (! checkDateFormat('Ymd', $day)) {
+        if (!checkDateFormat('Ymd', $day)) {
            throw new Exception('Invalid date format');
        }

@ -442,14 +447,3 @@ class LinkFilter
        return preg_split('/\s+/', $tagsOut, -1, PREG_SPLIT_NO_EMPTY);
    }
 }
-
-class LinkNotFoundException extends Exception
-{
-    /**
-     * LinkNotFoundException constructor.
-     */
-    public function __construct()
-    {
-        $this->message =  t('The link you are trying to reach does not exist or has been deleted.');
-    }
-}
--- a/application/bookmark/exception/LinkNotFoundException.php
+++ b/application/bookmark/exception/LinkNotFoundException.php
@ -0,0 +1,15 @@
+<?php
+namespace Shaarli\Bookmark\Exception;
+
+use Exception;
+
+class LinkNotFoundException extends Exception
+{
+    /**
+     * LinkNotFoundException constructor.
+     */
+    public function __construct()
+    {
+        $this->message = t('The link you are trying to reach does not exist or has been deleted.');
+    }
+}
--- a/composer.json
+++ b/composer.json
@ -36,6 +36,7 @@
            "Shaarli\\Api\\Controllers\\": "application/api/controllers",
            "Shaarli\\Api\\Exceptions\\": "application/api/exceptions",
            "Shaarli\\Bookmark\\": "application/bookmark",
+            "Shaarli\\Bookmark\\Exception\\": "application/bookmark/exception",
            "Shaarli\\Config\\": "application/config/",
            "Shaarli\\Config\\Exception\\": "application/config/exception",
            "Shaarli\\Exceptions\\": "application/exceptions",
--- a/index.php
+++ b/index.php
@ -63,7 +63,6 @@ require_once 'application/http/HttpUtils.php';
 require_once 'application/http/UrlUtils.php';
 require_once 'application/FileUtils.php';
 require_once 'application/History.php';
-require_once 'application/LinkFilter.php';
 require_once 'application/LinkUtils.php';
 require_once 'application/NetscapeBookmarkUtils.php';
 require_once 'application/TimeZone.php';
@ -72,6 +71,7 @@ require_once 'application/PluginManager.php';
 require_once 'application/Router.php';
 require_once 'application/Updater.php';

+use \Shaarli\Bookmark\Exception\LinkNotFoundException;
 use \Shaarli\Bookmark\LinkDB;
 use \Shaarli\Config\ConfigManager;
 use \Shaarli\Feed\CachedPage;
--- a/tests/bookmark/LinkDBTest.php
+++ b/tests/bookmark/LinkDBTest.php
@ -6,7 +6,7 @@
 namespace Shaarli\Bookmark;

 use DateTime;
-use LinkNotFoundException;
+use Shaarli\Bookmark\Exception\LinkNotFoundException;
 use ReferenceLinkDB;
 use ReflectionClass;
 use Shaarli;
@ -457,7 +457,7 @@ class LinkDBTest extends \PHPUnit\Framework\TestCase
    /**
     * Test filterHash() with an invalid smallhash.
     *
-     * @expectedException LinkNotFoundException
+     * @expectedException \Shaarli\Bookmark\Exception\LinkNotFoundException
     */
    public function testFilterHashInValid1()
    {
@ -468,7 +468,7 @@ class LinkDBTest extends \PHPUnit\Framework\TestCase
    /**
     * Test filterHash() with an empty smallhash.
     *
-     * @expectedException LinkNotFoundException
+     * @expectedException \Shaarli\Bookmark\Exception\LinkNotFoundException
     */
    public function testFilterHashInValid()
    {
--- a/tests/bookmark/LinkFilterTest.php
+++ b/tests/bookmark/LinkFilterTest.php
@ -1,13 +1,14 @@
 <?php

-use Shaarli\Bookmark\LinkDB;
+namespace Shaarli\Bookmark;

-require_once 'application/LinkFilter.php';
+use Exception;
+use ReferenceLinkDB;

 /**
 * Class LinkFilterTest.
 */
-class LinkFilterTest extends PHPUnit_Framework_TestCase
+class LinkFilterTest extends \PHPUnit\Framework\TestCase
 {
    /**
     * @var string Test datastore path.
@ -29,7 +30,7 @@ class LinkFilterTest extends PHPUnit_Framework_TestCase
    protected static $linkDB;

    /**
-     * Instanciate linkFilter with ReferenceLinkDB data.
+     * Instantiate linkFilter with ReferenceLinkDB data.
     */
    public static function setUpBeforeClass()
    {
@ -81,10 +82,14 @@ class LinkFilterTest extends PHPUnit_Framework_TestCase
            count(
                self::$linkFilter->filter(
                    LinkFilter::$FILTER_TAG,
-                    /*$request=*/'',
-                    /*$casesensitive=*/false,
-                    /*$visibility=*/'all',
-                    /*$untaggedonly=*/true
+                    /*$request=*/
+                    '',
+                    /*$casesensitive=*/
+                    false,
+                    /*$visibility=*/
+                    'all',
+                    /*$untaggedonly=*/
+                    true
                )
            )
        );
@ -229,7 +234,7 @@ class LinkFilterTest extends PHPUnit_Framework_TestCase
    /**
     * No link for this hash
     *
-     * @expectedException LinkNotFoundException
+     * @expectedException \Shaarli\Bookmark\Exception\LinkNotFoundException
     */
    public function testFilterUnknownSmallHash()
    {