Class Tag

The tag class used in tag clouds and search.

Alpha\Model\Tag

Namespace: Alpha\Model
Copyright: Copyright (c) 2015, 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>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Model/Tag.php

Methods summary
`public`	# `__construct( )` The constructor. The constructor. Since 1.0 Overrides `Alpha\Model\ActiveRecord::__construct()`
`public array`	# `loadTags( mixed $taggedClass, mixed $taggedOID )` Returns an array of Tags matching the class and OID provided. Returns an array of Tags matching the class and OID provided. Parameters `$taggedClass` $taggedClass The class name of the DAO that has been tagged (with namespace). `$taggedOID` $taggedOID The Object ID of the DAO that has been tagged. Returns `array` array Throws `Alpha\Exception\AlphaException` Alpha\Exception\AlphaException `Alpha\Exception\IllegalArguementException` Alpha\Exception\IllegalArguementException Since 1.0
`public static array`	# `getPopularTagsArray( mixed $limit )` 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. 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. Parameters `$limit` $limit Returns `array` array Throws `Alpha\Exception\AlphaException` Alpha\Exception\AlphaException Since 1.0
`public static array`	# `tokenize( mixed $content, mixed $taggedClass = '', mixed $taggedOID = '', mixed $applyStopwords = true )` Splits the passed content by spaces, filters (removes) stop words from stopwords.ini, and returns an array of Tag instances. Splits the passed content by spaces, filters (removes) stop words from stopwords.ini, and returns an array of Tag instances. Parameters `$content` $content `$taggedClass` $taggedClass Optionally provide a BO class name (with namespace) `$taggedOID` $taggedOID Optionally provide a BO instance OID `$applyStopwords` $applyStopwords Defaults true, set to false if you want to ignore the stopwords. Returns `array` array Throws `Alpha\Exception\AlphaException` Alpha\Exception\AlphaException Since 1.0
`public static string`	# `cleanTagContent( mixed $content )` Cleans tag content by removing white spaces and converting to lowercase. Cleans tag content by removing white spaces and converting to lowercase. Parameters `$content` $content Returns `string` string
`protected`	# `after_save_callback( )` Remove the tag search matches from the cache. Remove the tag search matches from the cache. Since 1.2.4
`protected`	# `before_delete_callback( )` Remove the tag search matches from the cache. Remove the tag search matches from the cache. Since 1.2.4

Methods inherited from Alpha\Model\ActiveRecord
__wakeup(), addProperty(), addToCache(), begin(), cast(), checkBOTableExists(), checkDatabaseExists(), checkRecordExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createDatabase(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropDatabase(), dropTable(), findMissingFields(), get(), getBOClassNames(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getOID(), getPersistentAttributes(), getPropObject(), getTableName(), getTaggedAttributes(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadAllOldVersions(), loadByAttribute(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromArray(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), set(), setDataLabels(), setEnumOptions(), setLastQuery(), setMaintainHistory(), setOID(), toArray(), validate()

Constants summary
`string`	`TABLE_NAME`	`'Tag'`	# The name of the database table for the class. The name of the database table for the class. Since 1.0

Properties summary
`protected Alpha\Model\Type\String`	`$taggedClass`		# The name of the class of the object which is tagged. The name of the class of the object which is tagged. Since 1.0
`protected Alpha\Model\Type\Integer`	`$taggedOID`		# The OID of the object which is tagged. The OID of the object which is tagged. Since 1.0
`protected Alpha\Model\Type\String`	`$content`		# The content of the tag. The content of the tag. Since 1.0
`protected array`	`$dataLabels`	`array('OID' => 'Tag ID#', 'taggedClass' => 'Class Name', 'taggedOID' => 'Tagged Object ID#', 'content' => 'Tag')`	# An array of data display labels for the class properties. An array of data display labels for the class properties. Since 1.0

Properties inherited from Alpha\Model\ActiveRecord
`$OID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num`

Namespaces

Classes

Interfaces

Class Tag

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Since

Since

Since

Since

Since

Since