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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 <?php
namespace Alpha\Model;
use Alpha\Model\Type\SmallText;
use Alpha\Model\Type\Integer;
use Alpha\Exception\AlphaException;
use Alpha\Exception\IllegalArguementException;
use Alpha\Exception\CustomQueryException;
use Alpha\Exception\RecordNotFoundException;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Service\ServiceFactory;
use Alpha\Util\Helper\Validator;
use Alpha\Util\Logging\Logger;
use Exception;
/**
* The tag class used in tag clouds and search.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class Tag extends ActiveRecord
{
/**
* The name of the class of the object which is tagged.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.0
*/
protected $taggedClass;
/**
* The ID of the object which is tagged.
*
* @var \Alpha\Model\Type\Integer
*
* @since 1.0
*/
protected $taggedID;
/**
* The content of the tag.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.0
*/
protected $content;
/**
* An array of data display labels for the class properties.
*
* @var array
*
* @since 1.0
*/
protected $dataLabels = array('ID' => 'Tag ID#', 'taggedClass' => 'Class Name', 'taggedID' => 'Tagged Object ID#', 'content' => 'Tag');
/**
* The name of the database table for the class.
*
* @var string
*
* @since 1.0
*/
const TABLE_NAME = 'Tag';
/**
* Trace logger.
*
* @var \Alpha\Util\Logging\Logger
*
* @since 1.0
*/
private static $logger = null;
/**
* The constructor.
*
* @since 1.0
*/
public function __construct()
{
self::$logger = new Logger('Tag');
// ensure to call the parent constructor
parent::__construct();
$this->taggedClass = new SmallText();
$this->taggedID = new Integer();
$this->content = new SmallText();
$this->markUnique('taggedClass', 'taggedID', 'content');
}
/**
* Returns an array of Tags matching the class and ID provided.
*
* @param $taggedClass The class name of the DAO that has been tagged (with namespace).
* @param $taggedID The Object ID of the DAO that has been tagged.
*
* @return array
*
* @since 1.0
*
* @throws \Alpha\Exception\AlphaException
* @throws \Alpha\Exception\IllegalArguementException
*/
public function loadTags($taggedClass, $taggedID)
{
$config = ConfigProvider::getInstance();
if ($taggedClass == '' || $taggedID == '') {
throw new IllegalArguementException('The taggedClass or taggedID provided are empty');
}
$provider = ServiceFactory::getInstance($config->get('db.provider.name'), 'Alpha\Model\ActiveRecordProviderInterface');
$provider->setRecord($this);
try {
$tags = $provider->loadAllByAttributes(array('taggedID', 'taggedClass'), array($taggedID, $taggedClass));
return $tags;
} catch (RecordNotFoundException $bonf) {
return array();
} catch (Exception $e) {
self::$logger->error($e->getMessage());
throw new AlphaException($e->getMessage());
}
}
/**
* Returns a hash array of the most popular tags based on their occurence in the database,
* ordered by alphabet and restricted to the a count matching the $limit supplied. The
* returned has array uses the tag content as a key and the database value as a value.
*
* @param $limit
*
* @return array
*
* @since 1.0
*
* @throws \Alpha\Exception\AlphaException
*/
public static function getPopularTagsArray($limit)
{
$config = ConfigProvider::getInstance();
$provider = ServiceFactory::getInstance($config->get('db.provider.name'), 'Alpha\Model\ActiveRecordProviderInterface');
$provider->setRecord(new self());
$sqlQuery = 'SELECT content, count(*) as count FROM '.self::TABLE_NAME." GROUP BY content ORDER BY count DESC LIMIT $limit";
try {
$result = $provider->query($sqlQuery);
} catch (CustomQueryException $e) {
throw new AlphaException('Failed to query the tags table, error is ['.$e->getMessage().']');
}
// now build an array of tags to be returned
$popTags = array();
foreach ($result as $row) {
$popTags[$row['content']] = $row['count'];
}
// sort the array by content key before returning
ksort($popTags);
return $popTags;
}
/**
* Splits the passed content by spaces, filters (removes) stop words from stopwords.ini,
* and returns an array of Tag instances.
*
* @param $content
* @param $taggedClass Optionally provide a Record class name (with namespace)
* @param $taggedID Optionally provide a Record instance ID
* @param $applyStopwords Defaults true, set to false if you want to ignore the stopwords.
*
* @return array
*
* @throws \Alpha\Exception\AlphaException
*
* @since 1.0
*/
public static function tokenize($content, $taggedClass = '', $taggedID = '', $applyStopwords = true)
{
if (self::$logger == null) {
self::$logger = new Logger('Tag');
}
$config = ConfigProvider::getInstance();
// apply stop words
$lowerWords = preg_split("/[\s,.:-]+/", $content);
array_walk($lowerWords, 'Alpha\Model\Tag::lowercaseArrayElement');
if ($applyStopwords) {
if (file_exists($config->get('app.root').'config/stopwords-'.$config->get('search.stop.words.size').'.ini')) {
$stopwords = file($config->get('app.root').'config/stopwords-'.$config->get('search.stop.words.size').'.ini', FILE_IGNORE_NEW_LINES);
} elseif (file_exists($config->get('app.root').'Alpha/stopwords-'.$config->get('search.stop.words.size').'.ini')) {
$stopwords = file($config->get('app.root').'Alpha/stopwords-'.$config->get('search.stop.words.size').'.ini', FILE_IGNORE_NEW_LINES);
} else {
throw new AlphaException('Unable to find a stopwords-'.$config->get('search.stop.words.size').'.ini file in the application!');
}
array_walk($stopwords, 'Alpha\Model\Tag::lowercaseArrayElement');
$filtered = array_diff($lowerWords, $stopwords);
} else {
$filtered = $lowerWords;
}
$tagObjects = array();
$tagContents = array();
foreach ($filtered as $tagContent) {
// we only want to create word tags
if (Validator::isAlpha($tagContent)) {
// just making sure that we haven't added this one in already
if (!in_array($tagContent, $tagContents) && !empty($tagContent)) {
$tag = new self();
$tag->set('content', trim(mb_strtolower($tagContent)));
if (!empty($taggedClass)) {
$tag->set('taggedClass', $taggedClass);
}
if (!empty($taggedID)) {
$tag->set('taggedID', $taggedID);
}
array_push($tagObjects, $tag);
array_push($tagContents, $tagContent);
}
}
}
self::$logger->debug('Tags generated: ['.var_export($tagContents, true).']');
return $tagObjects;
}
/**
* Applies trim() and strtolower to the array element passed by reference.
*
* @param $element
* @param $key (not required)
*/
private static function lowercaseArrayElement(&$element, $key)
{
$element = trim(mb_strtolower($element));
}
/**
* Cleans tag content by removing white spaces and converting to lowercase.
*
* @param $content
*
* @return string
*/
public static function cleanTagContent($content)
{
return trim(mb_strtolower(str_replace(' ', '', $content)));
}
/**
* Remove the tag search matches from the cache.
*
* @since 1.2.4
*/
protected function after_save_callback()
{
$config = ConfigProvider::getInstance();
if ($config->get('cache.provider.name') != '') {
try {
$cache = ServiceFactory::getInstance($config->get('cache.provider.name'), 'Alpha\Util\Cache\CacheProviderInterface');
$cache->delete($this->get('content'));
} catch (\Exception $e) {
self::$logger->error('Error while attempting to remove search matches array from the ['.$config->get('cache.provider.name').']
instance: ['.$e->getMessage().']');
}
}
}
/**
* Remove the tag search matches from the cache.
*
* @since 1.2.4
*/
protected function before_delete_callback()
{
$this->{'after_save_callback'}();
}
}