propel-om
[ class tree: propel-om ] [ index: propel-om ] [ all elements ]
Packages:
propel
propel-adapter
propel-logger
propel-map
propel-om
propel-util
propel-validator


Files:
BaseObject.php
NestedSetRecursiveIterator.php
NodeObject.php
Persistent.php
PreOrderNodeIterator.php

Interfaces:
NodeObject
Persistent
Classes:
BaseObject
NestedSetRecursiveIterator
PreOrderNodeIterator

Class: Persistent

Source Location: /om/Persistent.php

Interface Overview




This interface defines methods related to saving an object




Author(s):






                
    

Version:


    
  
  • $Revision: 713 $
    • 



        






Methods
























Class Details



[line 31]

This interface defines methods related to saving an object





Tags:





  

    author:  Hans Lellelid <hans@xmpl.org> (Propel)
  

  

    author:  John D. McNally <jmcnally@collab.net> (Torque)
  

  

    author:  Fedor K. <fedor@apache.org> (Torque)
  

  

    version:  $Revision: 713 $
  










[ Top ]








Class Methods




  

	
	
method delete [line 109]

	

    

    

		void delete(
[
$con = null])
    

    


	
		Deletes the object.





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PropelPDO  
        $con  
        
      

        

    


        
[ Top ]

  

  

	
	
method getPrimaryKey [line 38]

	

    

    

		ObjectKey getPrimaryKey(
)
    

    


	
		getter for the object primaryKey.





Tags:





  

    return:  the object primaryKey as an Object
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isColumnModified [line 64]

	

    

    

		boolean isColumnModified(
string
$col)
    

    


	
		Has specified column been modified?





Tags:





  

    return:  True if $col has been modified.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $col  
        
      

        

    


        
[ Top ]

  

  

	
	
method isDeleted [line 94]

	

    

    

		boolean isDeleted(
)
    

    


	
		Whether this object has been deleted.





Tags:





  

    return:  The deleted state of this object.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isModified [line 56]

	

    

    

		boolean isModified(
)
    

    


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





Tags:





  

    return:  True if the object has been modified.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isNew [line 73]

	

    

    

		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.





Tags:





  

    return:  True, if the object has never been persisted.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method resetModified [line 88]

	

    

    

		void resetModified(
)
    

    


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





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method save [line 117]

	

    

    

		void save(
[
$con = null])
    

    


	
		Saves the object.





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PropelPDO  
        $con  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDeleted [line 101]

	

    

    

		void setDeleted(
boolean
$b)
    

    


	
		Specify whether this object has been deleted.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $b  
        The deleted state of this object.
      

        

    


        
[ Top ]

  

  

	
	
method setNew [line 81]

	

    

    

		void setNew(
boolean
$b)
    

    


	
		Setter for the isNew attribute.  This method will be called  by Propel-generated children and Peers.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $b  
        the state of the object.
      

        

    


        
[ Top ]

  

  

	
	
method setPrimaryKey [line 47]

	

    

    

		void setPrimaryKey(
mixed
$primaryKey)
    

    


	
		Sets the PrimaryKey for the object.





Tags:





  

    throws:  Exception, This method might throw an exceptions
  

  

    access:  public
  









	
        
Parameters:

    

    

          

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

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 22 Nov 2007 03:33:48 +0000 by phpDocumentor 1.4.0