X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FModel%2FFileTag.php;h=3539f2b96d9b0f019fc48444b7516cc285c7de45;hb=238c079d112be7ce16aab4e1b975bebefee4980a;hp=a5824f5347ca67a2f3a0115f22206d55b3547567;hpb=96402e306a4ea448f64df0f36346c05dcf221ab8;p=friendica.git

diff --git a/src/Model/FileTag.php b/src/Model/FileTag.php
index a5824f5347..3539f2b96d 100644
--- a/src/Model/FileTag.php
+++ b/src/Model/FileTag.php
@@ -1,16 +1,32 @@
 <?php
 /**
- * @file src/Model/FileTag.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
 
 namespace Friendica\Model;
 
-use Friendica\Core\L10n;
-use Friendica\Core\PConfig;
 use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\Term;
 
 /**
- * @brief This class handles FileTag related functions
+ * This class handles FileTag related functions
  *
  * post categories and "save to file" use the same item.file table for storage.
  * We will differentiate the different uses by wrapping categories in angle brackets
@@ -20,7 +36,7 @@ use Friendica\Database\DBA;
 class FileTag
 {
 	/**
-	 * @brief URL encode <, >, left and right brackets
+	 * URL encode <, >, left and right brackets
 	 *
 	 * @param string $s String to be URL encoded.
 	 *
@@ -32,7 +48,7 @@ class FileTag
 	}
 
 	/**
-	 * @brief URL decode <, >, left and right brackets
+	 * URL decode <, >, left and right brackets
 	 *
 	 * @param string $s The URL encoded string to be decoded
 	 *
@@ -44,7 +60,7 @@ class FileTag
 	}
 
 	/**
-	 * @brief Query files for tag
+	 * Query files for tag
 	 *
 	 * @param string $table The table to be queired.
 	 * @param string $s     The search term
@@ -64,31 +80,29 @@ class FileTag
 	}
 
 	/**
-	 * @brief Get file tags from list
+	 * Get file tags from array
 	 *
-	 * ex. given music,video return <music><video> or [music][video]
-	 * @param string $list A comma delimited list of tags.
-	 * @param string $type Optional file type.
+	 * ex. given [music,video] return <music><video> or [music][video]
+	 *
+	 * @param array  $array A list of tags.
+	 * @param string $type  Optional file type.
 	 *
 	 * @return string       A list of file tags.
 	 */
