# Class TagObject

The tag class used in tag clouds and search

  AlphaDAO
  TagObject

Package: alpha::model
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

    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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: TagObject.inc 1548 2012-07-29 17:07:07Z alphadevx $
Since: 1.0
Located at model/TagObject.inc

Methods summary
`public` | # `__construct( )` The constructor The constructor #### Since 1.0 #### Overrides `AlphaDAO::__construct()`
`public array` | # `loadTags( mixed $taggedClass, mixed $taggedOID )` Returns an array of TagObjects matching the class and OID provided Returns an array of TagObjects matching the class and OID provided #### Parameters $taggedClass `mixed` $taggedClass The class name of the DAO that has been tagged. $taggedOID `mixed` $taggedOID The Object ID of the DAO that has been tagged. #### Returns `array` #### Throws ``AlphaException`` ``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 `mixed` $limit #### Returns `array` #### Throws ``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 TagObject instances. Splits the passed content by spaces, filters (removes) stop words from stopwords.ini, and returns an array of TagObject instances. #### Parameters $content `mixed` $content $taggedClass `mixed` $taggedClass Optionally provide a BO class name $taggedOID `mixed` $taggedOID Optionally provide a BO instance OID $applyStopwords `mixed` $applyStopwords Defaults true, set to false if you want to ignore the stopwords. #### Returns `array` #### Throws ``AlphaException`` #### Since 1.0
`private static` | # `lowercaseArrayElement( mixed & $element, mixed $key )` Applies trim() and strtolower to the array element passed by reference Applies trim() and strtolower to the array element passed by reference #### Parameters $element `mixed` $element $key `mixed` $key (not required)
`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 `mixed` $content #### Returns `string`

Methods inherited from AlphaDAO
`__wakeup(), addProperty(), addToCache(), begin(), cast(), checkBOTableExists(), checkClassDefExists(), checkRecordExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropTable(), findMissingFields(), get(), getBOClassNames(), getConnection(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getOID(), getPersistentAttributes(), getPropObject(), getTableName(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromPost(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), set(), setDataLabels(), setEnumOptions(), setLastQuery(), setMaintainHistory(), setOID(), 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 `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 `Integer`` | $taggedOID | `` | # The OID of the object which is tagged The OID of the object which is tagged #### Since 1.0
`protected `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
`private static `Logger`` | $logger | `null` | # Trace logger Trace logger #### Since 1.0

Properties inherited from AlphaDAO
`$OID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num`