Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Examples | Search for 

FF_Model_OverrideCode Class Reference

Inheritance diagram for FF_Model_OverrideCode:

FF_Model List of all members.

Public Member Functions

 reset ()
 importFromArray ($in_data)
 exportToArray ()
 getLogEntryDescription ($in_id)
 isCodeValid ($in_code, $in_borrowerId)
 useCode ($in_code, $in_transactionId)
 getNewCode ()
 getCode ()
 setCode ($in_value)
 getFormattedMultiUse ()
 setMultiUse ($in_value)
 getMultiUse ()
 getCreatorName ()
 getCreatorId ()
 setCreatorId ($in_value)
 getFormattedStartDate ()
 getStartDate ()
 setStartDate ($in_value)
 getFormattedEndDate ()
 getEndDate ()
 setEndDate ($in_value)
 getFormattedUseDate ()
 getUseDate ()
 setUseDate ($in_value)
 getTransactionId ()
 setTransactionId ($in_value)
 setBorrowerIdByBarcode ($in_barcode)
 getBorrowerName ()
 getBorrowerId ()
 setBorrowerId ($in_value)
 formatTimestamp ($in_timestamp)
 _initBorrowerDataAccess ()
 _initDataAccess ()

Public Attributes

 $code
 $creatorId
 $startDate
 $endDate
 $useDate
 $transactionId
 $borrowerId
 $o_borrowerDataAccess
 $multiUse

Detailed Description

Definition at line 43 of file Model/OverrideCode.php.

Member Function Documentation

FF_Model_OverrideCode::_initBorrowerDataAccess (   ) 
 

Initializes the dao object for the current borrower

private

Returns:
void

Definition at line 520 of file Model/OverrideCode.php.

References FF_DataAccess::factory().

Referenced by getBorrowerName().

FF_Model_OverrideCode::_initDataAccess (   ) 
 

Initializes the data access object

private

Returns:
void

Reimplemented from FF_Model.

Definition at line 536 of file Model/OverrideCode.php.

References FF_DataAccess::factory().

FF_Model_OverrideCode::exportToArray (   ) 
 

Exports the data properties to an array using the dataaccess constants as keys

Parameters:
array $in_data The data array
public
Returns:
array The array of data

Reimplemented from FF_Model.

Definition at line 156 of file Model/OverrideCode.php.

References $a_data, getBorrowerId(), getCode(), getCreatorId(), getEndDate(), FF_Model::getId(), getMultiUse(), getStartDate(), getTransactionId(), and getUseDate().

FF_Model_OverrideCode::formatTimestamp (  $  in_timestamp  ) 
 

Formats a timestamp to a date

Parameters:
int $in_timestamp The timestamp
public
Returns:
string The date

Definition at line 500 of file Model/OverrideCode.php.

Referenced by getFormattedEndDate(), getFormattedStartDate(), and getFormattedUseDate().

FF_Model_OverrideCode::getBorrowerId (   ) 
 

Definition at line 476 of file Model/OverrideCode.php.

Referenced by exportToArray().

FF_Model_OverrideCode::getBorrowerName (   ) 
 

Gets the borrower name if a borrower id is set and it is valid

public

Returns:
mixed The borrower name or false if it is not found.

Definition at line 466 of file Model/OverrideCode.php.

References _initBorrowerDataAccess().

FF_Model_OverrideCode::getCode (   ) 
 

Definition at line 255 of file Model/OverrideCode.php.

Referenced by exportToArray(), and getLogEntryDescription().

FF_Model_OverrideCode::getCreatorId (   ) 
 

Definition at line 310 of file Model/OverrideCode.php.

Referenced by exportToArray().

FF_Model_OverrideCode::getCreatorName (   ) 
 

Gets the name of the creator

public

Returns:
string The user name of the creator

Definition at line 301 of file Model/OverrideCode.php.

References FF_DataAccess::factory().

FF_Model_OverrideCode::getEndDate (   ) 
 

Definition at line 370 of file Model/OverrideCode.php.

References $o_registry, and FF_Registry::singleton().

Referenced by exportToArray().

FF_Model_OverrideCode::getFormattedEndDate (   ) 
 

Gets a formatted end date

public

Returns:
string The end date

Definition at line 362 of file Model/OverrideCode.php.

References formatTimestamp().

Referenced by getLogEntryDescription().

FF_Model_OverrideCode::getFormattedMultiUse (   ) 
 

Definition at line 271 of file Model/OverrideCode.php.

References getMultiUse().

FF_Model_OverrideCode::getFormattedStartDate (   ) 
 

Gets a formatted start date

public

Returns:
string The start date

Definition at line 332 of file Model/OverrideCode.php.

References formatTimestamp().

Referenced by getLogEntryDescription().

FF_Model_OverrideCode::getFormattedUseDate (   ) 
 

Gets a formatted use date

public

Returns:
string The use date