-	public static function listToFile($list, $type = 'file')
+	public static function arrayToFile(array $array, string $type = 'file')
 	{
 		$tag_list = '';
-		if (strlen($list)) {
-			$list_array = explode(",", $list);
-			if ($type == 'file') {
-				$lbracket = '[';
-				$rbracket = ']';
-			} else {
-				$lbracket = '<';
-				$rbracket = '>';
-			}
+		if ($type == 'file') {
+			$lbracket = '[';
+			$rbracket = ']';
+		} else {
+			$lbracket = '<';
+			$rbracket = '>';
+		}
 
-			foreach ($list_array as $item) {
-				if (strlen($item)) {
-					$tag_list .= $lbracket . self::encode(trim($item)) . $rbracket;
-				}
+		foreach ($array as $item) {
+			if (strlen($item)) {
+				$tag_list .= $lbracket . self::encode(trim($item)) . $rbracket;
 			}
 		}
 
@@ -96,18 +110,19 @@ class FileTag
 	}
 
 	/**
-	 * @brief Get list from file tags
+	 * Get tag list from file tags
+	 *
+	 * ex. given <music><video>[friends], return [music,video] or [friends]
 	 *
-	 * ex. given <music><video>[friends], return music,video or friends
 	 * @param string $file File tags
 	 * @param string $type Optional file type.
 	 *
-	 * @return string       Comma delimited list of tag names.
+	 * @return array        List of tag names.
 	 */
-	public static function fileToList($file, $type = 'file')
+	public static function fileToArray(string $file, string $type = 'file')
 	{
-		$matches = false;
-		$list = '';
+		$matches = [];
+		$return = [];
 
 		if ($type == 'file') {
 			$cnt = preg_match_all('/\[(.*?)\]/', $file, $matches, PREG_SET_ORDER);
@@ -116,20 +131,48 @@ class FileTag
 		}
 
 		if ($cnt) {
-			foreach ($matches as $mtch) {
-				if (strlen($list)) {
-					$list .= ',';
-				}
-
-				$list .= self::decode($mtch[1]);
+			foreach ($matches as $match) {
+				$return[] = self::decode($match[1]);
 			}
 		}
 
-		return $list;
+		return $return;
 	}
 
 	/**
-	 * @brief Update file tags in PConfig
+	 * Get file tags from list
+	 *
+	 * ex. given music,video return <music><video> or [music][video]
+	 * @param string $list A comma delimited list of tags.
+	 * @param string $type Optional file type.
+	 *
+	 * @return string       A list of file tags.
+	 * @deprecated since 2019.06 use arrayToFile() instead
+	 */
+	public static function listToFile(string $list, string $type = 'file')
+	{
+		$list_array = explode(',', $list);
+
+		return self::arrayToFile($list_array, $type);
+	}
+
+	/**
+	 * Get list from file tags
+	 *
+	 * ex. given <music><video>[friends], return music,video or friends
+	 * @param string $file File tags
+	 * @param string $type Optional file type.
+	 *
+	 * @return string       Comma delimited list of tag names.
+	 * @deprecated since 2019.06 use fileToArray() instead
+	 */
+	public static function fileToList(string $file, $type = 'file')
+	{
+		return implode(',', self::fileToArray($file, $type));
+	}
+
+	/**
+	 * Update file tags in PConfig
 	 *
 	 * @param int    $uid      Unique Identity.
 	 * @param string $file_old Categories previously associated with an item
@@ -139,7 +182,7 @@ class FileTag
 	 * @return boolean          A value indicating success or failure.
 	 * @throws \Exception
 	 */
-	public static function updatePconfig($uid, $file_old, $file_new, $type = 'file')
+	public static function updatePconfig(int $uid, string $file_old, string $file_new, string $type = 'file')
 	{
 		if (!intval($uid)) {
 			return false;
@@ -147,38 +190,34 @@ class FileTag
 			return true;
 		}
 
-		$saved = PConfig::get($uid, 'system', 'filetags');
+		$saved = DI::pConfig()->get($uid, 'system', 'filetags');
 
 		if (strlen($saved)) {
 			if ($type == 'file') {
 				$lbracket = '[';
 				$rbracket = ']';
-				$termtype = TERM_FILE;
+				$termtype = Term::FILE;
 			} else {
 				$lbracket = '<';
 				$rbracket = '>';
-				$termtype = TERM_CATEGORY;
+				$termtype = Term::CATEGORY;
 			}
 
 			$filetags_updated = $saved;
 
 			// check for new tags to be added as filetags in pconfig
 			$new_tags = [];
-			$check_new_tags = explode(",", self::fileToList($file_new, $type));
-
-			foreach ($check_new_tags as $tag) {
+			foreach (self::fileToArray($file_new, $type) as $tag) {
 				if (!stristr($saved, $lbracket . self::encode($tag) . $rbracket)) {
 					$new_tags[] = $tag;
 				}
 			}
 
-			$filetags_updated .= self::listToFile(implode(",", $new_tags), $type);
+			$filetags_updated .= self::arrayToFile($new_tags, $type);
 
 			// check for deleted tags to be removed from filetags in pconfig
 			$deleted_tags = [];
-			$check_deleted_tags = explode(",", self::fileToList($file_old, $type));
-
-			foreach ($check_deleted_tags as $tag) {
+			foreach (self::fileToArray($file_old, $type) as $tag) {
 				if (!stristr($file_new, $lbracket . self::encode($tag) . $rbracket)) {
 					$deleted_tags[] = $tag;
 				}
@@ -199,19 +238,19 @@ class FileTag
 			}
 
 			if ($saved != $filetags_updated) {
-				PConfig::set($uid, 'system', 'filetags', $filetags_updated);
+				DI::pConfig()->set($uid, 'system', 'filetags', $filetags_updated);
 			}
 
 			return true;
 		} elseif (strlen($file_new)) {
-			PConfig::set($uid, 'system', 'filetags', $file_new);
+			DI::pConfig()->set($uid, 'system', 'filetags', $file_new);
 		}
 
 		return true;
 	}
 
 	/**
-	 * @brief Add tag to file
+	 * Add tag to file
 	 *
 	 * @param int    $uid     Unique identity.
 	 * @param int    $item_id Item identity.
@@ -233,20 +272,20 @@ class FileTag
 				Item::update($fields, ['id' => $item_id]);
 			}
 
-			$saved = PConfig::get($uid, 'system', 'filetags');
+			$saved = DI::pConfig()->get($uid, 'system', 'filetags');
 
 			if (!strlen($saved) || !stristr($saved, '[' . self::encode($file) . ']')) {
-				PConfig::set($uid, 'system', 'filetags', $saved . '[' . self::encode($file) . ']');
+				DI::pConfig()->set($uid, 'system', 'filetags', $saved . '[' . self::encode($file) . ']');
 			}
 
-			info(L10n::t('Item filed'));
+			info(DI::l10n()->t('Item filed'));
 		}
 
 		return true;
 	}
 
 	/**
-	 * @brief Remove tag from file
+	 * Remove tag from file
 	 *
 	 * @param int     $uid     Unique identity.
 	 * @param int     $item_id Item identity.
@@ -288,8 +327,8 @@ class FileTag
 		);
 
 		if (!DBA::isResult($r)) {
-			$saved = PConfig::get($uid, 'system', 'filetags');
-			PConfig::set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
+			$saved = DI::pConfig()->get($uid, 'system', 'filetags');
+			DI::pConfig()->set($uid, 'system', 'filetags', str_replace($pattern, '', $saved));
 		}
 
 		return true;