Class: I2CE FormRelationship (Development)

For other versions, see Class: I2CE_FormRelationship (versions) .

This article describes the class I2CE_FormRelationship .

• Extends the class: I2CE_Fuzzy.
• Location: Part of the module formRelationships in the package I2CE 4.0-dev
• Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_CustomRelationship

Variables

$primaryForm

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 33
• Type: protected $primaryForm

$primaryFormName

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 34
• Type: protected $primaryFormName

$parentFormNames

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 35
• Type: protected $parentFormNames

$formConfigs

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 36
• Type: protected $formConfigs

$relationship

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 37
• Type: protected $relationship

$relConfig

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 38
• Type: protected $relConfig

$form_reference

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 39
• Type: protected $form_reference

$operands

array $operands of string. The SQL operands recognzied

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 566
• Type: static protected static $operands

Methods

__construct()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 46
• Signature: public function __construct($relationship,$relationship_base,$form_reference)
• Parameters:
  • string $relationship
  • $relationship_base
    • Default Value: '/modules/CustomReports/relationships'
  • callback $form_reference
    • Default Value: null

_getLimitingFields()

internal function to get the fields which are in the limits for one where clause in a relationship @param array $limited_fields array of boolean indexed by the names of the fields

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 591
• Signature: protected function _getLimitingFields($whereConfig,$limiting_fields)
• Parameters:
  • I2CE_MagicDataNode $whereConfig
  • &$limiting_fields

addParentIdToWhereClause()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 429
• Signature: protected function addParentIdToWhereClause($where,$parent_id)
• Parameters:
  • &$where
  • $parent_id

dropEmpty()

Determine if we should consider a relationship to not be satisifed if there is no form for the given named form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 236
• Signature: public function dropEmpty($formName)
• Parameters:
  • string $formName
• Returns: boolean

evaluateFunction()

Evaluate a given relationship function on the given form data @param string $funciton

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 506
• Signature: public function evaluateFunction($function,$formData,$displayValue)
• Parameters:
  • $function
  • array $formData
    of I2CE_Form as returend by the @getFormsSatisfyingRelationship()
  • boolean $displayValue
    Defaults to true, in which case it returns the display value of the function. If false, it returns the DB value
    • Default Value: true
• Returns: string

generateWhereClause()

Generate the where clause for the join of a given named form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 623
• Signature: public function generateWhereClause($formName)
• Parameters:
  • string $formName
• Returns: mixed.
  false on failure or a SQL string on success

getAncestorFormNames()

Get the named forms in the relationship which are ancestral to the given named form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 809
• Signature: public function getAncestorFormNames($childFormName)
• Parameters:
  • string $childFormName
• Returns: array
  of string, the named ancestral forms

getChildFormNames()

Get the named forms for the given named form upto a specified depth

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 842
• Signature: public function getChildFormNames($formName,$depth)
• Parameters:
  • string $formName @var int $depth. Defaults to 1 in which case we only get the immediate children
  • $depth
    • Default Value: 1
• Returns: array

getForm()

Returns the form for a given named form in the relationship

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 76
• Signature: public function getForm($formname)
• Parameters:
  • string $formname
• Returns: mixed.
  A string, the form, on success. false on failure

getFormConfig()

Get the magic data node(s) for the name form in the relationship @param string $form.

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 168
• Signature: public function getFormConfig($formname)
• Parameters:
  • $formname
    • Default Value: null
• Returns: mixed.
  false on failture. If $forname is null, we return an array of I2CE_MagicDataNodes index by the form names. If $formma,e is a string then we return the config for the named form.

getFormIdsJoiningOn()

Find all form ids matching the given join

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 326
• Signature: public function getFormIdsJoiningOn($formName,$parentFormObj)
• Parameters:
  • string $formName
    The named form
  • I2CE_Form $parentFormObj
    The parent of this form
• Returns: array
  of string, the form ids

getFormIdsJoiningOn_child()

