Class: I2CE Swiss (Development)

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

This article describes the abstract class I2CE_Swiss .

• Extends the class: I2CE_Fuzzy.
• Implements the interface Iterator
• Implements the interface Countable
• Child Classes:
  • I2CE_Swiss_CustomReports_Base
    • I2CE_Swiss_CustomReports_ReportView_Base
      • I2CE_Swiss_CustomReports_ReportView_Displays
      • I2CE_Swiss_CustomReports_ReportView_Field
      • I2CE_Swiss_CustomReports_ReportView_Fields
      • I2CE_Swiss_CustomReports_ReportView_Meister
        • I2CE_Swiss_CustomReports_ReportView
        • I2CE_Swiss_CustomReports_ReportView_Merge
      • I2CE_Swiss_CustomReports_ReportView_Merges
      • I2CE_Swiss_CustomReports_ReportViews
    • I2CE_Swiss_CustomReports_Report_Base
      • I2CE_Swiss_CustomReports_Report
        • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_Limit
        • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_ModuleLimit
      • I2CE_Swiss_CustomReports_Report_Meta
      • I2CE_Swiss_CustomReports_Report_ReportingForm
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Field
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_Limits
        • I2CE_Swiss_CustomReports_Report_ReportingFunction_Limits
        • I2CE_Swiss_CustomReports_Report_ReportingInternal_Limits
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_Merge
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_Merges
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Field_ModuleLimits
      • I2CE_Swiss_CustomReports_Report_ReportingForm_Fields
      • I2CE_Swiss_CustomReports_Report_ReportingForms
      • I2CE_Swiss_CustomReports_Report_ReportingFunction
      • I2CE_Swiss_CustomReports_Report_ReportingFunctions
      • I2CE_Swiss_CustomReports_Report_ReportingInternal
      • I2CE_Swiss_CustomReports_Report_ReportingInternals
      • I2CE_Swiss_CustomReports_Reports
  • I2CE_Swiss_CustomReport_ReportView_ExportEditor
  • I2CE_Swiss_XSLT
  • I2CE_Swiss_XSLTS
  • I2CE_Swiss_ViewRelationship_Forms
  • I2CE_Swiss_FormRelationship_Base
    • I2CE_Swiss_FormRelationship
      • I2CE_Swiss_FormRelationship_Join
    • I2CE_Swiss_FormRelationship_AncestralCondition
    • I2CE_Swiss_FormRelationship_AncestralConditions
    • I2CE_Swiss_FormRelationship_Joins
    • I2CE_Swiss_FormRelationship_ReportingFunctions
    • I2CE_Swiss_FormRelationship_Where
    • I2CE_Swiss_FormRelationship_Where_Operands
    • I2CE_Swiss_FormRelationships
  • I2CE_Swiss_SQLFunction
  • I2CE_Swiss_Locale
  • I2CE_Swiss_Locales
  • I2CE_Swiss_Default_Base
    • I2CE_Swiss_Default
    • I2CE_Swiss_Default_Leaf
• Location: Part of the module swissfactory in the package I2CE 4.1-dev
• Source: Defined in the file modules/SwissFactory/lib/I2CE_Swiss.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_Swiss

Variables

$name

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 81
• Type: protected $name

$path

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 82
• Type: protected $path

$parent

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 83
• Type: protected $parent

$page

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 84
• Type: protected $page

$template

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 85
• Type: protected $template

$children

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 127
• Type: protected $children

Methods

__construct()

Constructor @param I2CE_MagicDataNode the storage for this swiss

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 61
• Signature: public function __construct($storage,$factory,$name,$parent)
• Parameters:
  • $storage
  • $factory
  • $name
    • Default Value: null
  • $parent
    • Default Value: null

_getChild()

Should not be called outside of getChild()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 154
• Signature: protected function _getChild($child,$create_if_not_exists)
• Parameters:
  • $child
  • $create_if_not_exists

addAjaxLink()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 417
• Signature: public function addAjaxLink($link_name,$source_id,$target_id,$node,$action,$transient_options)
• Parameters:
  • $link_name
  • $source_id
  • $target_id
  • $node
  • $action
  • $transient_options
    • Default Value: array()

addAjaxOptionMenu()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 503
• Signature: protected function addAjaxOptionMenu($input_id,$replace_container_id,$contentNode)
• Parameters:
  • $input_id
  • $replace_container_id
  • $contentNode

addLink()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 413
• Signature: public function addLink($source_id,$target_id,$node,$action,$transient_options)
• Parameters:
  • $source_id
  • $target_id
  • $node
  • $action
  • $transient_options
    • Default Value: array()

addOptionMenu()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 498
• Signature: protected function addOptionMenu($input_id,$contentNode)
• Parameters:
  • $input_id
  • $contentNode

changeClassOnNodes()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 548
• Signature: protected function changeClassOnNodes($old,$new,$node)
• Parameters:
  • $old
  • $new
  • $node

count()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 671
• Signature: public function count()

createIfNotExists()

