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


Files:
BasePeer.php
Criteria.php
NodePeer.php
PropelColumnTypes.php
PropelDateTime.php
PropelPager.php
PropelPDO.php

Interfaces:
NodePeer
Classes:
BasePeer
Criteria
Criterion
CriterionIterator
Join
PropelColumnTypes
PropelDateTime
PropelPager
PropelPDO

Class: Criterion

Source Location: /util/Criteria.php

Class Overview




This is an "inner" class that describes an object in the criteria.




Author(s):






    

        





Constants






Methods
























Class Details



[line 1144]

This is an "inner" class that describes an object in the criteria.

In Torque this is an inner class of the Criteria class.





Tags:





  

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










[ Top ]








Class Methods




  

	
	
constructor __construct [line 1192]

	

    

    

		Criterion __construct(
Criteria
$outer, string
$column, mixed
$value, [string
$comparison = null], Criteria
$parent)
    

    


	
		Create a new instance.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Criteria  
        $parent  
        The outer class (this is an "inner" class).
      

          

        string  
        $column  
        TABLE.COLUMN format.
      

          

        mixed  
        $value  
        
      

          

        string  
        $comparison  
        
      

          

        Criteria  
        $outer  
        
      

        

    


        
[ Top ]

  

  

	
	
method addAnd [line 1344]

	

    

    

		void addAnd(
Criterion
$criterion)
    

    


	
		Append an AND Criterion onto this Criterion's list.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Criterion  
        $criterion  
        
      

        

    


        
[ Top ]

  

  

	
	
method addOr [line 1355]

	

    

    

		Criterion addOr(
Criterion
$criterion)
    

    


	
		Append an OR Criterion onto this Criterion's list.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Criterion  
        $criterion  
        
      

        

    


        
[ Top ]

  

  

	
	
method appendPsTo [line 1373]

	

    

    

		void appendPsTo(
string
&$sb, 
&$params, array
$params)
    

    


	
		Appends a Prepared Statement representation of the Criterion  onto the buffer.





Tags:





  

    throws:  PropelException - if the expression builder cannot figure out how to turn a specified                            expression into proper SQL.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        &$sb  
        The stringbuffer that will receive the Prepared Statement
      

          

        array  
        $params  
        A list to which Prepared Statement parameters  will be appended
      

          

        array  
        &$params  
        
      

        

    


        
[ Top ]

  

  

	
	
method equals [line 1500]

	

    

    

		boolean equals(

$obj)
    

    


	
		This method checks another Criteria to see if they contain  the same attributes and hashtable entries.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $obj  
        
      

        

    


        
[ Top ]

  

  

	
	
method getAllTables [line 1571]

	

    

    

		array getAllTables(
)
    

    


	
		Get all tables from nested criterion objects





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAttachedCriterion [line 1596]

	

    

    

		array getAttachedCriterion(
)
    

    


	
		get an array of all criterion attached to this

recursing through all sub criterion





Tags:





  

    return:  Criterion[]
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getColumn [line 1230]

	

    

    

		string getColumn(
)
    

    


	
		Get the column name.





Tags:





  

    return:  A String with the column name.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getComparison [line 1261]

	

    

    

		string getComparison(
)
    

    


	
		Get the comparison.





Tags:





  

    return:  A String with the comparison.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getConjunctions [line 1336]

	

    

    

		array getConjunctions(
)
    

    


	
		Get the list of conjunctions in this Criterion





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDB [line 1282]

	

    

    

		DBAdapter getDB(
)
    

    


	
		Get the value of db.

The DBAdapter which might be used to get db specific  variations of sql.





Tags:





  

    return:  value of db.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTable [line 1251]

	

    

    

		string getTable(
)
    

    


	
		Get the table name.





Tags:





  

    return:  A String with the table name.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getValue [line 1271]

	

    

    

		mixed getValue(
)
    

    


	
		Get the value.





Tags:





  

    return:  An Object with the value.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method hashCode [line 1540]

	

    

    

		void hashCode(
)
    

    


	
		Returns a hash code value for the object.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method init [line 1204]

	

    

    

		void init(
Criteria
$criteria)
    

    


	
		Init some properties with the help of outer class





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Criteria  
        $criteria  
        The outer class
      

        

    


        
[ Top ]

  

  

	
	
method isIgnoreCase [line 1318]

	

    

    

		boolean isIgnoreCase(
)
    

    


	
		Is ignore case on or off?





Tags:





  

    return:  True if case is ignored.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setDB [line 1293]

	

    

    

		void setDB(

$v)
    

    


	
		Set the value of db.

The DBAdapter might be used to get db specific variations of sql.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        DBAdapter  
        $v  
        Value to assign to db.
      

        

    


        
[ Top ]

  

  

	
	
method setIgnoreCase [line 1307]

	

    

    

		Criterion setIgnoreCase(
boolean
$b)
    

    


	
		Sets ignore case.





Tags:





  

    return:  A modified Criterion object.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $b  
        True if case should be ignored.
      

        

    


        
[ Top ]

  

  

	
	
method setTable [line 1241]

	

    

    

		void setTable(
name
$name)
    

    


	
		Set the table name.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        name  
        $name  
        A String with the table name.
      

        

    


        
[ Top ]

  









Class Constants



	
	

	
ODER =  " OR "

	
[line 1147]

  
  

	
[ Top ]


	
	

	
UND =  " AND "

	
[line 1146]

  
  

	
[ Top ]






        

		    

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