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

Source Location: /util/Criteria.php

Class Overview




Data object to describe a join between two tables, for example









        






Methods
























Class Details



[line 1625]

Data object to describe a join between two tables, for example

 table_a LEFT JOIN table_b ON table_a.id = table_b.a_id





[ Top ]








Class Methods




  

	
	
constructor __construct [line 1646]

	

    

    

		Join __construct(
leftColumn
$leftColumn, rightColumn
$rightColumn, [joinType
$joinType = null])
    

    


	
		Constructor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        leftColumn  
        $leftColumn  
        the left column of the join condition;         might contain an alias name
      

          

        rightColumn  
        $rightColumn  
        the right column of the join condition         might contain an alias name
      

          

        joinType  
        $joinType  
        the type of the join. Valid join types are         null (adding the join condition to the where clause),         Criteria::LEFT_JOIN(), Criteria::RIGHT_JOIN(), and Criteria::INNER_JOIN()
      

        

    


        
[ Top ]

  

  

	
	
method getJoinType [line 1657]

	

    

    

		the getJoinType(
)
    

    


	
		



Tags:





  

    return:  type of the join, i.e. Criteria::LEFT_JOIN(), ...,          or null for adding the join condition to the where Clause
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLeftColumn [line 1665]

	

    

    

		the getLeftColumn(
)
    

    


	
		



Tags:





  

    return:  left column of the join condition
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLeftColumnName [line 1670]

	

    

    

		void getLeftColumnName(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLeftTableName [line 1675]

	

    

    

		void getLeftTableName(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRightColumn [line 1683]

	

    

    

		the getRightColumn(
)
    

    


	
		



Tags:





  

    return:  right column of the join condition
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRightColumnName [line 1688]

	

    

    

		void getRightColumnName(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getRightTableName [line 1693]

	

    

    

		void getRightTableName(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method toString [line 1703]

	

    

    

		a toString(
)
    

    


	
		returns a String representation of the class,

mainly for debugging purposes





Tags:





  

    return:  String representation of the class
  

  

    access:  public
  









	
        
[ Top ]

  






        

		    

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