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

Class: BitArticleTopic

Source Location: d:\website\PhpDocumentor\/articles/BitArticleTopic.php

Class Overview

BitBase
   |
   --BitArticleTopic



Variables

Methods


Inherited Variables

Inherited Methods

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::debug()
Switch debug level in database
BitBase::display()
This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb()
Return pointer to current Database
BitBase::getField()
Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid()
Determines if there is a valide database connection
BitBase::prepGetList()
Prepares parameters with default values for any getList function
BitBase::setDatabase()
Sets database mechanism for the instance
BitBase::verifyId()
Determines if any given variable exists and is a number

Class Details

[line 19]


[ Top ]


Class Variables

$mTopicId =

[line 20]


Type:   mixed


[ Top ]



Class Methods


constructor BitArticleTopic [line 22]

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



Parameters:

   $iTopicId  
   $iTopicName  

[ Top ]

method activateTopic [line 265]

void activateTopic( )



[ Top ]

method deactivateTopic [line 269]

void deactivateTopic( )



[ Top ]

method getTopicArticles [line 279]

void getTopicArticles( )



[ Top ]

method getTopicImageStorageName [line 152]

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 171]

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 200]

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 getTopicList [line 221]

void getTopicList( [ $pOptionHash = NULL])



Parameters:

   $pOptionHash  

[ Top ]

method isValid [line 30]

void isValid( )



[ Top ]

method loadTopic [line 34]

void loadTopic( [ $iParamHash = NULL])



Parameters:

   $iParamHash  

[ Top ]

method removeTopic [line 295]

void removeTopic( [ $iRemoveArticles = FALSE])



Parameters:

   $iRemoveArticles  

[ Top ]

method removeTopicImage [line 254]

void removeTopicImage( )



[ Top ]

method setActivation [line 273]

void setActivation( [ $iIsActive = FALSE])



Parameters:

   $iIsActive  

[ Top ]

method storeTopic [line 107]

void storeTopic( [ $iParamHash = NULL])



Parameters:

   $iParamHash  

[ Top ]

method verify [line 61]

void verify( &$iParamHash)



Parameters:

   &$iParamHash  

[ Top ]


Documentation generated on Thu, 15 Feb 2007 20:29:07 +0000 by phpDocumentor 1.3.0