creole.metadata
[ class tree: creole.metadata ] [ index: creole.metadata ] [ all elements ]
Packages:
creole
creole.common
creole.drivers.mssql
creole.drivers.mssql.metadata
creole.drivers.mysql
creole.drivers.mysql.metadata
creole.drivers.odbc
creole.drivers.odbc.metadata
creole.drivers.oracle
creole.drivers.oracle.metadata
creole.drivers.pgsql
creole.drivers.pgsql.metadata
creole.drivers.sqlite
creole.drivers.sqlite.metadata
creole.metadata
creole.util
creole.util.sql
jargon


Files:
ColumnInfo.php
DatabaseInfo.php
ForeignKeyInfo.php
IndexInfo.php
PrimaryKeyInfo.php
TableInfo.php

Classes:
ColumnInfo
DatabaseInfo
ForeignKeyInfo
IndexInfo
PrimaryKeyInfo
TableInfo

Class: ForeignKeyInfo

Source Location: /creole/metadata/ForeignKeyInfo.php

Class Overview




Represents a foreign key.




Author(s):






    
        

Version:


    
  
  • $Revision: 1.6 $
    • 










Methods
























Class Details



[line 30]

Represents a foreign key.





Tags:





  

    version:  $Revision: 1.6 $
  

  

    author:  Hans Lellelid <hans@xmpl.org>
  










[ Top ]








Class Methods



  

	
	
constructor __construct [line 38]

	

    

    

		ForeignKeyInfo __construct(
string
$name)
    

    


	
		




        
Parameters:

    

    

          

        string  
        $name  
        The name of the foreign key.
      

        

    


        
[ Top ]

  

  

	
	
method addReference [line 57]

	

    

    

		void addReference(
ColumnInfo
$local, ColumnInfo
$foreign)
    

    


	
		Adds a foreign-local mapping.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        ColumnInfo  
        $local  
        
      

          

        ColumnInfo  
        $foreign  
        
      

        

    


        
[ Top ]

  

  

	
	
method getName [line 47]

	

    

    

		string getName(
)
    

    


	
		Get foreign key name.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getReferences [line 66]

	

    

    

		array getReferences(
)
    

    


	
		Gets the local-foreign column mapping.





Tags:





  

    return:  array( [0] => array([0] => local ColumnInfo object, [1] => foreign ColumnInfo object) )
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method toString [line 74]

	

    

    

		string toString(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 23 Aug 2004 21:51:30 -0400 by phpDocumentor 1.3.0RC3