Count the number of record according to the search results set before.
It ignores limit setting
API Tags:
| Return: | number of records |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::Count()
- Count the number of record according to the search results set before.
boolean DeleteRecord(
array
$recArr
)
|
|
Delete current record or delete the given input record
Parameters:
|
array |
$recArr: |
- associated array whose keys are field names of this BizDataObj |
API Tags:
| Return: | - if return false, the caller can call GetErrorMessage to get the error. |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::DeleteRecord()
- Delete current record or delete the given input record
Redefined in descendants as:
array DirectFetch(
[string
$searchRule = ""], [int
$count = -1], [int
$offset = 0]
)
|
|
Fetches SQL result rows as a sequential array without using query rules set before.
Parameters:
|
string |
$searchRule: |
the search rule string |
|
int |
$count: |
number of records to return |
|
int |
$offset: |
the starting point of the return records |
API Tags:
| Return: | array of records |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::DirectFetch()
- Fetches SQL result rows as a sequential array without using query rules set before.
Fetches SQL result rows as a sequential array according the query rules set before.
API Tags:
| Return: | array of records |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::Fetch()
- Fetches SQL result rows as a sequential array according the query rules set before.
array FetchById(
mixed
$id
)
|
|
Fetch record by Id
API Tags:
| Return: | record array |
| Access: | public |
boolean FetchRecords(
$searchRule
$searchRule, $resultRecord
&$resultRecords, [$recNum
$count = -1], [$clearSearchRule
$offset = 0], [$noAssociation
$clearSearchRule = true], [mixed
$noAssociation = false]
)
|
|
Run query and get the query results without affecting DataObject internal state by default it gets number of records starting from the first row.
if pageNum > 0, it gets number of records starting from the first row of the page
Parameters:
|
$searchRule |
$searchRule: |
search rule applied on the query |
|
$resultRecord |
&$resultRecords: |
returned result record array |
|
$recNum |
$count: |
number of records to be returned. if -1, all query results returned |
|
$clearSearchRule |
$offset: |
indicates if search rule need to be cleared before query |
|
$noAssociation |
$clearSearchRule: |
indicates if current association condition is not used in query |
API Tags:
| Return: | - if return false, the caller can call GetErrorMessage to get the error. |
| Access: | public |
Do the search query and return results set as PDOStatement
API Tags:
| Return: | PDO statement object |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::Find()
- Do the search query and return results set as PDOStatement
Get the active record
API Tags:
| Return: | - record array |
| Access: | public |
Get error fields
API Tags:
string GetErrorMessage(
)
|
|
Get the error message caused by data action
API Tags:
| Return: | the error message string |
| Access: | public |
Get the BizField object
Parameters:
|
string |
$fieldName: |
field name |
API Tags:
| Return: | BizField object |
| Access: | public |
BizField GetFieldNameByColumn(
string
$column
)
|
|
Get field name by column
Parameters:
|
string |
$column: |
column name |
API Tags:
| Return: | BizField object |
| Access: | public |
string GetFieldValue(
string
$fieldName
)
|
|
Get the BizField value
Parameters:
|
string |
$fieldName: |
field name |
API Tags:
| Return: | BizField value |
| Access: | public |
boolean InsertRecord(
array
$recArr
)
|
|
Insert record using given input record array
Parameters:
|
array |
$recArr: |
- associated array whose keys are field names of this BizDataObj |
API Tags:
| Return: | - if return false, the caller can call GetErrorMessage to get the error. |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::InsertRecord()
- Insert record using given input record array
Redefined in descendants as:
Create an empty new record
API Tags:
| Return: | - empty record array with default values |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::NewRecord()
- Create an new (empty) record
Redefined in descendants as:
void SetActiveRecord(
array
$currentRecord
)
|
|
Set the current working record values
Parameters:
|
array |
$currentRecord: |
record array |
API Tags:
void SetActiveRecordId(
$recordId
$recordId
)
|
|
Set the active record according to the record id
Parameters:
|
$recordId |
$recordId: |
record id |
API Tags:
boolean UpdateRecord(
array
$recArr, [array
$oldRec = null]
)
|
|
Update record using given input record array
Parameters:
|
array |
$recArr: |
- associated array whose keys are field names of this BizDataObj |
|
array |
$oldRec: |
- associated array who is the old record field name / value pairs |
API Tags:
| Return: | - if return false, the caller can call GetErrorMessage to get the error. |
| Access: | public |
Redefinition of:
- BizDataObj_Abstract::UpdateRecord()
- Update record using given input record array
Redefined in descendants as:
Validate user input data and trigger error message and adjust BizField if invalid.
API Tags:
Redefined in descendants as:
array _fetch_record(
mixed
&$resultSet
)
|
|
Get record from result setand move the cursor to next row
API Tags:
| Return: | record array |
| Access: | protected |
PDOStatement _run_search(
[array
$limit = null]
)
|
|
Run query with current search rule and returns PDO statement
Parameters:
|
array |
$limit: |
- if limit is not null, do the limit search |
API Tags:
