articles
[ class tree: articles ] [ index: articles ] [ 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:
BitArticle.php
BitArticleTopic.php
BitArticleType.php

subpackage functions
articles_rss.php
article_filter_inc.php
display_article_inc.php
edit.php
edit_topic.php
list.php
list_topics.php
lookup_article_inc.php
lookup_article_topic_inc.php
print.php
rankings.php
read.php

subpackage modules
mod_articles.php

Classes:
BitArticle
BitArticleTopic
BitArticleType

Class: BitArticleTopic

Source Location: /articles/BitArticleTopic.php

Class Overview

BitBase
   |
   --BitArticleTopic

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: 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 21]


[ Top ]

Class Variables

$mTopicId =

[line 23]



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

static method getTopicList [line 192]

static void getTopicList( [ $pOptionHash = NULL])



Tags:

access:  public


Parameters:

   $pOptionHash  

[ Top ]

constructor __construct [line 25]

BitArticleTopic __construct( [ $iTopicId = NULL], [ $iTopicName = NULL])



Tags:

access:  public


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

Parameters:

   $iTopicId  
   $iTopicName  

[ Top ]

method activateTopic [line 238]

void activateTopic( )



Tags:

access:  public


[ Top ]

method deactivateTopic [line 243]

void deactivateTopic( )



Tags:

access:  public


[ Top ]

method getArticleImageStorageName [line 410]

TRUE getArticleImageStorageName( [array $pArticleId = NULL])

Get the name of the article image file



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

array   $pArticleId   article id

[ Top ]

method getArticleImageStoragePath [line 430]

path getArticleImageStoragePath( [$pArticleId $pArticleId = NULL], [$pBasePathOnly $pBasePathOnly = FALSE])

Work out the path to the image for this article



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

$pArticleId   $pArticleId   id of the article we need the image path for
$pBasePathOnly   $pBasePathOnly   bool TRUE / FALSE - specify whether you want full path or just base path

[ Top ]

method getArticleImageStorageUrl [line 463]

URL getArticleImageStorageUrl( [$pArticleId $pArticleId = NULL], [$pBasePathOnly $pBasePathOnly = FALSE], [ $pForceRefresh = FALSE])

Work out the URL to the image for this article



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

$pArticleId   $pArticleId   id of the article we need the image path for
$pBasePathOnly   $pBasePathOnly   bool TRUE / FALSE - specify whether you want full path or just base path
   $pForceRefresh  

[ Top ]

method getTopicArticles [line 255]

void getTopicArticles( )



Tags:

access:  public


[ Top ]

method getTopicImageBaseUrl [line 155]

path getTopicImageBaseUrl( [$pTopicId $pTopicId = NULL], $pBasePathOnly 1)

Work out the path to the image for this article



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

$pBasePathOnly   1   bool TRUE / FALSE - specify whether you want full path or just base path
$pTopicId   $pTopicId   id of the article we need the image path for

[ Top ]

method getTopicImageStorageName [line 310]

TRUE getTopicImageStorageName( [array $pTopicId = NULL])

Get the name of the article image file



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

array   $pTopicId   article id

[ Top ]

method getTopicImageStoragePath [line 331]

path getTopicImageStoragePath( [$pTopicId $pTopicId = NULL], [$pBasePathOnly $pBasePathOnly = FALSE])

Work out the path to the image for this article



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

$pTopicId   $pTopicId   id of the article we need the image path for
$pBasePathOnly   $pBasePathOnly   bool TRUE / FALSE - specify whether you want full path or just base path

[ Top ]

method getTopicImageStorageUrl [line 361]

URL getTopicImageStorageUrl( [$pTopicId $pTopicId = NULL], [$pBasePathOnly $pBasePathOnly = FALSE], [ $pForceRefresh = FALSE])

Work out the URL to the image for this article



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

$pTopicId   $pTopicId   id of the article we need the image path for
$pBasePathOnly   $pBasePathOnly   bool TRUE / FALSE - specify whether you want full path or just base path
   $pForceRefresh  

[ Top ]

method getTopicImageThumbUrl [line 175]

Path getTopicImageThumbUrl( [numeric $pTopicId = NULL])

Get the full URL to the needed thumbnail



Tags:

return:  to thumbnail, FALSE on failure
access:  public


Parameters:

numeric   $pTopicId   Topic ID of topic in question

[ Top ]

method isValid [line 34]

void isValid( )



Tags:

access:  public


[ Top ]

method loadTopic [line 39]

void loadTopic( [ $iParamHash = NULL])



Tags:

access:  public


Parameters:

   $iParamHash  

[ Top ]

method removeTopic [line 272]

void removeTopic( [ $iRemoveArticles = FALSE])



Tags:

access:  public


Parameters:

   $iRemoveArticles  

[ Top ]

method removeTopicImage [line 226]

void removeTopicImage( )



Tags:

access:  public


[ Top ]

method setActivation [line 248]

void setActivation( [ $iIsActive = FALSE])



Tags:

access:  public


Parameters:

   $iIsActive  

[ Top ]

method storeTopic [line 112]

void storeTopic( [ $iParamHash = NULL])



Tags:

access:  public


Parameters:

   $iParamHash  

[ Top ]

method verify [line 67]

void verify( &$iParamHash)



Tags:

access:  public


Parameters:

   &$iParamHash  

[ Top ]

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