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: BaseObject

Source Location: /om/BaseObject.php

Class Overview




This class contains attributes and methods that are used by all  business objects within the system.




Author(s):






                
        

Version:


    
  
  • $Revision: 621 $
    • 



        




Variables







Methods
























Class Details



[line 33]

This class contains attributes and methods that are used by all  business objects within the system.





Tags:





  

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

  

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

  

    author:  Frank Y. Kim <frank.kim@clearink.com> (Torque)
  

  

    version:  $Revision: 621 $
  

  

    abstract:  
  










[ Top ]







Class Variables



	
	

	
$modifiedColumns = array()

	
[line 52]

  The columns that have been modified in current object.

Tracking modified columns allows us to only update modified columns.





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods




  

	
	
method equals [line 152]

	

    

    

		Whether equals(
obj
$obj)
    

    


	
		Compares this with another 
  1. BaseObject
    2. 

 instance.  If  
  1. obj
    2. 

 is an instance of 
  1. BaseObject
    2. 

, delegates to  
  1. equals(BaseObject)
    2. 

.  Otherwise, returns 
  1. false
    2. 

.





Tags:





  

    return:  equal to the object specified.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        obj  
        $obj  
        The object to compare to.
      

        

    


        
[ Top ]

  

  

	
	
method getModifiedColumns [line 79]

	

    

    

		array getModifiedColumns(
)
    

    


	
		Get the columns that have been modified in this object.





Tags:





  

    return:  A unique list of the modified column names for this object.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hashCode [line 174]

	

    

    

		int hashCode(
)
    

    


	
		If the primary key is not 
  1. null
    2. 

, return the hashcode of the  primary key.  Otherwise calls 
  1. Object.hashCode()
    2. 

.





Tags:





  

    return:  Hashcode
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isColumnModified [line 70]

	

    

    

		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 111]

	

    

    

		boolean isDeleted(
)
    

    


	
		Whether this object has been deleted.





Tags:





  

    return:  The deleted state of this object.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isModified [line 59]

	

    

    

		boolean isModified(
)
    

    


	
		Returns whether the object has been modified.





Tags:





  

    return:  True if the object has been modified.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isNew [line 91]

	

    

    

		true, 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:  if the object has never been persisted.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method log [line 190]

	

    

    

		boolean log(
string
$msg, [int
$priority = Propel::LOG_INFO])
    

    


	
		Logs a message using Propel::log().





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        string  
        $msg  
        
      

          

        int  
        $priority  
        One of the Propel::LOG_* logging levels
      

        

    


        
[ Top ]

  

  

	
	
method resetModified [line 131]

	

    

    

		void resetModified(
[string
$col = null])
    

    


	
		Sets the modified state for the object to be false.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $col  
        If supplied, only the specified column is reset.
      

        

    


        
[ Top ]

  

  

	
	
method setDeleted [line 121]

	

    

    

		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 102]

	

    

    

		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 ]

  






        

		    

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