Full index

Package indexes


a b c d f g h i k l m n o p r s t u w _
a
top
Variable $agent
Klutz_Comic::$agent in Comic.php
The user-agent to use when fetching the comic.
Variable $author
The author or authors of the comic (the byline)
Method addSum
Add a unique identifier for a given image.
Method addSum
Add a unique identifier for a given image.
Page api.php
api.php in api.php
b
top
Variable $basedir
The base directory we store comics in.
Variable $basedir
The base directory we store comics in.
Page base.php
base.php in base.php
Page bysize.php
bysize.php in bysize.php
c
top
Variable $choose
How should we decide which image to take? Options are "first", "biggest", and "smallest".
Variable $comics
Klutz::$comics in Klutz.php
Array of comics and their associated attributes
Variable $comment
Some comment to display for this comic
Variable $cookies
Cookies to set when fetching the comic.
Method comicObject
Return a Klutz_Comic for the given index
Page Comic.php
Comic.php in Comic.php
d
top
Variable $data
Klutz_Image::$data in Image.php
The image data itself (binary)
Variable $days
Klutz::$days in Klutz.php
Used to translate between literal dow and numeric dow (sun = 0, 7)
Variable $days
Klutz_Comic::$days in Comic.php
Days (lowercase, three-letter english abbreviation) that this comic is is available.
Variable $diffs
The actual array of unique image identifiers (md5 sums right now).
Page direct.php
direct.php in direct.php
Page Driver.php
Driver.php in Driver.php
f
top
Variable $file
Klutz_Image::$file in Image.php
The name of the file the image is stored in (if it's stored locally)
Method factory
Gets a concrete Klutz_Driver instance.
Method fetchImage
Fetch the actual image.
Method fetchImage
Fetch the actual image
Method fetchImage
Fetch the actual image
Method fetchURL
Do all that is necessary to get the final URL from which the comic will be fetched. Instead of returning the comic, return the URL pointing to that comic.
Method fetchURL
Do all that is necessary to get the final URL from which the comic will be fetched. Instead of returning the comic, return the URL pointing to that comic.
Method fetchURL
Do all that is necessary to get the final URL from which the comic will be fetched. Instead of returning the comic, return the URL pointing to that comic.
Page file.php
file.php in file.php
g
top
Method getInstance
Get the instance requested based on the date. The instance is determined by itype, iformat, idate, isow
Method getInstance_monthly
Get an instance number for a comic that appears monthly
Method getInstance_ref
Get an instance number for a comic based on a date reference.
Method getInstance_weekly
Get an instance number for a comic that appears weekly
Method getInstance_yearly
Get an instance number for a comic that appears yearly (NOT IMPLEMENTED!)
Method getMenu
Klutz::getMenu() in Klutz.php
Build Klutz's list of menu items.
Method getOverride
Check for "override" settings - settings that override other settings depending on the day on which the comic appears
Method getProperty
Return the requested property for the requested comic
h
top
Variable $headers
Headers to set when fetching the comic.
Variable $height
The height of the image in pixels
Variable $homepage
The URL for the official homepage (not necessarily where we get the comic from.
Variable $http
Klutz_Comic::$http in Comic.php
Web browser object used to fetch pages
Function handle_comic_select
$Horde: klutz/lib/prefs.php,v 1.9 2008/08/17 14:08:17 mrubinsk Exp $
Constant HORDE_BASE
HORDE_BASE in base.php
Klutz base inclusion file.
Class Horde_Block_Klutz_summary
$Horde: klutz/lib/Block/summary.php,v 1.26 2007/02/26 04:12:34 chuck Exp $
i
top
Variable $icount
The number of the "first" instance of the comic (the reference number) when using the reference-based instance type
Variable $idate
Klutz_Comic::$idate in Comic.php
The date for which the reference is icount.
Variable $iformat
Format string for the instance construct (printf string)
Variable $ignore
A list of images to ignore (preg matches)
Variable $image_types
Klutz::$image_types in Klutz.php
MIME types for images based on the return value from getimagesize
Variable $isow
Klutz_Comic::$isow in Comic.php
The day the "week" starts for instance type weekly.
Variable $itype
Klutz_Comic::$itype in Comic.php
Method for counting instances (when using the 'i' construct in substitutions.
Method imageExists
Find out if we already have a local copy of this image.
Method imageExists
Find out if we already have a local copy of this image.
Method imageExists
Find out if we already have a local copy of this image.
Method imageSize
Get the image dimensions for the requested image.
Method imageSize
Get the image dimensions for the requested image.
Method imageSize
Get the image dimensions for the requested image.
Method isUnique
Determine if the image passed is a unique image (one we don't already have).
Method isUnique
Determine if the image passed is a unique image (one we don't already have).
Page Image.php
Image.php in Image.php
k
top
Method Klutz
Klutz::Klutz() in Klutz.php
Constructor - Parse the /config/comics.php config file and store
Class Klutz
Klutz in Klutz.php
Klutz Base Class.
Constant KLUTZ_BASE
KLUTZ_BASE in base.php
Class Klutz_Comic
Klutz_Comic in Comic.php
Klutz Comic Class.
Method Klutz_Comic
Loads the $comics[$comic] array into this object
Method Klutz_Comic_bysize
Constructor - Create an object that can be used to retrieve a comic by looking at all images on a page, a list of images to ignore, and a range of dimensions, then choose which image is most likely the comic.
Class Klutz_Comic_bysize
Klutz_Comic_bysize in bysize.php
Klutz_Comic_bysize Class.
Class Klutz_Comic_direct
Klutz_Comic_direct in direct.php
Klutz_Comic_direct Class.
Method Klutz_Comic_direct
Constructor - Create an object that can be used to retrieve a comic directly from a URL passed in (using substitutions as necessary).
Method Klutz_Comic_search
Constructor - Create an object that can be used to retrieve a comic by using a preg_match to reliably get the comic URL from an html document.
Class Klutz_Comic_search
Klutz_Comic_search in search.php
Klutz_Comic_search Class.
Class Klutz_Driver
Klutz_Driver in Driver.php
Klutz_Driver:: defines an API for storing and retrieving the comic images
Method Klutz_Driver
Class Klutz_Driver_file
Klutz_Driver_file in file.php
Klutz Driver implementation for comics as files.
Method Klutz_Driver_file
Constructs a new file storage object.
Method Klutz_Driver_sql
Constructs a new SQL storage object.
Class Klutz_Driver_sql
Klutz_Driver_sql in sql.php
Klutz Driver implementation for comics as files with SUM info stored in SQL database.
Constant KLUTZ_FLD_HEIGHT
KLUTZ_FLD_HEIGHT in Klutz.php
Height (integer).
Constant KLUTZ_FLD_HTML
KLUTZ_FLD_HTML in Klutz.php
IMG-appropriate HTML.
Constant KLUTZ_FLD_TYPE
KLUTZ_FLD_TYPE in Klutz.php
Type (integer).
Constant KLUTZ_FLD_WIDTH
KLUTZ_FLD_WIDTH in Klutz.php
Width (integer).
Method Klutz_Image
Constructor - Based on the information passed, loads an image, determines the size and type, etc., and stores the information in the various public properties. Any optional parameters not passed in are calculated to the best of our ability.
Class Klutz_Image
Klutz_Image in Image.php
Klutz Image Class
Constant KLUTZ_SORT_AUTHOR
KLUTZ_SORT_AUTHOR in Klutz.php
Sort by the comic's author.
Constant KLUTZ_SORT_NAME
KLUTZ_SORT_NAME in Klutz.php
Sort by the comic's name.
Constant KLUTZ_SORT_NOSORT
KLUTZ_SORT_NOSORT in Klutz.php
Don't bother sorting.
Constant KLUTZ_TEMPLATES
KLUTZ_TEMPLATES in base.php
Page Klutz.php
Klutz.php in Klutz.php
l
top
Variable $lastmodified
The last modified time of the file (only used if file is local).
Method listByDriver
Return a list of comics that use the given fetch driver
Method listDates
Get a list of the dates for which we have comics between $oldest and $newest. Only returns dates we have at least one comic for.
Method listDates
Get a list of the dates for which we have comics between $oldest and $newest. Only returns dates we have at least one comic for.
Method listDates
Gets a list of the dates for which we have comics between $oldest and $newest. In the default driver (no backend) this is just a list of all dates between $oldest and $newest.
Method listEnabled
Return a list of comics that are marked as enabled, and that should appear on a given day if a date is passed in.
Method loadSums
We do nothing in this function for the SQL driver since we grab the info on demand from the database. We keep the function here, however to honor our 'interface' since we call this function from various places in the client code.
Method loadSums
Load a list of unique identifiers for comics from the sumsfile.
m
top
Variable $maxheight
What is the largest height to consider
Variable $maxwidth
What is the largest width to consider
Variable $minheight
What is the smallest height to consider
Variable $minwidth
What are the smallest width to consider
n
top
Variable $name
Klutz_Comic::$name in Comic.php
The title of the comics (Dilbert, The 5th Wave, etc.)
Variable $nohistory
Are past episodes available? Some comics are difficult or impossible to retrieve other than the day it's published.
o
top
Variable $offset
Days behind the current date this comic is published
Variable $override
The array of overrides by weekday. If sun_url exists, then when trying to fetch the sunday edition of this comic, it will fetch it from the specified url instead of $url.
p
top
Variable $pass
Klutz_Comic::$pass in Comic.php
The password to use when fetching the comic.
Page prefs.php
prefs.php in prefs.php
r
top
Variable $referer
The referral URL to use when fetching the comic.
Method rebuildSums
Rebuild the table of unique identifiers.
Method rebuildSums
Rebuild the table of unique identifiers.
Method removeDate
Remove all images from the storage system (including unique IDs) for a given date.
Method removeDate
Remove all images from the storage system (including unique IDs) for a given date.
Method removeImage
Remove an image from the storage system (including its unique ID).
Method removeImage
Remove an image from the storage system (including its unique ID).
Method removeSum
Remove the unique identifier for the given comic and/or
Method removeSum
Remove the unique identifier for the given comic and/or
Method retrieveImage
Retrieve an image from storage. Make sure the image exists first with imageExists().
Method retrieveImage
Retrieve an image from storage. Make sure the image exists first with imageExists().
Method retrieveImage
Retrieve an image from storage. Since there is no local storage this will actually call for the fetching.
s
top
Variable $search
Once set, an array of preg searches to perform to find the comic image
Variable $search
Once set, an array of preg searches to perform to find the comic image
Variable $size
Klutz_Image::$size in Image.php
The attributes to use in an <img> tag to define the size (e.g. height="120" width="400")
Variable $sort
Klutz::$sort in Klutz.php
Sorting method to use. Options are KLUTZ_SORT_NAME (sort by comic title), KLUTZ_SORT_AUTHOR (sort by Author's last name), and KLUTZ_SORT_NOSORT (don't promise any given sorting order).
Variable $subdir
The format for the various subdirectories.
Variable $subdir
The format for the various subdirectories.
Variable $subs
Klutz_Comic::$subs in Comic.php
An array of the fields we need to do substitution on.
Variable $sumsfile
The file we store unique image identifiers in.
Page summary.php
summary.php in summary.php
Page search.php
search.php in search.php
Page sql.php
sql.php in sql.php
Method saveSums
Save the list of unique identifiers for comics to the sumsfile.
Method singleton
Gets a reference to a concrete Klutz_Driver instance.
Method storeImage
Store an image for later retrieval.
Method storeImage
Store an image for later retrieval.
Method storeImage
Store an image for later retrieval
Method substitute
Process known substitutions in a string. Currently known options:
t
top
Variable $type
Klutz_Image::$type in Image.php
The mime type of the image
u
top
Variable $updateable
Whether this block has changing content.
Variable $url
Klutz_Comic::$url in Comic.php
The first url we need to hit to get the comic we want.
Variable $user
Klutz_Comic::$user in Comic.php
The username to use when fetching the comic.
w
top
Variable $width
Klutz_Image::$width in Image.php
The width of the image in pixels
_
top
Variable $_app
Variable $_db
The MDB2 database object
Method _content
The content to go in this block.
Method _convertDay
Convert a user-passed string into a three-letter, lowercased day abbr.
Method _expandurls
Expand paths to fully-qualified URLs
Method _getsizes
Get the dimensions from the list of images passed in.
Method _ignore
Determine if the passed image name is on the list of images to ignore.
Method _initHTTP
Create an HTTP_Request object and set all parameters necessary to perform fetches for this comic.
Function _klutz_perms
_klutz_perms() in api.php
Permissions per every forum in scope
Method _sortComics
Comparse two comics and return -1, 0, or 1 based on the $sort member variable
Method _stripimages
Strip the list of images from the contents of a web page.
Method _title
The title to go in this block.
a b c d f g h i k l m n o p r s t u w _