tagCloud
[ class tree: tagCloud ] [ index: tagCloud ] [ all elements ]
Packages:
IPBWI
antispam
attachment
bbcode
blog
forum
gallery
group
Languages
liveExample
member
mimetypes
permissions
pm
poll
post
search
skin
stats
tagCloud
topic


Files:
tagCloud.inc.php

Classes:
ipbwi_tagCloud

Class: ipbwi_tagCloud

Source Location: /ipbwi/lib/tagCloud.inc.php

Class Overview

ipbwi
   |
   --ipbwi_tagCloud



Author(s):

  • Matthias Reuter ($LastChangedBy: matthias $)

Version:

  • $LastChangedDate: 2008-11-02 16:54:59 +0000 (So, 02 Nov 2008) $

Copyright:

  • 2007-2010 IPBWI development team

Methods

Inherited Constants

Class: ipbwi

ipbwi::DEV_TEAM
ipbwi::DOCS
ipbwi::PROJECT_LEADER
ipbwi::TITLE
ipbwi::VERSION
ipbwi::WEBSITE

Inherited Variables

Class: ipbwi

ipbwi::$board
ipbwi::$common
ipbwi::$DBlog
ipbwi::$ips

Inherited Methods

Class: 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::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::sysInfo()
informations about the current IPBWI and PHP installation
ipbwi::__destruct()

Class Details

[line 11]


Tags:

author:  Matthias Reuter ($LastChangedBy: matthias $)
version:  $LastChangedDate: 2008-11-02 16:54:59 +0000 (So, 02 Nov 2008) $
copyright:  2007-2010 IPBWI development team
link:  http://ipbwi.com/examples/stats.php
since:  2.0
license:  GNU General Public License


[ Top ]

Class Methods

method 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



Tags:

return:  true on success, otherwise false
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->tagCloud->addTag(55,'New tag','http://ipbwi.com/');
  2.  $ipbwi->tagCloud->addTag(66,'Another new tag','example.php','examples');
access:  public


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

[ Top ]

method deleteTag [line 207]

bool deleteTag( int $tagID)

deletes a tag from tagcloud



Tags:

return:  true on success, otherwise false
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->tagCloud->deleteTag(55);
access:  public


Parameters:

int   $tagID   ID of the tag which should be deleted

[ Top ]

method getCategoryList [line 147]

array getCategoryList( )

gets array with all categories



Tags:

return:  array with all categories
author:  Matthias Reuter
since:  2.01
sample:  
  1.  $ipbwi->tagCloud->getCategoryList();
access:  public


[ Top ]

method getTagData [line 103]

string getTagData( string $tag)

gets all data from a tag



Tags:

return:  Tag Cloud HTML
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->tagCloud->getTagData('Tools');
access:  public


Parameters:

string   $tag   Name of the tag

[ Top ]

method getTagList [line 126]

array getTagList( int $topicID)

gets array with all tags of a topic.



Tags:

return:  array with all tags
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->tagCloud->getTagList();
  2.  $ipbwi->tagCloud->getTagList(55);
access:  public


Parameters:

int   $topicID   Get Tags of a specific topic

[ Top ]

method view [line 51]

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

Creates a tag cloud



Tags:

return:  Tag Cloud HTML
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->tagCloud->view();
  2.  $ipbwi->tagCloud->view('Category Name');
  3.  $ipbwi->tagCloud->view('Category Name','/ipbwi_tagcloud_%key');
access:  public


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%

[ Top ]

Documentation generated on Sat, 23 Oct 2010 23:36:13 +0200 by phpDocumentor 1.4.3