Class: Doctrine_Import_Builder

Source Location: /Doctrine/Import/Builder.php

Class Doctrine_Import_Builder

Class Overview
Class Overview | Descendants | Properties Summary | Properties Detail | Method Summary | Methods Detail

Doctrine_Import_Builder Import builder is responsible of building Doctrine ActiveRecord classes based on a database schema.

Located in /Doctrine/Import/Builder.php [line 37] 



		
				Author(s):
		
		
		
Information Tags:



						
Version:  $Revision: 2051 $

				
Link:  www.phpdoctrine.com

				
Since:  1.0

				
License:  LGPL

	

				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	




	
	

		
Direct descendents

		

			Class Overview |
							Descendents
				|															Properties Summary | Properties Detail
						|											Method Summary | Methods Detail
			            						

		

			

				

					Child Class
					Description
				

								

					Doctrine_Import_Builder_BaseClass
					
											class Doctrine_Import_Builder_BaseClass  Builds a Doctrine_Record base class definition based on a schema.
										
				

							

			
[ Top ]

		

	




	
	

		
Property Summary

		

			Class Overview |
							Descendents |
									Property Summary | Properties Detail
												Method Summary | Methods Detail
											    				

		

			

			

					

					

					

																						
static mixed  
					$tpl  
					

				
																
string  
					$path  
					

				
													
mixed  
					$suffix  
					

				
																

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview |
							Descendents |
																		Properties Summary | Properties Detail
											    					Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

																																																																																
Doctrine_Import_Builder  
										__construct()  
					

				
																
void  
										buildColumnDefinition()  
					

				
																
void  
										buildDefinition()  
					

				
																
void  
										buildRecord()  
					

				
																
void  
										buildRelationDefinition()  
					

				
																
string  
										getTargetPath()  
					getTargetPath

				
																
void  
										loadTemplate()  
					This is a template that was previously in Builder/Record.tpl. Due to the fact  that it was not bundled when compiling, it had to be moved here.

				
																
void  
										setTargetPath()  
					setTargetPath

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview |
							Descendents |
													Property Summary | Properties Detail
			
							|
									Method Summary | Methods Detail
												

		

			



	

		
			static mixed  
			$tpl
						[line 46]
		
	


		API Tags:



  

    Access:  private
  







	
		

	
[ Top ]







	

		
			string  
			$path
			 =  ''			[line 42]
		
	


		API Tags:



  

    Access:  private
  







	
		

	
[ Top ]







	

		
			mixed  
			$suffix
			 =  '.php'			[line 44]
		
	


		API Tags:



  

    Access:  private
  







	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview |
							Descendents
									                |
									Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor __construct  [line 48]





	

    

    
 
		Doctrine_Import_Builder __construct(
)
    

    



	
	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	buildColumnDefinition  [line 113]





	

    

    
 
		void buildColumnDefinition(

$tableColumns 
)
    

    



	
			Parameters:

			

					

				array  
				
				$tableColumns: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	buildDefinition  [line 211]





	

    

    
 
		void buildDefinition(

$options, 
$columns, [
$relations = array()] 
)
    

    



	
			Parameters:

			

					

				array  
				
				$options: 
				
							

					

				array  
				
				$columns: 
				
							

					

				array  
				
				$relations: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	buildRecord  [line 226]





	

    

    
 
		void buildRecord(

$options, 
$columns, 
$relations 
)
    

    



	
			Parameters:

			

					

				  
				
				$options: 
				
							

					

				  
				
				$columns: 
				
							

					

				  
				
				$relations: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	buildRelationDefinition  [line 165]





	

    

    
 
		void buildRelationDefinition(

$relations 
)
    

    



	
			Parameters:

			

					

				array  
				
				$relations: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	getTargetPath  [line 72]





	

    

    
 
		string getTargetPath(
)
    

    



	
getTargetPath



	

	API Tags:



  

    Return:  the path where imported files are being generated
  

  

    Access:  public
  







		
		

	
[ Top ]









	loadTemplate  [line 83]





	

    

    
 
		void loadTemplate(
)
    

    



	
This is a template that was previously in Builder/Record.tpl. Due to the fact  that it was not bundled when compiling, it had to be moved here.



	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	setTargetPath  [line 59]





	

    

    
 
		void setTargetPath(
string
$path 
)
    

    



	
setTargetPath



			Parameters:

			

					

				string  
				
				$path: 
				
				 path   the path where imported files are being generated			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]