Get the forms ids for joining on the named parent forms if with the parent of the named child form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1156
• Signature: public function getFormIdsJoiningOn_child($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormIdsJoiningOn_child_field()

Get the forms ids for joining on the named parent form's id with the named child form on a given field

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1243
• Signature: public function getFormIdsJoiningOn_child_field($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormIdsJoiningOn_fields()

Get the forms ids for joining on a given field of a named child form's with the named parent form on a given field

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1318
• Signature: public function getFormIdsJoiningOn_fields($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormIdsJoiningOn_ids()

Get the forms ids for joining on ids of the named parent/child forms

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1106
• Signature: public function getFormIdsJoiningOn_ids($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormIdsJoiningOn_parent()

Get the forms ids for joining as the named child form's id with the parent of the named parent form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 981
• Signature: public function getFormIdsJoiningOn_parent($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormIdsJoiningOn_parent_field()

Get the forms ids for joining as a named child form's id with the named parent form on a given field

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1045
• Signature: public function getFormIdsJoiningOn_parent_field($childFormName,$parentFormObj,$joinData,$where,$limit)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • I2CE_Form $parentFormObj
  • array $joinData
    The array containg the join data
  • array $where
  • array $limit
• Returns: mixed.
  An array of form ids

getFormNames()

Get the names of the forms in the relationship

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 227
• Signature: public function getFormNames()
• Returns: array
  of string.

getForms()

Internal method to walk the relationship and get all the form configs and parent form names and store them in arrays

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 145
• Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name,$depth)
• Parameters:
  • I2CE_MagicDataNode $config
    The node we are walking
  • array $formConfigs
    The array we are storing magic data nodes. Indexed by named forms
  • array $parentForms
    The array of string which maps the named parent form of a named form
  • string $parent_form_name
    The name of the parent form for the given $config
  • $depth
    • Default Value: 0

getFormsSatisfyingRelationship()

Get the forms that satisfy a relationship for the given primary form id

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 247
• Signature: public function getFormsSatisfyingRelationship($form_id)
• Parameters:
  • mixed $form_id
    Either a string, the form id or an array of string (priamry_form, id) for the primary form of the relationship
• Returns: array
  of mixed. The array may be empty if the $form_id does not satisfy the relationship. It is indexed by the named form and the form objects are already populated. If there was no matching form for a given named form, then the value of the array elemet will be false

getFunctionDetails()

Get the details of a relationship function

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 473
• Signature: public function getFunctionDetails($function)
• Parameters:
  • string $function
• Returns: mixed.
  false on failure. On success an array with the keys 'qry' the query string, 'type' the return SQL type of the function, 'required_fields' the form fields reuquired in the relationship, and 'field' which is an instance of I2CE_FormField for the function

getJoin()

Get the SQL join statemetn for the given form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 869
• Signature: public function getJoin($childFormName)
• Parameters:
  • string $childFormName
    the named form in the relationship
• Returns: mixed.
  String, the SQL join statements on succes, false on failure

getJoiningFields()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1367
• Signature: public function getJoiningFields($childFormName)
• Parameters:
  • $childFormName

getLimitingFields()

Gets the names of the fields which are in a limit for a where clause of a given form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 573
• Signature: public function getLimitingFields($formName)
• Parameters:
  • string $formName
    The anmed form in the relationship
• Returns: array
  of string, the fields that are present in the limit

getLinkingData()

Get linking data, if any, for the indicated field of the named form @param string $joinForm the named form we are trying to join

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 671
• Signature: protected function getLinkingData($formName,$fieldName,$joinFormName,$joinField,$style,$reversed)
• Parameters:
  • string $formName
    The named form in the relationship
  • string $fieldName
    The field name
  • $joinFormName
  • string $joinField
    The field of the joined form we are looking for
  • $style
    • Default Value: 'default'
  • $reversed
    • Default Value: false
• Returns: mixed
  If no linking data then return false. Otherwise is in an array with keys sub_select, forms and fields

getParentFormNames()

Get the name(s) of parent forms

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 186
• Signature: public function getParentFormNames($formname)
• Parameters:
  • string $formname
    • Default Value: null
• Returns: mixed.
  If $formname is null we return an array index by relationship form names of all the parent forms. If $formname is a string, it is the parentform name, if it exists of false otherwise.

getPrimaryForm()

Get the primary form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 202
• Signature: public function getPrimaryForm()
• Returns: string

getPrimaryFormName()

Gets the name of the primary from (e.g. the name of the relationship)

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 210
• Signature: public function getPrimaryFormName()
• Returns: string

getReferencedForm()

Get the SQL name of a form via the registered callback functin

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 453
• Signature: public function getReferencedForm($form)
• Parameters:
  • string $form
• Returns: mixed.
  False on failure. A string on success

getReferenedForm()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 651
• Signature: public function getReferenedForm($form)
• Parameters:
  • $form

getRequiredForms()

Gets the forms required by the relationship

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 91
• Signature: public function getRequiredForms()
• Returns: array
  of string

isPrimaryFormName()

Check to see if the given form name is the primary form name. Note the primary form name is the same as the relationship name

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 218
• Signature: public function isPrimaryFormName($formname)
• Parameters:
  • string $formname
• Returns: boolean

joinOn_child()

Generate SQL join statement for joining on the named parent forms if with the parent of the named child form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1137
• Signature: public function joinOn_child($childFormName,$joinData)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

joinOn_child_field()

Generate SQL join statement for joining on the named parent form's id with the named child form on a given field

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1180
• Signature: public function joinOn_child_field($childFormName,$joinData)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

joinOn_fields()

Generate SQL join statement for joining on a given field of a named child form's with the named parent form on a given field

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1286
• Signature: public function joinOn_fields($childFormName,$joinData)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

joinOn_ids()

Generate SQL join statement for joining on ids of the named parent/child forms

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1087
• Signature: public function joinOn_ids($childFormName,$joinData)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

joinOn_parent()

Generate SQL join statement for joining as the named child form's id with the parent of the named parent form

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 963
• Signature: public function joinOn_parent($childFormName,$joinData)
• Parameters:
  • string $childFormName
    the name of the child form in the relationship
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

joinOn_parent_field()

Generate SQL join statement for joining as a named child form's id with the named parent form on a given field @param string $childForm the name of the child form in the relationship

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php on line 1011
• Signature: public function joinOn_parent_field($childFormName,$joinData)
• Parameters:
  • $childFormName
  • array $joinData
    The array containg the join data
• Returns: mixed.
  On success, a string which is the SQL join statement. On failure, false

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()