modules/ModuleBuilder/parsers/relationships/OneToOneRelationship.php

Show:

inherited

Classes
- \OneToOneRelationship

Table of Contents

\OneToOneRelationship
jump to top

Package:

Parent(s): \AbstractRelationship

Properties


                 $definition= ''

inheritedInherited from: \AbstractRelationship::$$definition

Details

Type: n/a
Inherited_from: \AbstractRelationship::$$definition


                 $definitionKeys= 'array ( 
        // atttributes of this relationship - here in the definition so they are preserved across saves and loads
        'for_activities',
    	'is_custom',
        'from_studio',
        'readonly' , // a readonly relationship cannot be Built by subclasses of AbstractRelationships
        'deleted' , // a deleted relationship will not be built, and if it had been built previously the built relationship will be removed
        'relationship_only' , // means that we won't build any UI components for this relationship - required while the Subpanel code is restricted to one subpanel only from any module, and probably useful afterwards also for developers to build relationships for new code - it's a feature!
        // keys not found in Relationships table
        'label' , // optional
        'rhs_label', // optional
        'lhs_label', // optional
        'lhs_subpanel' , // subpanel FROM the lhs_module to display on the rhs_module detail view
        'rhs_subpanel' , // subpanel FROM the rhs_module to display on the lhs_module detail view
        // keys from Relationships table
        'relationship_name' ,
        'lhs_module' , 
        'lhs_table' , 
        'lhs_key' , 
        'rhs_module' , 
        'rhs_table' , 
        'rhs_key' , 
        'join_table' , 
        'join_key_lhs' , 
        'join_key_rhs' , 
        'relationship_type' , 
        'relationship_role_column' , 
        'relationship_role_column_value' , 
        'reverse' )'

staticinheritedInherited from: \AbstractRelationship::$$definitionKeys

Default value

array ( 
        // atttributes of this relationship - here in the definition so they are preserved across saves and loads
        'for_activities',
    	'is_custom',
        'from_studio',
        'readonly' , // a readonly relationship cannot be Built by subclasses of AbstractRelationships
        'deleted' , // a deleted relationship will not be built, and if it had been built previously the built relationship will be removed
        'relationship_only' , // means that we won't build any UI components for this relationship - required while the Subpanel code is restricted to one subpanel only from any module, and probably useful afterwards also for developers to build relationships for new code - it's a feature!
        // keys not found in Relationships table
        'label' , // optional
        'rhs_label', // optional
        'lhs_label', // optional
        'lhs_subpanel' , // subpanel FROM the lhs_module to display on the rhs_module detail view
        'rhs_subpanel' , // subpanel FROM the rhs_module to display on the lhs_module detail view
        // keys from Relationships table
        'relationship_name' ,
        'lhs_module' , 
        'lhs_table' , 
        'lhs_key' , 
        'rhs_module' , 
        'rhs_table' , 
        'rhs_key' , 
        'join_table' , 
        'join_key_lhs' , 
        'join_key_rhs' , 
        'relationship_type' , 
        'relationship_role_column' , 
        'relationship_role_column_value' , 
        'reverse' )

Details

Type: n/a
Inherited_from: \AbstractRelationship::$$definitionKeys

Methods

__construct(
           $definition
          )
        
        :
          void

Parameters

Name	Type	Description
$definition

buildFieldsToLayouts(
          
          )
        
        :
          void

buildLabels(
           $update
              =
              false
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::buildLabels()

Parameters

Name	Type	Description
$update

buildRelationshipMetaData(
          
          )
        
        :
          void

buildVardefs(
          
          )
        
        :
          void

delete(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::delete()

deleted(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::deleted()

getActivitiesSubModuleRelationshipName(
           $activitiesSubModuleName
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getActivitiesSubModuleRelationshipName()

Parameters

Name	Type	Description
$activitiesSubModuleName

getDefinition(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getDefinition()

getIDName(
           $sourceModule
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getIDName()

Parameters

Name	Type	Description
$sourceModule

getJoinKeyLHS(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getJoinKeyLHS()

getJoinKeyRHS(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getJoinKeyRHS()

getLabels(
          
          )
        
        :
          array

inherited

Returns a key=>value set of labels used in this relationship for use when desplaying the relationship in MB

Inherited from: \AbstractRelationship::getLabels()

Returns

Type	Description
array	labels used in this relationship

getLeftModuleSystemLabel(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getLeftModuleSystemLabel()

getLink2FieldDefinition(
           $sourceModule,  $relationshipName,  $right_side
              =
              false,  $vname
              =
              ""
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getLink2FieldDefinition()

Parameters

Name	Type	Description
$sourceModule
$relationshipName
$right_side
$vname

getLinkFieldDefinition(
           $sourceModule,  $relationshipName,  $right_side
              =
              false,  $vname
              =
              "",  $id_name
              =
              false
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getLinkFieldDefinition()

Parameters

Name	Type	Description
$sourceModule
$relationshipName
$right_side
$vname
$id_name

getName(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getName()

getRelateFieldDefinition(
           $sourceModule,  $relationshipName,  $vnameLabel
              =
              ''
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getRelateFieldDefinition()

Parameters

Name	Type	Description
$sourceModule
$relationshipName
$vnameLabel

getRelationshipMetaData(
           $relationshipType,  $checkExisting
              =
              true
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getRelationshipMetaData()

Parameters

Name	Type	Description
$relationshipType
$checkExisting

getRightModuleSystemLabel(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getRightModuleSystemLabel()

getSubpanelDefinition(
           $relationshipName,  $sourceModule,  $subpanelName,  $titleKeyName
              =
              '',  $source
              =
              ""
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getSubpanelDefinition()

Parameters

Name	Type	Description
$relationshipName
$sourceModule
$subpanelName
$titleKeyName
$source

getTablename(
           $moduleName
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getTablename()

Parameters

Name	Type	Description
$moduleName

getTitleKey(
           $left
              =
              false
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getTitleKey()

Parameters

Name	Type	Description
$left

getType(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getType()

getValidDBName(
           $name,  $ensureUnique
              =
              true
          )
        
        :
          void

staticinherited

Inherited from: \AbstractRelationship::getValidDBName()

Parameters

Name	Type	Description
$name
$ensureUnique

getWirelessSubpanelDefinition(
           $relationshipName,  $sourceModule,  $subpanelName,  $titleKeyName
              =
              '',  $source
              =
              ""
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::getWirelessSubpanelDefinition()

Parameters

Name	Type	Description
$relationshipName
$sourceModule
$subpanelName
$titleKeyName
$source

parseRelationshipType(
           $type
          )
        
        :
          void

staticinherited

Inherited from: \AbstractRelationship::parseRelationshipType()

Parameters

Name	Type	Description
$type

readonly(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::readonly()

relationship_only(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::relationship_only()

setFromStudio(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::setFromStudio()

setName(
           $relationshipName
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::setName()

Parameters

Name	Type	Description
$relationshipName

setReadonly(
           $set
              =
              true
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::setReadonly()

Parameters

Name	Type	Description
$set

setRelationship_only(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractRelationship::setRelationship_only()

modules/ModuleBuilder/parsers/relationships/OneToOneRelationship.php

\OneToOneRelationshipjump to top

Properties

Methods

\OneToOneRelationship
jump to top