Class: Doctrine_Record_Filter

Source Location: /Doctrine/Record/Filter.php

Class Doctrine_Record_Filter

Class Overview

Doctrine_Record_Filter Filters and prepares the record data

Located in /Doctrine/Record/Filter.php [line 34]

Doctrine_Object
   |
   --Doctrine_Record_Filter
Author(s): Information Tags:
Version:  $Revision: 1298 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Object

Doctrine_Object::$_null

Inherited From Doctrine_Object

Doctrine_Object::getNullObject()
getNullObject returns the null object associated with this object
Doctrine_Object::initNullObject()
initNullObject initializes the null object

[ Top ]
Property Summary
Method Summary
Doctrine_Record_Filter   __construct()   constructor
boolean   assignDefaultValues()   setDefaultValues sets the default values for records internal data
array   getPrepared()   getPrepared
Doctrine_Record   getRecord()   getRecord
void   prepareIdentifiers()   prepareIdentifiers prepares identifiers for later use

[ Top ]
Properties
Doctrine_Record   $_record [line 39]
API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 45]

  Doctrine_Record_Filter __construct( Doctrine_Record $record, Doctrine_Record $_record  )

constructor

Parameters:
Doctrine_Record   $_record:  the record object this filter belongs to
Doctrine_Record   $record: 

API Tags:
Access:  public


[ Top ]
assignDefaultValues  [line 65]

  boolean assignDefaultValues( $data, [boolean $overwrite = false]  )

setDefaultValues sets the default values for records internal data

Parameters:
boolean   $overwrite:  whether or not to overwrite the already set values
   $data: 

API Tags:
Access:  public


[ Top ]
getPrepared  [line 122]

  array getPrepared( [ $array = array()]  )

getPrepared

returns an array of modified fields and values with data preparation adds column aggregation inheritance and converts Records into primary key values

Parameters:
array   $array: 

API Tags:
Access:  public


[ Top ]
getRecord  [line 54]

  Doctrine_Record getRecord( )

getRecord


API Tags:
Return:  the record object this filter belongs to
Access:  public


[ Top ]
prepareIdentifiers  [line 95]

  void prepareIdentifiers( [boolean $exists = true]  )

prepareIdentifiers prepares identifiers for later use

Parameters:
boolean   $exists:  whether or not this record exists in persistent data store

API Tags:
Access:  private


[ Top ]