tags
[ class tree: tags ] [ index: tags ] [ all elements ]
Packages:
articles
blogs
boards
calendar
events
fisheye
install
kernel
languages
liberty
newsletters
protector
recess-http
search
sharethis
Smarty
stars
tags
themes
treasury
users
wiki


Tutorials/Manuals:
Package-level: Files:
LibertyTag.php

subpackage functions
drop_tags.php
edit.php
list.php

subpackage modules
mod_tags_cloud.php

Classes:
LibertyTag

Class: LibertyTag

Source Location: /tags/LibertyTag.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertyTag

Variables

Methods

Inherited Constants

Class: BitBase

BitBase::CACHE_STATE_ADDED
BitBase::CACHE_STATE_DELETE
BitBase::CACHE_STATE_NONE
BitBase::CACHE_STATE_STORED

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mPreventCache
BitBase::$mSuccess

Inherited Methods

Class: LibertyBase

LibertyBase::__construct()
Constructor building on BitBase object
LibertyBase::getLibertyClass()
given a content_type_guid this will return an object of the proper type
LibertyBase::getLibertyObject()
Given a content_id, this will return and object of the proper type
LibertyBase::getNewObject()
Simple method to create a given class with a specified content_id. The purpose of a method is to allow for derived classes to override as necessary.
LibertyBase::getNewObjectById()
Simple method to create a given class with a specified primary_id. The purpose of a method is to allow for derived classes to override as necessary.

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge()
Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 19]


[ Top ]

Class Variables

$mContentId =

[line 20]


Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 22]

LibertyTag __construct( [ $pContentId = NULL])



Overrides LibertyBase::__construct() (Constructor building on BitBase object)

Parameters:

   $pContentId  

[ Top ]

method array_distinct [line 593]

void array_distinct( $array $array, $group_keys $group_keys, [$sum_keys $sum_keys = NULL], [$count_key $count_key = NULL])

Used by getContentList to strip out duplicate records in a list Lifted from http://us3.php.net/manual/en/function.array-unique.php#57006



Parameters:

$array   $array   - nothing to say
$group_keys   $group_keys   - columns which have to be grouped - can be STRING or ARRAY (STRING, STRING[, ...])
$sum_keys   $sum_keys   - columns which have to be summed - can be STRING or ARRAY (STRING, STRING[, ...])
$count_key   $count_key   - must be STRING - count the grouped keys

[ Top ]

method assignContentList [line 549]

void assignContentList( &$pParamHash)

This function gets all content by matching to any tag passed in a group of tags, eliminates dupe records



Parameters:

   &$pParamHash  

[ Top ]

method expunge [line 318]

void expunge( $tag_id)

This function removes a tag entry



Overrides BitBase::expunge() (Delete content object and all related records)

Parameters:

   $tag_id  

[ Top ]

method expungeContentFromTagMap [line 339]

void expungeContentFromTagMap( )

This function removes all references to contentid from tags_content_map



[ Top ]

method expungeMyContentFromTagMap [line 353]

void expungeMyContentFromTagMap( &$pObject)

This function removes all references to contentid from tags_content_map



Parameters:

   &$pObject  

[ Top ]

method expungeTags [line 374]

void expungeTags( $pContentId, $pTagIdArray)

The function removes one or more tag from a piece of content



Parameters:

   $pContentId  
   $pTagIdArray  

[ Top ]

method getDisplayUriWithTag [line 390]

void getDisplayUriWithTag( $tag)



Parameters:

   $tag  

[ Top ]

method getDisplayUrlWithTag [line 394]

void getDisplayUrlWithTag( $tag)



Parameters:

   $tag  

[ Top ]

method getList [line 408]

void getList( &$pParamHash)

This function gets a list of tags



Parameters:

   &$pParamHash  

[ Top ]

method getPopCount [line 537]

void getPopCount( $tag_id)

This function gets the number of times a tag is used aka Popularity Count



Parameters:

   $tag_id  

[ Top ]

method isValid [line 311]

void isValid( )

check if the mContentId is set and valid



[ Top ]

method load [line 49]

void load( pParamHash 0)

Load all the tags for a given ContentId



Overrides BitBase::load() (parent method not documented)

Parameters:

pParamHash   0   be sure to pass by reference in case we need to make modifcations to the hash

[ Top ]

method loadTag [line 73]

void loadTag( &$pParamHash)



Parameters:

   &$pParamHash  

[ Top ]

method sanitizeTag [line 220]

void sanitizeTag( $pTag)



Parameters:

   $pTag  

[ Top ]

method store [line 174]

bool store( array &$pParamHash)



Tags:

return:  TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
access:  public


Parameters:

array   &$pParamHash   pParams hash of values that will be used to store the page

[ Top ]

method storeOneTag [line 200]

void storeOneTag( &$pParamHash)



Parameters:

   &$pParamHash  

[ Top ]

method storeTags [line 294]

bool storeTags( array &$pParamHash)



Tags:

return:  TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why
access:  public


Parameters:

array   &$pParamHash   pParams hash includes mix of tags that will be storeded and associated with a ContentId used by service

[ Top ]

method verifyTag [line 138]

void verifyTag( &$pParamHash)



Parameters:

   &$pParamHash  

[ Top ]

method verifyTagsMap [line 246]

void verifyTagsMap( &$pParamHash)



Parameters:

   &$pParamHash  

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:57:00 +0000 by phpDocumentor 1.5.0-lsces