Interface

Persistent

interface Persistent

This interface defines methods related to saving an object

Methods

ObjectKey getPrimaryKey()

getter for the object primaryKey.
void setPrimaryKey(mixed $primaryKey)

Sets the PrimaryKey for the object.
boolean isModified()

Returns whether the object has been modified, since it was last retrieved from storage.
boolean isColumnModified(string $col)

Has specified column been modified?
boolean isNew()

Returns whether the object has ever been saved.
setNew(boolean $b)

Setter for the isNew attribute.
void resetModified()

Resets (to false) the "modified" state for this object.
boolean isDeleted()

Whether this object has been deleted.
void setDeleted(boolean $b)

Specify whether this object has been deleted.
void delete(PropelPDO $con = null)

Deletes the object.
void save(PropelPDO $con = null)

Saves the object.

Details

at line 28
public ObjectKey getPrimaryKey()

getter for the object primaryKey.

Return Value

ObjectKey the object primaryKey as an Object

at line 38
public void setPrimaryKey(mixed $primaryKey)

Sets the PrimaryKey for the object.

Parameters

mixed $primaryKey The new PrimaryKey object or string (result of PrimaryKey.toString()).

Return Value

void

Exceptions

Exception, This method might throw an exceptions

at line 46
public boolean isModified()

Returns whether the object has been modified, since it was last retrieved from storage.

Return Value

boolean True if the object has been modified.

at line 55
public boolean isColumnModified(string $col)

Has specified column been modified?

Parameters

string $col

Return Value

boolean True if $col has been modified.

at line 64
public boolean isNew()

Returns whether the object has ever been saved.

This will be false, if the object was retrieved from storage or was created and then saved.

Return Value

boolean True, if the object has never been persisted.

at line 72
public setNew(boolean $b)

Setter for the isNew attribute.

This method will be called by Propel-generated children and Peers.

Parameters

boolean $b the state of the object.

at line 79
public void resetModified()

Resets (to false) the "modified" state for this object.

Return Value

void

at line 86
public boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

at line 95
public void setDeleted(boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

at line 105
public void delete(PropelPDO $con = null)

Deletes the object.

Parameters

PropelPDO $con

Return Value

void

Exceptions

Exception

at line 115
public void save(PropelPDO $con = null)

Saves the object.

Parameters

PropelPDO $con

Return Value

void

Exceptions

Exception