gyro/core/lib/interfaces/idbfieldrelation.cls.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * Interface for defining a relation between fields beeing part of a table relation 
00004  *  
00005  * We use terminology source and target here. Of course what is source and what is target depends on 
00006  * the perspective, so we could also call this A and B.
00007  * 
00008  * A field relation is defined for one field on source table that relates to one field on target table  
00009  * 
00010  * @author Gerd Riesselmann
00011  * @ingroup Interfaces
00012  */
00013 interface IDBFieldRelation {
00014         /**
00015          * Return source table name
00016          * 
00017          * @return string
00018          */     
00019         public function get_source_field_name();
00020 
00021         /**
00022          * Return target table name
00023          * 
00024          * @return string
00025          */     
00026         public function get_target_field_name();
00027         
00028         /**
00029          * Returns an IDBFieldRelation with source field as target field and vice versa
00030          *
00031          * @return IDBFieldRelation
00032          */
00033         public function reverse();
00034 }