|
|
Summary of Qdig Functions
These are the Qdig functions as of Release 1.2.7 / 20050412.
- cam_icon()
- The encoded icon image.
- clear_dot()
- An encoded transparent 1x1 image.
- securityExit($mesg = 'Unspecified Error')
- Exit the script and produce a message.
- trueFalse($data, $true = 'TRUE', $false = 'FALSE')
- Return 'TRUE' or 'FALSE' string based on a variable's status.
- keepParams()
- Return non-Qdig GET parameters, ready for prepending to a query string.
- getImageFilenames($path)
- Get the names of image files in a directory.
- checkForDirs($path)
- Check to see if at least one potential gallery directory exists.
- checkForImgs($path)
- Check for existence of at least one image file in a directory.
- getDirNames($path)
- Get the names of gallery directories in a directory.
A gallery directory is one that contains at least one image or potential
gallery directory. Returns an array with the dirname and its age.
- getReqdImage()
- Get the image number and filename of the requested image.
If none is requested or the file is non-existent, default to the first image.
- cleanPath($path)
- Convert a string to a useful path starting with './'.
click/buzz/./pop//boom/../bam/ becomes ./click/buzz/pop/boom/bam
- urlPath($path)
- rawurlencode() a file's path but keep the slashes.
- imageCounter($image_num)
- Build an 'x of n' counter.
- gdVersion()
- Get which version of GD is installed, if any.
Returns the version (1 or 2) of the GD extension.
- fixPerms()
- Fix permissions of a file or directory.
Adjusts permissions so both the script and account owner can modify / delete.
- mkRecursiveDir($dir)
- Create a directory recursively (like `mkdir -p $dir').
- createThumbs($cnvrt_thmb)
- Generate thumbnail images for images that do not have thumbnails yet.
- predictThumbSize($orig_img)
- Figure out how big a thumb will be, based on input image
- resizeImage($cnvrt_arry)
- Generate images of alternate sizes.
- htmlHeader($header)
- Produce the HTML header for a stand-alone gallery.
Only produce a header if this is a stand-alone gallery.
- htmlFooter($header)
- Produce the HTML footer for a stand-alone gallery.
Only produce a footer if this script is running stand-alone.
- dirnavPath($dir_nav)
- Display the current gallery directory with links to higher-level directories.
- subdirLinks($dir_nav)
- Produce navigation links to subdirectory galleries.
- imageTextLinks($nmrl_row)
- Build a list of Text Name or Text Numeral Links to the images.
- imageThumbsLinks($thmb_row)
- Build a list of Thumbnail Image Links to the images in the current directory.
- dirNav($dir_nav)
- Produce a Directory Navigation Row.
Contains the path to the current gallery directory and subdirectory links.
- displayImage($reqd_image, $labels)
- Display the requested image.
Show the requested image and the caption, if any.
- captionBlock($img_file, $img_width)
- Produce an Image Caption table.
The block is as wide as the image or else $caption['min_width'] pixels.
- prevLink($img_num, $nav_wrap)
- Produce a `Previous Image'or `Last Image` link for a Gallery Navigation Row.
Link to the previous image, or optionally to the last if this is first image.
- nextLink($nav_wrap)
- Produce a `Next Image' or `First Image' link for a Gallery Navigation Row.
Link to the next image, or optionally to the first if this is the last image.
- lastLink($reqd_image)
- Produce a `Last Image' (` >>| ') link for a Gallery Navigation Row.
- firstLink($img_num)
- Build a `First Image' (` |<< ') link for a Gallery Navigation Row.
- navRow($nav)
- Build a Gallery Navigation Row table.
Includes Prev/Next links and/or Home link, as set by user settings.
- footerRow()
- Produce a Gallery Footer Row table.
Includes Site Home Link, Copyright, and Quig Home link.
- displayImageLinks($thmb_row, $nmrl_row)
- Display either the Text or Thumbnail Image Links.
- controlView($ctrl_links_mesg)
- Produce a `Default View' chooser for a Gallery Control Bar.
- controlSize($labels)
- Produce a `Default Size' chooser for a Gallery Control Bar.
- navSize($small_b, $labels)
- Produce a Size Chooser for a Gallery Navigation Row.
- navFull($small_b, $labels)
- Produce an `Full Size' chooser for a Gallery Navigation Row.
- sideBar($namelinks_ena, $thmbs_ena, $sidebar_table_bg_clr, $sb_pad_top)
- Produce a Gallery Sidebar if appropriate.
- siteHomeLink($site_lnk_url, $site_lnk_title)
- Produce a `Site Home' link for the Gallery Footer.
- showCopyright($copyright)
- Produce the copyright text for the Gallery Footer.
- adminLink($admin)
- Produce an Admin link to the current image's admin.php caption-edit page.
- qdigHomelink($qdighome_alone)
- Produce a link to the Qdig script home page for the Gallery Footer.
|
|
