BitArticleTopic Class Reference

Inheritance diagram for BitArticleTopic:

[legend]List of all members.

Public Member Functions
	activateTopic ()
	BitArticleTopic ($iTopicId=NULL, $iTopicName=NULL)
	deactivateTopic ()
	getTopicArticles ()
	getTopicImageBaseUrl ($pTopicId=NULL)
	getTopicImageStorageName ($pTopicId=NULL)
	getTopicImageStoragePath ($pTopicId=NULL, $pBasePathOnly=FALSE)
	getTopicImageStorageUrl ($pTopicId=NULL, $pBasePathOnly=FALSE, $pForceRefresh=FALSE)
	getTopicImageThumbUrl ($pTopicId=NULL)
	getTopicList ($pOptionHash=NULL)
	isValid ()
	loadTopic ($iParamHash=NULL)
	removeTopic ($iRemoveArticles=FALSE)
	removeTopicImage ()
	setActivation ($iIsActive=FALSE)
	storeTopic ($iParamHash=NULL)
	verify (&$iParamHash)
Public Attributes
	$mTopicId

---

Detailed Description

Definition at line 21 of file BitArticleTopic.php.

---

Member Function Documentation

BitArticleTopic::activateTopic

(

)

Definition at line 227 of file BitArticleTopic.php.

References setActivation().

Here is the call graph for this function:

BitArticleTopic::BitArticleTopic	(	$	iTopicId = NULL,
		$	iTopicName = NULL
	)

Definition at line 24 of file BitArticleTopic.php.

References BitBase::BitBase(), and loadTopic().

Here is the call graph for this function:

BitArticleTopic::deactivateTopic

(

)

Definition at line 231 of file BitArticleTopic.php.

References FALSE, and setActivation().

Here is the call graph for this function:

BitArticleTopic::getTopicArticles

(

)

Definition at line 241 of file BitArticleTopic.php.

References $ret, $row, $rs, $sql, and mDb.

Referenced by removeTopic().

BitArticleTopic::getTopicImageBaseUrl

(

$

pTopicId = NULL

)

Work out the path to the image for this article

Parameters:

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

Returns:

path on success, FALSE on failure public

Definition at line 151 of file BitArticleTopic.php.

References $ret, FALSE, LibertyAttachable::getStorageUrl(), isValid(), and BitBase::verifyId().

Referenced by getTopicImageThumbUrl(), and storeTopic().

Here is the call graph for this function:

BitArticleTopic::getTopicImageStorageName

(

$

pTopicId = NULL

)

Get the name of the article image file

Parameters:

array

$pTopicId article id public

Returns:

TRUE on success, FALSE on failure

Definition at line 294 of file BitArticleTopic.php.

References $gBitSystem, isValid(), and BitBase::verifyId().

Referenced by getTopicImageStorageUrl().

Here is the call graph for this function:

BitArticleTopic::getTopicImageStoragePath	(	$	pTopicId = NULL,
		$	pBasePathOnly = FALSE
	)

Work out the path to the image for this article

Parameters:

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

Returns:

path on success, FALSE on failure public

Definition at line 314 of file BitArticleTopic.php.

References FALSE, BitArticle::getArticleImageStoragePath(), isValid(), and BitBase::verifyId().

Referenced by getTopicImageStorageUrl(), and removeTopicImage().

Here is the call graph for this function:

BitArticleTopic::getTopicImageStorageUrl	(	$	pTopicId = NULL,
		$	pBasePathOnly = FALSE,
		$	pForceRefresh = FALSE
	)

Work out the URL to the image for this article

Parameters:

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

Returns:

URL on success, FALSE on failure public

Definition at line 343 of file BitArticleTopic.php.

References $gBitSystem, $ret, $url, FALSE, BitArticle::getArticleImageStorageUrl(), getTopicImageStorageName(), getTopicImageStoragePath(), getTopicImageThumbUrl(), isValid(), and BitBase::verifyId().

Referenced by BitArticle::getImageUrl(), getTopicList(), and loadTopic().

Here is the call graph for this function:

BitArticleTopic::getTopicImageThumbUrl

(

$

pTopicId = NULL

)

Get the full URL to the needed thumbnail

Parameters:

numeric

$pTopicId Topic ID of topic in question public

Returns:

Path to thumbnail, FALSE on failure

Definition at line 170 of file BitArticleTopic.php.

References $gBitSystem, $ret, FALSE, getTopicImageBaseUrl(), isValid(), liberty_fetch_thumbnail_url(), and BitBase::verifyId().

Referenced by getTopicImageStorageUrl().

Here is the call graph for this function:

BitArticleTopic::getTopicList

(

$

pOptionHash = NULL

)

Definition at line 183 of file BitArticleTopic.php.

References $gBitSystem, $query, $res, $result, $ret, and getTopicImageStorageUrl().

Referenced by verify().

Here is the call graph for this function:

BitArticleTopic::isValid

(

)

Definition at line 32 of file BitArticleTopic.php.

References BitBase::verifyId().

Referenced by getTopicImageBaseUrl(), getTopicImageStorageName(), getTopicImageStoragePath(), getTopicImageStorageUrl(), and getTopicImageThumbUrl().

Here is the call graph for this function:

BitArticleTopic::loadTopic

(

$

iParamHash = NULL

)

Definition at line 36 of file BitArticleTopic.php.

References $ret, $sql, FALSE, getTopicImageStorageUrl(), mDb, mInfo, and BitBase::verifyId().

Referenced by BitArticleTopic().

Here is the call graph for this function:

BitArticleTopic::removeTopic

(

$

iRemoveArticles = FALSE

)

Definition at line 257 of file BitArticleTopic.php.

References $rs, $sql, getTopicArticles(), mDb, and removeTopicImage().

Here is the call graph for this function:

BitArticleTopic::removeTopicImage

(

)

Definition at line 216 of file BitArticleTopic.php.

References $rs, $sql, getTopicImageStoragePath(), mDb, and mInfo.

Referenced by removeTopic().

Here is the call graph for this function:

BitArticleTopic::setActivation

(

$

iIsActive = FALSE

)

Definition at line 235 of file BitArticleTopic.php.

References $rs, $sql, mDb, and mInfo.

Referenced by activateTopic(), and deactivateTopic().

BitArticleTopic::storeTopic

(

$

iParamHash = NULL

)

Definition at line 109 of file BitArticleTopic.php.

References $gBitUser, $gLibertySystem, getTopicImageBaseUrl(), liberty_clear_thumbnails(), liberty_generate_thumbnails(), liberty_get_function(), mDb, tra(), and verify().

Here is the call graph for this function:

BitArticleTopic::verify

(

&$

iParamHash

)

Definition at line 63 of file BitArticleTopic.php.

References $gBitSystem, $ret, getTopicList(), tra(), and BitBase::verifyId().

Referenced by storeTopic().

Here is the call graph for this function:

---

Member Data Documentation

BitArticleTopic::$mTopicId

Definition at line 22 of file BitArticleTopic.php.

---

The documentation for this class was generated from the following file:

• BitArticleTopic.php

---