FF_DataAccess_Borrower_mysql Class Reference

Inheritance diagram for FF_DataAccess_Borrower_mysql:

List of all members.

Public Member Functions
	FF_DataAccess_Borrower_mysql ()
	update ($in_data)
	add ($in_data)
	remove ($in_borrowerId)
	getListFilter ($in_searchString, $in_searchFields, $in_filter, $in_filterData)
	getDataByPrimaryKey ($in_id, $in_fields= '*')
&	getDataToExport ($in_fields, $in_borrowers)
	getBorrowerIdByBarcode ($in_barcode)
	getBorrowerName ($in_borrowerId)
	isProfileIdUnique ($in_profileId, $in_id, $in_isUpdate)
	getIdByProfileId ($in_profileId)
&	updateAttributes ($in_borrowerId, $in_attributes)
	getNextId ()
Public Attributes
	$o_log
	$attributesTable
	$userId
	$filterName

---

Detailed Description

Definition at line 47 of file DataAccess/mysql/Borrower.php.

---

Constructor & Destructor Documentation

FF_DataAccess_Borrower_mysql::FF_DataAccess_Borrower_mysql (   )

Initialize any needed class variables public Returns: void Definition at line 82 of file DataAccess/mysql/Borrower.php. References FF_DataAccess::FF_DataAccess(), and FF_Auth::getCredential().

---

Member Function Documentation

FF_DataAccess_Borrower_mysql::add (  $  in_data  )

Adds a new row to the table Parameters: array  $in_data The array of data to add public Returns: object The result object Reimplemented from FF_DataAccess. Definition at line 136 of file DataAccess/mysql/Borrower.php. References $o_result, and updateAttributes(). Referenced by update().

FF_DataAccess_Borrower_mysql::getBorrowerIdByBarcode (  $  in_barcode  )

Gets the borrower id based on their barcode Parameters: string  $in_barcode The barcode to search for public Returns: int The borrower id Definition at line 301 of file DataAccess/mysql/Borrower.php. References $s_query.

FF_DataAccess_Borrower_mysql::getBorrowerName (  $  in_borrowerId  )

Gets the borrower name Parameters: int  $in_borrowerId The borrower to search for public Returns: string The borrower name Definition at line 318 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::getDataByPrimaryKey (  $  in_id, $  in_fields = '*' )

Gets one row of data based on the primary key of the table. Also gets all of the attributes data. Parameters: int  $in_id The primary key value string  $in_fields (optional) The fields to select (default is all fields) public Returns: array The array of data or empty array if not found Reimplemented from FF_DataAccess. Definition at line 234 of file DataAccess/mysql/Borrower.php. References $a_data, and $s_query.

& FF_DataAccess_Borrower_mysql::getDataToExport (  $  in_fields, $  in_borrowers )

Returns a data result object of the data to be exported Parameters: array  $in_fields The fields to export array  $in_borrowers Array of borrower barcodes public Returns: object The result object Definition at line 257 of file DataAccess/mysql/Borrower.php. References $s_query.

FF_DataAccess_Borrower_mysql::getIdByProfileId (  $  in_profileId  )

Gets the borrower id based on the passed in user/profile id. Parameters: int  $in_profileId The profile id public Returns: mixed The borrower id if found, false otherwise Definition at line 353 of file DataAccess/mysql/Borrower.php. References $s_query.

FF_DataAccess_Borrower_mysql::getListFilter (  $  in_searchString, $  in_searchFields, $  in_filter, $  in_filterData )

Handles the list filters as well as all functionality of the parent method. Parameters: string  $in_searchString The string to search for array  $in_searchFields The array of fields to search. string  $in_filter The name of a additional filters to apply in case the list needs to be further limited. array  $in_filterData Any associated data or flags that go with the filter. public Returns: string A WHERE condition for the list data Reimplemented from FF_DataAccess. Definition at line 203 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::getNextId (   )

Gets the next id available in the sequence table public Returns: int The next id Reimplemented from FF_DataAccess. Definition at line 408 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::isProfileIdUnique (  $  in_profileId, $  in_id, $  in_isUpdate )

Checks to see if the profile id is unique among borrowers that have not been deleted. Parameters: string  $in_profileId The profile id int  $in_id The borrower id bool  $in_isUpdate Is this an update? public Returns: bool True if it is unique, false otherwise Definition at line 336 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::remove (  $  in_borrowerId  )

Marks the item as deleted in the table Parameters: string  $in_borrowerId The borrower id public Returns: object Result object Definition at line 169 of file DataAccess/mysql/Borrower.php. References $o_fileCache, $o_result, $result, and FF_FileCache::singleton().

FF_DataAccess_Borrower_mysql::update (  $  in_data  )

Updates a row that already exists in the table Parameters: array  $in_data The new data to update public Returns: object The Result object Reimplemented from FF_DataAccess. Definition at line 104 of file DataAccess/mysql/Borrower.php. References $o_result, add(), and updateAttributes().

& FF_DataAccess_Borrower_mysql::updateAttributes (  $  in_borrowerId, $  in_attributes )

Updates the attributes for a user Parameters: int  $in_borrowerId The borrower id array  $in_attributes The array of attributes in form of key => value public Returns: object The result object Definition at line 371 of file DataAccess/mysql/Borrower.php. References $o_result. Referenced by add(), and update().

---

Member Data Documentation

FF_DataAccess_Borrower_mysql::$attributesTable

Definition at line 60 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::$filterName

Definition at line 72 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::$o_log

Definition at line 54 of file DataAccess/mysql/Borrower.php.

FF_DataAccess_Borrower_mysql::$userId

Definition at line 66 of file DataAccess/mysql/Borrower.php.

---

The documentation for this class was generated from the following file:

• DataAccess/mysql/Borrower.php

---