Check to see if a magic data subnode $child should be created if it does not exist

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 202
• Signature: protected function createIfNotExists($child)
• Parameters:
  • string $child
• Returns: boolean

current()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 648
• Signature: public function current()

display()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 208
• Signature: public function display($contentNode,$transient_options)
• Parameters:
  • $contentNode
  • $transient_options

displayOptions()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 306
• Signature: public function displayOptions($optionsNode,$transient_options)
• Parameters:
  • $optionsNode
  • $transient_options

displayValues()

Display the configuration menu for the specified config node

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 224
• Signature: abstract protected function displayValues($contentNode,$transient_options,$action)
• Parameters:
  • DOMNode $contentNode
    null. All the swiss should display all content relative to that node
  • array $transient_options
  • string $action
• Returns: boolean
  true on sucess

getAjaxJSNodes()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 87
• Signature: public function getAjaxJSNodes()

getAttribute()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 284
• Signature: public function getAttribute($attr)
• Parameters:
  • $attr

getChild()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 129
• Signature: public function getChild($child,$create_if_not_exists)
• Parameters:
  • $child
  • $create_if_not_exists
    • Default Value: false

getChildNames()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 340
• Signature: public function getChildNames()

getChildType()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 147
• Signature: protected function getChildType($child)
• Parameters:
  • $child

getDescription()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 269
• Signature: public function getDescription()

getDisplayName()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 274
• Signature: public function getDisplayName()

getFactory()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 47
• Signature: public function getFactory()

getField()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 586
• Signature: public function getField($field)
• Parameters:
  • $field

getKeys()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 39
• Signature: public function getKeys()

getLocale()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 632
• Signature: public function getLocale()

getName()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 279
• Signature: public function getName()

getPage()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 51
• Signature: public function getPage()

getParent()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 118
• Signature: public function getParent()

getPath()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 189
• Signature: public function getPath($leading_slash)
• Parameters:
  • $leading_slash
    • Default Value: true

getStatus()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 293
• Signature: public function getStatus($key)
• Parameters:
  • $key
    • Default Value: null

getStorage()

Get the storage for this class @retursn I2CE_MaficDataNode

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 35
• Signature: public function getStorage()

getURLQueryString()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 314
• Signature: public function getURLQueryString($additional,$remove)
• Parameters:
  • $additional
    • Default Value: array()
  • $remove
    • Default Value: array()

getURLRoot()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 310
• Signature: public function getURLRoot($action)
• Parameters:
  • $action
    • Default Value: null

hasAttribute()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 288
• Signature: public function hasAttribute($attr)
• Parameters:
  • $attr

hasField()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 562
• Signature: public function hasField($field)
• Parameters:
  • $field

hasParent()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 123
• Signature: public function hasParent()

humanText()

Tries to turn a string (such as a magic data key) into human text @param $text

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 263
• Signature: static public function humanText($text)
• Parameters:
  • $text
• Returns: string

initializeDisplay()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 92
• Signature: public function initializeDisplay($action)
• Parameters:
  • $action

key()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 652
• Signature: public function key()

next()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 656
• Signature: public function next()

postprocessDisplay()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 106
• Signature: public function postprocessDisplay($action)
• Parameters:
  • $action

prefixName()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 344
• Signature: public function prefixName($name,$prefix)
• Parameters:
  • $name
  • $prefix
    • Default Value: 'swissFactory:values'

processValues()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 232
• Signature: public function processValues($vals)
• Parameters:
  • $vals

renameInputs()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 348
• Signature: public function renameInputs($names,$node,$name_prefix,$name_postfix,$also_id)
• Parameters:
  • $names
  • $node
  • $name_prefix
    • Default Value:
  • $name_postfix
    • Default Value:
  • $also_id
    • Default Value: false

rewind()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 659
• Signature: public function rewind()

setField()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 570
• Signature: public function setField($field,$value)
• Parameters:
  • $field
  • $value

setPage()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 110
• Signature: public function setPage($page)
• Parameters:
  • $page

setTranslatableField()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 611
• Signature: public function setTranslatableField($field,$value)
• Parameters:
  • $field
  • $value

updateValues()

Update values @param string $linkBase The base page link used to export the magic data to a magicdatatemplate for validation. Should be a page which which subclasses I2CE_Page_MagicDataExport. @param integer $pipe The pipe length used for the magic data export. Defaults to -1 @param boolean $transact. Defaults to true -- all the SQL statements of this save should be wrapped in a transaction if possible. On failure we rollback the transaction and clear the apc cache for the magic data

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 246
• Signature: public function updateValues($vals)
• Parameters:
  • array $vals
    An array of values (presumably from $_POST) to update magic data from
• Returns: true
  on sucess

valid()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 662
• Signature: public function valid()

validateValues()

• Defined in i2ce/modules/SwissFactory/lib/I2CE_Swiss.php on line 227
• Signature: protected function validateValues($vals)
• Parameters:
  • $vals

Inherited Methods

_hasMethod()

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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()