Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • ActionLog
  • ActiveRecord
  • ActiveRecordProviderMySQL
  • ActiveRecordProviderSQLite
  • Article
  • ArticleComment
  • ArticleVote
  • BadRequest
  • BlacklistedClient
  • BlacklistedIP
  • Person
  • Rights
  • Tag

Interfaces

  • ActiveRecordProviderInterface

Class Tag

The tag class used in tag clouds and search.

Alpha\Model\ActiveRecord
Extended by Alpha\Model\Tag
Namespace: Alpha\Model
Copyright:

Copyright (c) 2018, 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
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( $taggedClass, $taggedID )

Returns an array of Tags matching the class and ID provided.

Returns an array of Tags matching the class and ID provided.

Parameters

$taggedClass
class name of the DAO that has been tagged (with namespace).
$taggedID
Object ID of the DAO that has been tagged.

Returns

array

Throws

Alpha\Exception\AlphaException
Alpha\Exception\IllegalArguementException

Since

1.0
public static array
# getPopularTagsArray( $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

Returns

array

Throws

Alpha\Exception\AlphaException

Since

1.0
public static array
# tokenize( $content, $taggedClass = '', $taggedID = '', $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
$taggedClass
provide a Record class name (with namespace)
$taggedID
provide a Record instance ID
$applyStopwords
true, set to false if you want to ignore the stopwords.

Returns

array

Throws

Alpha\Exception\AlphaException

Since

1.0
public static string
# cleanTagContent( $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

Returns

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(), backupDatabase(), begin(), cast(), checkDatabaseExists(), checkRecordExists(), checkRecordTableExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createDatabase(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropDatabase(), dropTable(), findMissingFields(), get(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getPersistentAttributes(), getPropObject(), getRecordClassNames(), getTableName(), getTaggedAttributes(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadAllOldVersions(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromArray(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), saveRelations(), set(), setDataLabels(), setEnumOptions(), setID(), setLastQuery(), setMaintainHistory(), toArray(), validate()

Constants summary

string TABLE_NAME

The name of the database table for the class.

The name of the database table for the class.

Since

1.0
# 'Tag'

Properties summary

protected Alpha\Model\Type\SmallText $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 $taggedID

The ID of the object which is tagged.

The ID of the object which is tagged.

Since

1.0
#
protected Alpha\Model\Type\SmallText $content

The content of the tag.

The content of the tag.

Since

1.0
#
protected array $dataLabels

An array of data display labels for the class properties.

An array of data display labels for the class properties.

Since

1.0
# array('ID' => 'Tag ID#', 'taggedClass' => 'Class Name', 'taggedID' => 'Tagged Object ID#', 'content' => 'Tag')

Properties inherited from Alpha\Model\ActiveRecord

$ID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num

Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen