1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 <?php
/**
* TfishTaglinkHandler class file.
*
* @copyright Simon Wilkinson 2013-2017 (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package content
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Handler class for taglink objects.
*
* @copyright Simon Wilkinson 2013-2017 (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package content
*/
class TfishTaglinkHandler extends TfishContentHandler
{
/**
* Delete taglinks associated with a particular content object.
*
* @param object $obj A TfishContentObject subclass object.
* @return bool True for success, false on failure.
*/
public static function deleteTaglinks(TfishContentObject $obj)
{
if (TfishFilter::isInt($obj->id, 1)) {
$clean_content_id = (int) $obj->id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
$criteria = new TfishCriteria();
if ($obj->type === 'TfishTag') {
$criteria->add(new TfishCriteriaItem('tag_id', $clean_content_id));
} else {
$criteria->add(new TfishCriteriaItem('content_id', $clean_content_id));
}
$result = TfishDatabase::deleteAll('taglink', $criteria);
if (!$result) {
return false;
}
return true;
}
/**
* Insert taglinks to the taglink table.
*
* Taglinks represent relationships between tags and content objects.
*
* @param int $content_id ID of content object.
* @param string $type Type of content object as whitelisted in TfishTaglinkHandler::getType().
* @param array $tags IDs of tags as integers.
* @return bool True on success false on failure.
*/
public static function insertTaglinks(int $content_id, string $type, array $tags)
{
if (TfishFilter::isInt($content_id, 1)) {
$clean_content_id = (int) $content_id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
exit;
}
$typeList = self::getTypes();
if (TfishFilter::isAlpha($type) && array_key_exists($type, $typeList)) {
$clean_type = TfishFilter::trimString($type);
} else {
trigger_error(TFISH_ERROR_NOT_ALPHA, E_USER_ERROR);
exit;
}
$clean_tags = array();
foreach ($tags as $tag_id) {
$tag = array();
if (TfishFilter::isInt($tag_id, 1)) {
$tag['tag_id'] = (int) $tag_id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
$tag['content_id'] = $clean_content_id;
$tag['content_type'] = $clean_type;
$clean_tags[] = $tag;
unset($tag);
}
foreach ($clean_tags as $clean_tag) {
$result = TfishDatabase::insert('taglink', $clean_tag);
if (!$result) {
return false;
}
}
return true;
}
/**
* Updates taglinks for a particular content object.
*
* Old taglinks are deleted, newly designated set of taglinks are inserted. Objects that have
* had their type converted to TfishTag lose all taglinks (tags are not allowed to reference
* tags).
*
* @param int $id ID of target content object.
* @param string $type Type of content object as whitelisted in TfishTaglinkHandler::getType().
* @param array $tags IDs of tags as integers.
* @return bool True on success false on failure.
*/
public static function updateTaglinks(int $id, string $type, array $tags = null)
{
// Validate ID.
if (TfishFilter::isInt($id, 1)) {
$clean_id = (int) $id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
// Validate type.
$typeList = self::getTypes();
if (TfishFilter::isAlpha($type) && array_key_exists($type, $typeList)) {
$clean_type = TfishFilter::trimString($type);
} else {
trigger_error(TFISH_ERROR_NOT_ALPHA, E_USER_ERROR);
exit;
}
// Validate tags.
$clean_tag_id = array();
if (TfishFilter::isArray($tags)) {
foreach ($tags as $tag) {
if (TfishFilter::isInt($tag, 1)) {
$clean_tag_id[] = (int) $tag;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
unset($tag);
}
}
// Delete any existing tags.
$criteria = new TfishCriteria();
$criteria->add(new TfishCriteriaItem('content_id', $clean_id));
$result = TfishDatabase::deleteAll('taglink', $criteria);
if (!$result) {
return false;
}
unset($result);
// If the content object is a tag, it is not allowed to have taglinks, so there is no need
// to proceed to insert new ones.
if ($type === 'TfishTag') {
return true;
}
// Insert new taglinks, if any.
$clean_tags = array();
foreach ($clean_tag_id as $tag_id) {
$tag = array();
if (TfishFilter::isInt($tag_id, 1)) {
$tag['tag_id'] = (int) $tag_id;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
$tag['content_id'] = $clean_id;
$tag['content_type'] = $type;
$clean_tags[] = $tag;
unset($tag);
}
// Insert the new taglinks.
foreach ($clean_tags as $clean_tag) {
$result = TfishDatabase::insert('taglink', $clean_tag);
if (!$result) {
return false;
}
}
return true;
}
}