Class cpm_dao

Description

This object handles all database transactions with the backend

Located in /cpmfetch/cpmfetch_dao.php (line 22)


	
			
Direct descendents
Class Description
 class cpm CpmFetch allows you to easily access and display information from your Coppermine Photo Gallery (CPG) in a variety of ways. CpmFetch respects the privacy settings in your gallery and will not display images the public would not be allowed to see normally.
Method Summary
 void cpm_debugMode ([$bool $bool = ""])
 void cpm_setDateFormat ([string $_format = ""])
 void cpm_setFilter ([mixed $filter = ""])
 void cpm_unlock_private ([$bool $bool = ""])
 void formatStats ( $format)
 void getAlbumCount ()
 void getCommentCount ()
 void getViewcount ()
Methods
cpm_debugMode (line 201)

Toggles cpmFetch into a debug mode (default: returns setting)

Actives some extra output for troubleshooting. Debug data is output as HTML comments or blockquotes

  • since: 1.1.1
  • access: public
void cpm_debugMode ([$bool $bool = ""])
  • $bool $bool: true or false or blank. Do not enclose in quotes.
cpm_setDateFormat (line 281)

Sets the format as seen in the php DATE function to be used in rendering dates

Sets the format as seen in the php DATE function to be used in rendering dates. For more information on the kinds of date strings you can use check http://www.php.net/manual/en/function.date.php

  • access: public
void cpm_setDateFormat ([string $_format = ""])
  • string $_format: - set to a valid date format string
cpm_setFilter (line 164)

Limits what types of media can be selected by this program

Allows you to specify a list of extensions that are allowable for displaying. Types not explicity identified are omitted from results. The format for submitting file types is an array of extensions. such as array(".jpg",".avi"). There is a limit as matches will be made against the lower case and upper case versions of the types. If you have only one type, you may specifiy it as a string instead of an array.

  • access: public
void cpm_setFilter ([mixed $filter = ""])
  • mixed $filter: - either a string of one extension or an array of several extensions
cpm_unlock_private (line 242)

Toggles access to non-public photos (default: false)

Allows images not publically available to be selected and displayed until it is turned off, or the object is recreated. This program makes no distinction beyond if a media item is public or not.

  • since: Version 0.7
  • access: public
void cpm_unlock_private ([$bool $bool = ""])
  • $bool $bool: true or fale. True unlocks access to private media
formatStats (line 935)

Provides shortcuts into different function that return data

The format is specified by placeholders indicated by percent signs '%'. If you actually want a percent sign you will need to put two percent signs in a row '%%'. The most up to date list for supported placeholders can be found in the coppermine_dao formatStats function. But the main ones are:

  • %f - file count
  • %a - album count
  • %c - category count
  • %v - view count
  • %n - comment count (note count)

  • access: public
void formatStats ( $format)
  • $format
getAlbumCount (line 417)

Returns the number of albums in the database.

  • access: public
void getAlbumCount ()
getCategoryCount (line 467)

Returns the number of categories in the CPG database

  • access: public
void getCategoryCount ()
getCommentCount (line 435)

Returns the number of comments in the CPG database

  • access: public
void getCommentCount ()
getViewcount (line 448)

Returns the total views across the entire CPG database

  • access: public
void getViewcount ()

Documentation generated on Tue, 10 Apr 2007 23:00:33 -0400 by phpDocumentor 1.3.0