FisheyeImage Class Reference

Inheritance diagram for FisheyeImage:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 convertColorspace ($pColorSpace)
 exportHtml ($pData=NULL)
 expunge ($pExpungeAttachment=TRUE)
 expungingAttachment ($pAttachmentId, $pContentIdArray)
 FisheyeImage ($pImageId=NULL, $pContentId=NULL)
 generateThumbnails ($pResizeOriginal=NULL)
 getDisplayLink ($pTitle=NULL, $pMixed=NULL)
 getDisplayUrl ($pImageId=NULL, $pMixed=NULL)
 getExifField ($pExifField)
 getImageDetails ($pFilePath=NULL)
 getList (&$pListHash)
 getRenderFile ()
 getRenderTemplate ()
 getSourceFile ()
 getSourceUrl ()
 getThumbnailUrl ($pSize='small', $pInfoHash=NULL)
 imageExistsInDatabase ()
 isCommentable ()
 isLandscape ()
 isValid ()
 load ()
 loadThumbnail ($pSize='small')
 lookup ($pLookupHash)
 renderThumbnails ($pThumbSizes=NULL)
 resizeOriginal ($pResizeOriginal)
 rotateImage ($pDegrees)
 store (&$pStorageHash)
 verifyImageData (&$pStorageHash)

Public Attributes

 $mImageId

Detailed Description

Definition at line 17 of file FisheyeImage.php.


Member Function Documentation

FisheyeImage::convertColorspace ( pColorSpace  ) 

convertColorspace

Parameters:
string $pColorSpace - target color space, only 'grayscale' is currently supported, and only when using the MagickWand image processor public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 325 of file FisheyeImage.php.

References $ret, $sql, FALSE, generateThumbnails(), image, liberty_clear_thumbnails(), liberty_get_function(), load(), mDb, and mInfo.

Here is the call graph for this function:

FisheyeImage::exportHtml ( pData = NULL  ) 

Create an export object from the data

Parameters:
array Not used

Reimplemented from LibertyContent.

Definition at line 127 of file FisheyeImage.php.

References $query, $ret, LibertyContent::getContentType(), getDisplayUrl(), BitBase::getField(), getImageDetails(), LibertyContent::getTitle(), isLandscape(), isValid(), mContentId, mDb, mInfo, title, and url.

Here is the call graph for this function:

FisheyeImage::expunge ( pDeleteAttachments = TRUE  ) 

Expunges the content deleting attachments if asked to do so, otherwise just detaching them

Reimplemented from LibertyAttachable.

Definition at line 573 of file FisheyeImage.php.

References $query, $rs, LibertyContent::expunge(), isValid(), mContentId, and mDb.

Here is the call graph for this function:

FisheyeImage::expungingAttachment ( pAttachmentId,
pContentIds 
)

Called during attachment deletion to notify a content type that an attachment for content of that type is going away so it can take appropriate action. Note that it is VITAL that content NOT call expunge(TRUE) as part of handling this notification or else the universe will implode.

Parameters:
the id of the attachment being deleted
an array of content_ids that reference this attachment that are of this type.

Reimplemented from LibertyAttachable.

Definition at line 591 of file FisheyeImage.php.

References LibertyContent::expunge(), FALSE, and mContentId.

Here is the call graph for this function:

FisheyeImage::FisheyeImage ( pImageId = NULL,
pContentId = NULL 
)

Definition at line 20 of file FisheyeImage.php.

References FisheyeBase::FisheyeBase(), mContentId, and LibertyContent::registerContentType().

Here is the call graph for this function:

FisheyeImage::generateThumbnails ( pResizeOriginal = NULL  ) 

Definition at line 398 of file FisheyeImage.php.

References $gBitSystem, $query, $ret, FALSE, mContentId, mDb, and renderThumbnails().

Referenced by convertColorspace(), rotateImage(), and store().

Here is the call graph for this function:

FisheyeImage::getDisplayLink ( pTitle = NULL,
pMixed = NULL 
)

Generate a valid display link for the Blog

Parameters:
object PostId of the item to use
array Not used
Returns:
object Fully formatted html link for use by Liberty

Definition at line 538 of file FisheyeImage.php.

References $gBitSystem, $ret, LibertyContent::getTitle(), mInfo, and title.

Here is the call graph for this function:

FisheyeImage::getDisplayUrl ( pImageId = NULL,
pMixed = NULL 
)

Function that returns link to display a piece of content

Parameters:
pImageId id of gallery to link
pMixed if a string, it is assumed to be the size, if an array, it is assumed to be a mInfo hash
Returns:
the url to display the gallery.

Reimplemented from LibertyContent.

Definition at line 491 of file FisheyeImage.php.

References $gBitSystem, $info, $ret, image, mInfo, and BitBase::verifyId().

Referenced by exportHtml(), and getList().

Here is the call graph for this function:

FisheyeImage::getExifField ( pExifField  ) 

Definition at line 243 of file FisheyeImage.php.

References $ret, and getSourceFile().

Referenced by rotateImage().

Here is the call graph for this function:

FisheyeImage::getImageDetails ( pFilePath = NULL  ) 

Definition at line 450 of file FisheyeImage.php.

References $info, and getSourceFile().

Referenced by exportHtml(), resizeOriginal(), and store().

Here is the call graph for this function:

