$basedir
$basedir : string
The base directory we store comics in.
\Klutz_Driver_File
Klutz Driver implementation for comics as files.
Required parameters:
'directory' The main directory the comics are stored in 'sumsfile' The filename to hold md5sums for images
Summary
listDates()
imageSize()
imageExists()
storeImage()
retrieveImage()
Klutz_Driver_file()
loadSums()
saveSums()
rebuildSums()
addSum()
removeSum()
isUnique()
removeImage()
removeDate()
$subdir
$sumsfile
$diffs
Properties
Methods
factory()
factory(string $driver = null, array $params = null) : object
Gets a concrete Klutz_Driver instance.
Parameters
| string | $driver | The type of concrete Klutz_Driver subclass to return. The code for the driver is dynamically included. |
| array | $params | A hash containing any additional configuration or connection parameters a subclass might need |
Returns
object —Klutz_Driver The newly created concrete instance, or false on error.
listDates()
listDates(\timestamp $date = null, \timestamp $oldest = null, \timestamp $newest = null) : array
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.
Parameters
| \timestamp | $date | The reference date (default today) |
| \timestamp | $oldest | The earliest possible date to return (default first of the month) |
| \timestamp | $newest | The latest possible date to return (default last date of the month) |
Returns
array —timestamps Any dates between $oldest and $newest that we have comics for.
imageSize()
imageSize(string $index, \timestamp $date = null) : string
Get the image dimensions for the requested image.
The image is not stored locally so this function returns an empty string. Performance hit is too expensive to make this worth it.
Parameters
| string | $index | The index of the comic to check |
| \timestamp | $date | The date of the comic to check (default today) |
Returns
string —Attributes for an tag giving height and width
imageExists()
imageExists(string $index, \timestamp $date = null) : boolean
Find out if we already have a local copy of this image.
Even though we never actually store a local copy, pretend.
Parameters
| string | $index | The index of the comic to check |
| \timestamp | $date | The date of the comic to check (default today) |
Returns
boolean —False in this driver
storeImage()
storeImage(string $index, string $image, $date = null) : boolean
Store an image for later retrieval.
Even though we never actually store a local copy, pretend.
Parameters
| string | $index | The index of the comic to retrieve |
| string | $image | Raw (binary) image data to store |
| $date |
Returns
boolean —True on success, false otherwise
retrieveImage()
retrieveImage(string $index, \timestamp $date = null) : mixed
Retrieve an image from storage. Make sure the image exists first with imageExists().
Parameters
| string | $index | The index of the comic to retrieve |
| \timestamp | $date | The date for which we want $comic |
Returns
mixed —If the image exists locally, return a Klutz_Image object. If it doesn't, return a string with the URL pointing to the comic.
removeSum()
removeSum(string $index = null, \timestamp $date = null) : void
Remove the unique identifier for the given comic and/or date. If both are passed, removes the uid for that comic and date. If only a comic is passed, removes all uids for that comic. If only a date is passed removes uids for all comics on that date. If neither is passed, all uids are wiped out.
Parameters
| string | $index | Index for the comic to delete. If left out all comics will be assumed. |
| \timestamp | $date | Date to remove. If left out, assumes all dates. |
removeImage()
removeImage(string $index, \timestamp $date = null) : boolean
Remove an image from the storage system (including its unique ID).
Parameters
| string | $index | The index of the comic to remove |
| \timestamp | $date | The date of the comic to remove (default today) |
Returns
boolean —True on success, else false