Definition at line 400 of file Model/OverrideCode.php.

References formatTimestamp().

FF_Model_OverrideCode::getLogEntryDescription (  $  in_id  ) 
 

Gets the description of a override code for a log entry made by the override code module

Parameters:
int $in_id The id of the entry we are searching for
public
Returns:
mixed A description for the log or false on error.

Definition at line 182 of file Model/OverrideCode.php.

References getCode(), getFormattedEndDate(), and getFormattedStartDate().

FF_Model_OverrideCode::getMultiUse (   ) 
 

Definition at line 287 of file Model/OverrideCode.php.

Referenced by exportToArray(), and getFormattedMultiUse().

FF_Model_OverrideCode::getNewCode (   ) 
 

Gets a new override code and ensures it is unique.

public

Returns:
string The new override code

Definition at line 236 of file Model/OverrideCode.php.

References $o_registry, FF_Util::getRandomString(), and FF_Registry::singleton().

FF_Model_OverrideCode::getStartDate (   ) 
 

Definition at line 340 of file Model/OverrideCode.php.

Referenced by exportToArray().

FF_Model_OverrideCode::getTransactionId (   ) 
 

Definition at line 424 of file Model/OverrideCode.php.

Referenced by exportToArray().

FF_Model_OverrideCode::getUseDate (   ) 
 

Definition at line 408 of file Model/OverrideCode.php.

Referenced by exportToArray().

FF_Model_OverrideCode::importFromArray (  $  in_data  ) 
 

Imports an array of data (usually from the database) into the model's properties

Parameters:
array $in_data The data array
public
Returns:
void

Reimplemented from FF_Model.

Definition at line 132 of file Model/OverrideCode.php.

References setBorrowerId(), setCode(), setCreatorId(), setEndDate(), FF_Model::setId(), setMultiUse(), setStartDate(), setTransactionId(), and setUseDate().

FF_Model_OverrideCode::isCodeValid (  $  in_code,
$  in_borrowerId
) 
 

Determines if an override code can be used

Parameters:
string $in_code The override code
int $in_borrowerId The id of the borrower who used the code.
public
Returns:
bool True if it is valid, false otherwise

Definition at line 205 of file Model/OverrideCode.php.

FF_Model_OverrideCode::reset (   ) 
 

Retets the model's data properties to their initial values (usually null)

public

Returns:
void

Reimplemented from FF_Model.

Definition at line 109 of file Model/OverrideCode.php.

FF_Model_OverrideCode::setBorrowerId (  $  in_value  ) 
 

Definition at line 484 of file Model/OverrideCode.php.

Referenced by importFromArray(), and setBorrowerIdByBarcode().

FF_Model_OverrideCode::setBorrowerIdByBarcode (  $  in_barcode  ) 
 

Sets the borrower id by a borrower barcode.

Parameters:
string $in_barcode The borrower barcode
public
Returns:
void

Definition at line 448 of file Model/OverrideCode.php.

References $o_borrowerDataAccess, FF_DataAccess::factory(), and setBorrowerId().

FF_Model_OverrideCode::setCode (  $  in_value  ) 
 

Definition at line 263 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::setCreatorId (  $  in_value  ) 
 

Definition at line 318 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::setEndDate (  $  in_value  ) 
 

Definition at line 386 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::setMultiUse (  $  in_value  ) 
 

Definition at line 279 of file Model/OverrideCode.php.

References FF_Model::_scalarToBool().

Referenced by importFromArray().

FF_Model_OverrideCode::setStartDate (  $  in_value  ) 
 

Definition at line 348 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::setTransactionId (  $  in_value  ) 
 

Definition at line 432 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::setUseDate (  $  in_value  ) 
 

Definition at line 416 of file Model/OverrideCode.php.

Referenced by importFromArray().

FF_Model_OverrideCode::useCode (  $  in_code,
$  in_transactionId
) 
 

Updates a code's status as having been used.

Parameters:
string $in_code The override code
int $in_transactionId The transaction id
public
Returns:
bool True on success, false otherwise

Definition at line 222 of file Model/OverrideCode.php.

Member Data Documentation

FF_Model_OverrideCode::$borrowerId
 

Definition at line 86 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$code
 

Definition at line 50 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$creatorId
 

Definition at line 56 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$endDate
 

Definition at line 68 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$multiUse
 

Definition at line 98 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$o_borrowerDataAccess
 

Definition at line 92 of file Model/OverrideCode.php.

Referenced by setBorrowerIdByBarcode().

FF_Model_OverrideCode::$startDate
 

Definition at line 62 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$transactionId
 

Definition at line 80 of file Model/OverrideCode.php.

FF_Model_OverrideCode::$useDate
 

Definition at line 74 of file Model/OverrideCode.php.

The documentation for this class was generated from the following file:
Generated on Fri Jun 23 11:39:25 2006 for FastFrame by  doxygen 1.4.4