Class: tagCloud

Source Location: /lib/tagCloud.inc.php

Class tagCloud

Class Overview

Located in /lib/tagCloud.inc.php [line 11]

ipbwi
   |
   --tagCloud

Author(s):

Matthias Reuter ($LastChangedBy: matthias $)

Information Tags:

Version:	$LastChangedDate: 2008-11-02 16:54:59 +0000 (So, 02 Nov 2008) $
Copyright:	2007-2008 IPBWI development team
Link:	http://ipbwi.com/examples/stats.php
Since:	2.0
License:	GNU General Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ipbwi

ipbwi::$DB

ipbwi::$ips

Inherited From ipbwi

ipbwi::addSystemMessage()

adds a system message

ipbwi::date()

Returns textual/timestamp offsetted date by board and by member offset and DST setting.

ipbwi::getBoardVar()

gets the requested board-var

ipbwi::getLibLang()

gets the language-var from actual requested native language-bit

ipbwi::info()

informations about the current IPBWI and PHP installation

ipbwi::makeSafe()

filtering html-strings, e.g. for db-queries

ipbwi::printSystemMessages()

prints system messages

ipbwi::properXHTML()

filtering HTML strings

ipbwi::setLang()

Set's current SDK language

ipbwi::updateSession()

Update Member Session Informations

Inherited From ipbwi

ipbwi::DEV_TEAM

ipbwi::PROJECT_LEADER

ipbwi::TITLE

ipbwi::VERSION

ipbwi::WEBSITE

[ Top ]

Method Summary

bool	addTag()	adds a tag for a topic to tagcloud
bool	deleteTag()	deletes a tag from tagcloud
array	getCategoryList()	gets array with all categories
string	getTagData()	gets all data from a tag
array	getTagList()	gets array with all tags of a topic.
string	view()	Creates a tag cloud

[ Top ]

Properties

Methods

addTag [line 174]

bool addTag(
string
$tag, string
$destination, [int
$topicID = false], [string
$title = false], [string
$category = 'default'] 
)

adds a tag for a topic to tagcloud

Parameters:

string	$tag:	Name of the Tag
string	$destination:	Define a destination. This could be a full qualified URL, a relative path or filename or just again the topic id.
int	$topicID:	ID of the specific topic
string	$title:	Define a title. This could be an alternative of retrieving title informations through the topic id
string	$category:	Define a category to make handling with tags more efficient

API Tags:

Return:	true on success, otherwise false
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->tagCloud->addTag(55,'New tag','http://ipbwi.com/'); $ipbwi->tagCloud->addTag(66,'Another new tag','example.php','examples');

[ Top ]

deleteTag [line 207]

bool deleteTag(
int
$tagID 
)

deletes a tag from tagcloud

Parameters:

int

$tagID:

ID of the tag which should be deleted

API Tags:

Return:	true on success, otherwise false
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->tagCloud->deleteTag(55);

[ Top ]

getCategoryList [line 147]

array getCategoryList(
)

gets array with all categories

API Tags:

Return:	array with all categories
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.01
Sample:	$ipbwi->tagCloud->getCategoryList();

[ Top ]

getTagData [line 103]

string getTagData(
string
$tag 
)

gets all data from a tag

Parameters:

string

$tag:

Name of the tag

API Tags:

Return:	Tag Cloud HTML
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->tagCloud->getTagData('Tools');

[ Top ]

getTagList [line 126]

array getTagList(
int
$topicID 
)

gets array with all tags of a topic.

Parameters:

int

$topicID:

Get Tags of a specific topic

API Tags:

Return:	array with all tags
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->tagCloud->getTagList(); $ipbwi->tagCloud->getTagList(55);

[ Top ]

view [line 51]

string view(
[string
$category = false], [string
$link = '?tag=%key%'] 
)

Creates a tag cloud

Parameters:

string	$category:	Set a Category Name, if you want to get a tagcloud from one category only.
string	$link:	define a custom link to the tags and insert %key% as var which will be replaced, default: ?tag=%key%

API Tags:

Return:	Tag Cloud HTML
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->tagCloud->view(); $ipbwi->tagCloud->view('Category Name'); $ipbwi->tagCloud->view('Category Name','/ipbwi_tagcloud_%key');

[ Top ]

Documentation generated on Mon, 02 Mar 2009 23:51:14 +0100 by phpDocumentor 1.4.0

	tagCloud

[ class tree: tagCloud ] [ index: tagCloud ] [ all elements ]