File_Fortune
[ class tree: File_Fortune ] [ index: File_Fortune ] [ all elements ]

Element index for package File_Fortune

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ m ] [ n ] [ o ] [ r ] [ u ] [ v ] [ w ] [ _ ]

_

_computeHeader
in file Fortune.php, method File_Fortune::_computeHeader()
    Compute fortune file header information
_fileLoop
in file Fortune.php, method File_Fortune::_fileLoop()
    Loop through an array looking for files
_readFromFile
in file Fortune.php, method File_Fortune::_readFromFile()
    Read a fortune from the file
_readHeader
in file Fortune.php, method File_Fortune::_readHeader()
    Read a fortune database header file
_writeHeader
in file Writer.php, method File_Fortune_Writer::_writeHeader()
    Write the header file for a fortune file
__construct
in file Fortune.php, method File_Fortune::__construct()
    Constructor; initialize a fortune cookie database
__destruct
in file Fortune.php, method File_Fortune::__destruct()
    Destructor
top

a

add
in file Writer.php, method File_Fortune_Writer::add()
    Add a new fortune
top

c

close
in file Fortune.php, method File_Fortune::close()
    Close fortune file
top

d

$delim
in file Fortune.php, variable File_Fortune::$delim
    Character that delimits fortunes (defaults to '%')
delete
in file Writer.php, method File_Fortune_Writer::delete()
    Remove a fortune
top

e

Exception.php
procedural page Exception.php
top

f

$file
in file Fortune.php, variable File_Fortune::$file
    Fortune file filehandle
$filename
in file Fortune.php, variable File_Fortune::$filename
    Name of fortune file to use
$flags
in file Fortune.php, variable File_Fortune::$flags
    Bit field for flags
$fortunes
in file Fortune.php, variable File_Fortune::$fortunes
    Array of fortunes; unset by default.
File_Fortune
in file Fortune.php, class File_Fortune
    File_Fortune: Interface to fortune cookie databases
Fortune.php
procedural page Fortune.php
File_Fortune_Exception
in file Exception.php, class File_Fortune_Exception
    File_Fortune_Exception: Exception classes for File_Fortune and File_Fortune_Writer
File_Fortune_Exception_BadFile
in file Exception.php, class File_Fortune_Exception_BadFile
    File_Fortune_Exception_BadFile is thrown whenever a file cannot be opened (missing file, error opening file).
File_Fortune_Exception_BadHeaderFile
in file Exception.php, class File_Fortune_Exception_BadHeaderFile
    File_Fortune_Exception_BadHeaderFile is thrown if an error occurs opening the header file or if the header file is malformed.
File_Fortune_Exception_HeaderNotRead
in file Exception.php, class File_Fortune_Exception_HeaderNotRead
    File_Fortune_Exception_HeaderNotRead is thrown whenever an operation requiring elements obtained from the header is called and those elements are missing.
File_Fortune_Exception_InvalidCount
in file Exception.php, class File_Fortune_Exception_InvalidCount
    File_Fortune_Exception_InvalidCount is thrown when an attempt is made to read a fortune ID that is beyond the number of fortunes available in the file, and all fortunes have been previously read into File_Fortune::$fortunes.
File_Fortune_Exception_InvalidID
in file Exception.php, class File_Fortune_Exception_InvalidID
    File_Fortune_Exception_InvalidID is thrown when an attempt is made to read a fortune ID for which there is no corresponding offset.
File_Fortune_Exception_NoFile
in file Exception.php, class File_Fortune_Exception_NoFile
    File_Fortune_Exception_NoFile is thrown whenever an attempt is made to read from an unopened file.
File_Fortune_Exception_NoFilename
in file Exception.php, class File_Fortune_Exception_NoFilename
    File_Fortune_Exception_NoFilename is thrown whenever an attempt is made to open a fortune file without specifying a file name.
File_Fortune_Exception_NotOpen
in file Exception.php, class File_Fortune_Exception_NotOpen
    File_Fortune_Exception_NotOpen is thrown when an attempt is made to read from an unopened fortune file.
File_Fortune_Exception_Offset
in file Exception.php, class File_Fortune_Exception_Offset
    File_Fortune_Exception_Offset is thrown when reading from a fortune file and fseek() is unable to seek to the desired fortune offset.
File_Fortune_Writer
in file Writer.php, class File_Fortune_Writer
    File_Fortune_Writer: Write and modify fortune files
File_Fortune_Writer_Exception
in file Exception.php, class File_Fortune_Writer_Exception
    File_Fortune_Writer base exception class.
File_Fortune_Writer_Exception_FileLock
in file Exception.php, class File_Fortune_Writer_Exception_FileLock
    File_Fortune_Writer_Exception_FileLock is thrown whenever flock() is unable to obtain a file lock.
File_Fortune_Writer_Exception_FileOpen
in file Exception.php, class File_Fortune_Writer_Exception_FileOpen
    File_Fortune_Writer_Exception_FileOpen is thrown whenever fopen() is unable to open a file for a write operation.
File_Fortune_Writer_Exception_FilePos
in file Exception.php, class File_Fortune_Writer_Exception_FilePos
    File_Fortune_Writer_Exception_FilePos is thrown whenever ftell() is unable to return the current position in the file.
top

g

getAll
in file Fortune.php, method File_Fortune::getAll()
    Retrieve all fortunes in a file
getRandom
in file Fortune.php, method File_Fortune::getRandom()
    Return a random fortune
getRandomFromSet
in file Fortune.php, method File_Fortune::getRandomFromSet()
    Retrieve a random fortune from a list of fortune files
top

h

$headerFilename
in file Fortune.php, variable File_Fortune::$headerFilename
    Name of fortune header file (.dat file)
top

m

$maxLength
in file Fortune.php, variable File_Fortune::$maxLength
    Length of longest string in the fortune file
$minLength
in file Fortune.php, variable File_Fortune::$minLength
    Length of shortest string in the fortune file
top

n

$noHeader
in file Fortune.php, variable File_Fortune::$noHeader
    Flag indicating whether or not a header file is present. Defaults to false.
$numstr
in file Fortune.php, variable File_Fortune::$numstr
    Number of strings (fortunes) in the file
num
in file Fortune.php, method File_Fortune::num()
    Return number of fortunes
top

o

$offsets
in file Fortune.php, variable File_Fortune::$offsets
    Array of file offsets (fortune indices)
open
in file Fortune.php, method File_Fortune::open()
    Open a fortune file
top

r

read
in file Fortune.php, method File_Fortune::read()
    Return a fortune
top

u

update
in file Writer.php, method File_Fortune_Writer::update()
    Update a single fortune in a file
top

v

$VERSION
in file Fortune.php, variable File_Fortune::$VERSION
    Version
$version
in file Fortune.php, variable File_Fortune::$version
    Version number for fortune file
top

w

Writer.php
procedural page Writer.php
write
in file Writer.php, method File_Fortune_Writer::write()
    Write a fortune file
top

Documentation generated on Mon, 11 Mar 2019 14:18:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.