namespace Shaarli\Formatter;
-use DateTime;
-use Shaarli\Config\ConfigManager;
+use DateTimeInterface;
use Shaarli\Bookmark\Bookmark;
+use Shaarli\Config\ConfigManager;
/**
* Class BookmarkFormatter
*
* Abstract class processing all bookmark attributes through methods designed to be overridden.
*
+ * List of available formatted fields:
+ * - id ID
+ * - shorturl Unique identifier, used in permalinks
+ * - url URL, can be altered in some way, e.g. passing through an HTTP reverse proxy
+ * - real_url (legacy) same as `url`
+ * - url_html URL to be displayed in HTML content (it can contain HTML tags)
+ * - title Title
+ * - title_html Title to be displayed in HTML content (it can contain HTML tags)
+ * - description Description content. It most likely contains HTML tags
+ * - thumbnail Thumbnail: path to local cache file, false if there is none, null if hasn't been retrieved
+ * - taglist List of tags (array)
+ * - taglist_urlencoded List of tags (array) URL encoded: it must be used to create a link to a URL containing a tag
+ * - taglist_html List of tags (array) to be displayed in HTML content (it can contain HTML tags)
+ * - tags Tags separated by a single whitespace
+ * - tags_urlencoded Tags separated by a single whitespace, URL encoded: must be used to create a link
+ * - sticky Is sticky (bool)
+ * - private Is private (bool)
+ * - class Additional CSS class
+ * - created Creation DateTime
+ * - updated Last edit DateTime
+ * - timestamp Creation timestamp
+ * - updated_timestamp Last edit timestamp
+ *
* @package Shaarli\Formatter
*/
abstract class BookmarkFormatter
*/
protected $conf;
+ /** @var bool */
+ protected $isLoggedIn;
+
/**
* @var array Additional parameters than can be used for specific formatting
* e.g. index_url for Feed formatting
* LinkDefaultFormatter constructor.
* @param ConfigManager $conf
*/
- public function __construct(ConfigManager $conf)
+ public function __construct(ConfigManager $conf, bool $isLoggedIn)
{
$this->conf = $conf;
+ $this->isLoggedIn = $isLoggedIn;
}
/**
$out['shorturl'] = $this->formatShortUrl($bookmark);
$out['url'] = $this->formatUrl($bookmark);
$out['real_url'] = $this->formatRealUrl($bookmark);
+ $out['url_html'] = $this->formatUrlHtml($bookmark);
$out['title'] = $this->formatTitle($bookmark);
+ $out['title_html'] = $this->formatTitleHtml($bookmark);
$out['description'] = $this->formatDescription($bookmark);
$out['thumbnail'] = $this->formatThumbnail($bookmark);
$out['taglist'] = $this->formatTagList($bookmark);
+ $out['taglist_urlencoded'] = $this->formatTagListUrlEncoded($bookmark);
+ $out['taglist_html'] = $this->formatTagListHtml($bookmark);
$out['tags'] = $this->formatTagString($bookmark);
+ $out['tags_urlencoded'] = $this->formatTagStringUrlEncoded($bookmark);
$out['sticky'] = $bookmark->isSticky();
$out['private'] = $bookmark->isPrivate();
$out['class'] = $this->formatClass($bookmark);
$out['updated'] = $this->formatUpdated($bookmark);
$out['timestamp'] = $this->formatCreatedTimestamp($bookmark);
$out['updated_timestamp'] = $this->formatUpdatedTimestamp($bookmark);
+
return $out;
}
public function addContextData($key, $value)
{
$this->contextData[$key] = $value;
+
+ return $this;
}
/**
*/
protected function formatRealUrl($bookmark)
{
- return $bookmark->getUrl();
+ return $this->formatUrl($bookmark);
+ }
+
+ /**
+ * Format Url Html: to be displayed in HTML content, it can contains HTML tags.
+ *
+ * @param Bookmark $bookmark instance
+ *
+ * @return string formatted Url HTML
+ */
+ protected function formatUrlHtml($bookmark)
+ {
+ return $this->formatUrl($bookmark);
}
/**
return $bookmark->getTitle();
}
+ /**
+ * Format Title HTML: to be displayed in HTML content, it can contains HTML tags.
+ *
+ * @param Bookmark $bookmark instance
+ *
+ * @return string formatted Title
+ */
+ protected function formatTitleHtml($bookmark)
+ {
+ return $bookmark->getTitle();
+ }
+
/**
* Format Description
*
*/
protected function formatTagList($bookmark)
{
- return $bookmark->getTags();
+ return $this->filterTagList($bookmark->getTags());
+ }
+
+ /**
+ * Format Url Encoded Tags
+ *
+ * @param Bookmark $bookmark instance
+ *
+ * @return array formatted Tags
+ */
+ protected function formatTagListUrlEncoded($bookmark)
+ {
+ return array_map('urlencode', $this->filterTagList($bookmark->getTags()));
+ }
+
+ /**
+ * Format Tags HTML: to be displayed in HTML content, it can contains HTML tags.
+ *
+ * @param Bookmark $bookmark instance
+ *
+ * @return array formatted Tags
+ */
+ protected function formatTagListHtml($bookmark)
+ {
+ return $this->formatTagList($bookmark);
}
/**
*/
protected function formatTagString($bookmark)
{
- return implode(' ', $bookmark->getTags());
+ return implode($this->conf->get('general.tags_separator', ' '), $this->formatTagList($bookmark));
+ }
+
+ /**
+ * Format TagString
+ *
+ * @param Bookmark $bookmark instance
+ *
+ * @return string formatted TagString
+ */
+ protected function formatTagStringUrlEncoded($bookmark)
+ {
+ return implode(' ', $this->formatTagListUrlEncoded($bookmark));
}
/**
*
* @param Bookmark $bookmark instance
*
- * @return DateTime instance
+ * @return DateTimeInterface instance
*/
protected function formatCreated(Bookmark $bookmark)
{
*
* @param Bookmark $bookmark instance
*
- * @return DateTime instance
+ * @return DateTimeInterface instance
*/
protected function formatUpdated(Bookmark $bookmark)
{
}
return 0;
}
+
+ /**
+ * Format tag list, e.g. remove private tags if the user is not logged in.
+ * TODO: this method is called multiple time to format tags, the result should be cached.
+ *
+ * @param array $tags
+ *
+ * @return array
+ */
+ protected function filterTagList(array $tags): array
+ {
+ if ($this->isLoggedIn === true) {
+ return $tags;
+ }
+
+ $out = [];
+ foreach ($tags as $tag) {
+ if (strpos($tag, '.') === 0) {
+ continue;
+ }
+
+ $out[] = $tag;
+ }
+
+ return $out;
+ }
}
projects / github / shaarli / Shaarli.git / blobdiff