phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Procedural File: module_tags.php

Source Location: /modules/module_tags.php

Page Details
Functions
deleteTag  [line 562]

void deleteTag( string $tag, integer $entrycode  )

Delete a single tag for any given entry.

Parameters:
string   $tag: 
integer   $entrycode: 


[ Top ]
deleteTags  [line 542]

void deleteTags( mixed $tags, integer $entrycode  )

Deletes all tags for any given entry.

Parameters:
mixed   $tags: 
integer   $entrycode: 


[ Top ]
getEntriesWithTag  [line 801]

unknown getEntriesWithTag( string $tag, [integer $skip = 0]  )

Get Entries/Pages with a certain Tag

Parameters:
string   $tag: 
integer   $skip: 


[ Top ]
getRelatedTags  [line 931]

unknown getRelatedTags( string $tag  )

Get Tags that are related to a certain Tag

Parameters:
string   $tag: 


[ Top ]
getTagCosmos  [line 37]

array getTagCosmos( [integer $max = 0], [string $weblogname = ''], [ $match = ''], [ $exclude = '']  )

Get the TagCosmos. Wrapper for either getTagCosmosFlat or getTagCosmosMysql, Depending on the DB model that's being used.

Returns an array with the following elements: 'minvalue' => minimum value of a tag 'maxvalue' => maximum value of a tag 'amount' => number of tags 'tags' => array of the tags. The indices are the tags, the values the number of occurences

Parameters:
integer   $max: 
string   $weblogname: 
   $match: 
   $exclude: 

API Tags:
See:  getTagCosmosMysql()
See:  getTagCosmosFlat()


[ Top ]
getTagCosmosFlat  [line 94]

array getTagCosmosFlat( [integer $max = 0], string $weblogname, $match, [ $exclude = array()]  )

Get the TagCosmos. Flat file version.

Preferably use the cached version, otherwise just make it on the fly. (and then we store the cached version)

The $weblogname parameter is used to return tags for a single weblog. A value of '_all_' returns the tags for all weblogs combined. If $max is given, it will return at most that many tags, ordered by size.

Returns an array with the following elements: 'minvalue' => minimum value of a tag 'maxvalue' => maximum value of a tag 'amount' => number of tags 'tags' => array of the tags. The indices are the tags, the values the number of occurences

Parameters:
integer   $max: 
string   $weblogname: 
   $match: 
   $exclude: 

API Tags:
See:  getTagCosmos()


[ Top ]
getTagCosmosMysql  [line 196]

array getTagCosmosMysql( [integer $max = 0], [string $weblogname = ''], [ $match = ''], [ $exclude = array()]  )

Get the TagCosmos. MySQL database version.

Preferably use the cached version, otherwise just make it on the fly. (and then we store the cached version)

If $max is given, it will return at most that many tags, ordered by size. If $weblogname is given, only tags for that weblog will be returned.

Returns an array with the following elements: 'minvalue' => minimum value of a tag 'maxvalue' => maximum value of a tag 'amount' => number of tags 'tags' => array of the tags. The indices are the tags, the values the number of occurences

Parameters:
integer   $max: 
string   $weblogname: 
   $match: 
   $exclude: 

API Tags:
See:  getTagCosmos()


[ Top ]
getTags  [line 279]

array getTags( [boolean $link = true], [string $text = ""], [mixed $additional = false], [boolean $underscore = false]  )

Get the tags from the current entry or (for the MySQL database backend only) current page as an array.

If $link is true, the array will consist of links to the individual tag pages.

Parameters:
boolean   $link: 
string   $text: 
mixed   $additional: 
boolean   $underscore: 


[ Top ]
makeRelatedTags  [line 992]

void makeRelatedTags( string $tag, array $p_aAllTags  )

automagically determine related tags.

Parameters:
string   $tag: 
array   $p_aAllTags: 


[ Top ]
normalizeTag  [line 381]

string normalizeTag( string $tag  )

Normalize tag to avoid duplicate noise.

Currently we trim spaces, lowercase, remove quotes and HTML entities, and treat 'star wars', 'star-wars', 'star+wars' and 'star_wars' as similar (with the underscore version as the base case).

Parameters:
string   $tag: 

Information Tags:
Todo:  Since tag is used as filename not all characters should be allowed.

[ Top ]
printTag  [line 667]

string printTag( string $tag  )

Print out the tag page for any given tag. Returns the output as HTML.

Parameters:
string   $tag: 


[ Top ]
printTagCosmos  [line 615]

string printTagCosmos( )

Print out the current Tag Cosmos as a fancy tagcloud in HTML, with smaller and larger tags, dependent on how often they occur. Returns the output as HTML.



[ Top ]
tagLink  [line 754]

string tagLink( string $tag, [string $template = ""]  )

Make a link to any given $tag.

Parameters:
string   $tag: 
string   $template: 


[ Top ]
writeTag  [line 492]

void writeTag( string $tag, integer $entrycode  )

Write out a single tag, checking if it doesn't exist already.

Parameters:
string   $tag: 
integer   $entrycode: 


[ Top ]
writeTagIndex  [line 408]

boolean writeTagIndex( int $start, int $stop, int $time  )

Indexes tags in entries in the PivotX database and returns true if there are more entries to index.

Parameters:
int   $start:  Code for first entry to index
int   $stop:  Code for last entry to index
int   $time:  Indexing time.


[ Top ]
writeTags  [line 448]

void writeTags( $tags, $oldtags, $code, array $entry  )

Write out all tags for any given entry..

Parameters:
array   $entry: 
   $tags: 
   $oldtags: 
   $code: 


[ Top ]


Documentation generated on Tue, 05 Sep 2017 01:06:12 +0200 by phpDocumentor 1.4.3