FisheyeImage::getList ( &$  pListHash  ) 

Definition at line 621 of file FisheyeImage.php.

References $gBitSystem, $gBitUser, $mid, $query, $ret, $rs, getDisplayUrl(), LibertyContent::getServicesSql(), image, FisheyeBase::isMachineName(), liberty_fetch_thumbnail_url(), mDb, LibertyContent::prepGetList(), title, and BitBase::verifyId().

Here is the call graph for this function:

FisheyeImage::getRenderFile (  ) 

Returns include file that will setup vars for display

Returns:
the fully specified path to file to be included

Reimplemented from LibertyContent.

Definition at line 473 of file FisheyeImage.php.

FisheyeImage::getRenderTemplate (  ) 

Returns template file used for display

Returns:
the fully specified path to file to be included

Definition at line 481 of file FisheyeImage.php.

FisheyeImage::getSourceFile (  ) 

Definition at line 441 of file FisheyeImage.php.

References $ret, and mInfo.

Referenced by getExifField(), and getImageDetails().

FisheyeImage::getSourceUrl (  ) 

Definition at line 433 of file FisheyeImage.php.

References $ret, and mInfo.

FisheyeImage::getThumbnailUrl ( pSize = 'small',
pInfoHash = NULL 
)

Definition at line 560 of file FisheyeImage.php.

References $ret, loadThumbnail(), and mInfo.

Here is the call graph for this function:

FisheyeImage::imageExistsInDatabase (  ) 

Definition at line 603 of file FisheyeImage.php.

References $query, $ret, FALSE, isValid(), and mDb.

Referenced by store().

Here is the call graph for this function:

FisheyeImage::isCommentable (  ) 

isCommentable

public

Returns:
TRUE on success, FALSE on failure

Reimplemented from LibertyContent.

Definition at line 692 of file FisheyeImage.php.

References $gGallery, $query, $ret, FALSE, FisheyeBase::getParentGalleries(), and mDb.

Here is the call graph for this function:

FisheyeImage::isLandscape (  ) 

Definition at line 156 of file FisheyeImage.php.

References mInfo.

Referenced by exportHtml(), and rotateImage().

FisheyeImage::isValid (  ) 

Check mContentId to establish if the object has been loaded with a valid record

Reimplemented from LibertyContent.

Definition at line 599 of file FisheyeImage.php.

References mContentId, and BitBase::verifyId().

Referenced by exportHtml(), expunge(), imageExistsInDatabase(), and load().

Here is the call graph for this function:

FisheyeImage::load (  ) 

Definition at line 62 of file FisheyeImage.php.

References $gBitSystem, $query, $sql, editor, LibertyContent::getServicesSql(), isValid(), LibertyAttachable::load(), mContentId, mDb, mInfo, mStorage, and BitBase::verifyId().

Referenced by convertColorspace(), renderThumbnails(), resizeOriginal(), and rotateImage().

Here is the call graph for this function:

FisheyeImage::loadThumbnail ( pSize = 'small'  ) 

Definition at line 556 of file FisheyeImage.php.

References mInfo.

Referenced by getThumbnailUrl().

FisheyeImage::lookup ( pLookupHash  ) 

Definition at line 40 of file FisheyeImage.php.

References $gBitDb, $lookup, $ret, LibertyBase::getLibertyObject(), and BitBase::verifyId().

Here is the call graph for this function:

FisheyeImage::renderThumbnails ( pThumbSizes = NULL  ) 

Definition at line 416 of file FisheyeImage.php.

References image, liberty_generate_thumbnails(), load(), and mInfo.

Referenced by generateThumbnails().

Here is the call graph for this function:

FisheyeImage::resizeOriginal ( pResizeOriginal  ) 

Definition at line 347 of file FisheyeImage.php.

References $gBitSystem, $query, $storeHash, getImageDetails(), image, liberty_get_function(), load(), mContentId, mDb, and mInfo.

Referenced by store().

Here is the call graph for this function:

FisheyeImage::rotateImage ( pDegrees  ) 

Definition at line 259 of file FisheyeImage.php.

References $gBitSystem, generateThumbnails(), getExifField(), image, isLandscape(), liberty_clear_thumbnails(), liberty_get_function(), load(), mContentId, mDb, and mInfo.

Here is the call graph for this function:

FisheyeImage::store ( &$  pParamHash  ) 

Create a new content object or update an existing one

Parameters:
array Array of content data to be stored
See verify for details of the values required

Reimplemented from LibertyAttachable.

Definition at line 174 of file FisheyeImage.php.

References $gBitSystem, $gLibertySystem, $rs, $sql, LibertyAttachable::expungeAttachment(), generateThumbnails(), getImageDetails(), imageExistsInDatabase(), mContentId, mDb, mInfo, resizeOriginal(), LibertyAttachable::store(), and verifyImageData().

Here is the call graph for this function:

FisheyeImage::verifyImageData ( &$  pStorageHash  ) 

Definition at line 160 of file FisheyeImage.php.

References FALSE, and LibertyContent::getContentType().

Referenced by store().

Here is the call graph for this function:


Member Data Documentation

FisheyeImage::$mImageId

Definition at line 18 of file FisheyeImage.php.


The documentation for this class was generated from the following file:
Generated on Wed Aug 22 19:34:36 2007 for bitweaver by  doxygen 1.5.2