modules/Leads/ConvertLayoutMetadataParser.php

Show:

inherited

Classes
- \ConvertLayoutImplementation
- \ConvertLayoutMetadataParser

Table of Contents

\ConvertLayoutImplementation
jump to top

Package:

Properties


                 $fileName= '"modules/Leads/metadata/convertdefs.php"'

Default value"modules/Leads/metadata/convertdefs.php"Details

Type: n/a


                 $viewdefs= ''

Details

Type: n/a

Methods

getViewDefs(
          
          )
        
        :
          void

loadViewdefForModule(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

\ConvertLayoutMetadataParser
jump to top

Package:

Parent(s): \GridLayoutMetaDataParser < \AbstractMetaDataParser

Properties


                 $FILLER= ''

inheritedInherited from: \GridLayoutMetaDataParser::$$FILLER

Details

Type: n/a
Inherited_from: \GridLayoutMetaDataParser::$$FILLER


                 $_fielddefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_fielddefs \GridLayoutMetaDataParser::$$_fielddefs

Details

Type: n/a
Inherited_from: \AbstractMetaDataParser::$$_fielddefs
Inherited_from: \GridLayoutMetaDataParser::$$_fielddefs


                 $_moduleName= ''

inheritedInherited from: \AbstractMetaDataParser::$$_moduleName \GridLayoutMetaDataParser::$$_moduleName

Details

Type: n/a
Inherited_from: \AbstractMetaDataParser::$$_moduleName
Inherited_from: \GridLayoutMetaDataParser::$$_moduleName


                 $_viewdefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_viewdefs \GridLayoutMetaDataParser::$$_viewdefs

Details

Type: n/a
Inherited_from: \AbstractMetaDataParser::$$_viewdefs
Inherited_from: \GridLayoutMetaDataParser::$$_viewdefs


                 $fileName= '"modules/Leads/metadata/convertdefs.php"'

Default value"modules/Leads/metadata/convertdefs.php"Details

Type: n/a


                 $implementation= ''

inheritedInherited from: \AbstractMetaDataParser::$$implementation \GridLayoutMetaDataParser::$$implementation

Details

Type: n/a
Inherited_from: \AbstractMetaDataParser::$$implementation
Inherited_from: \GridLayoutMetaDataParser::$$implementation


                 $pathMap= 'array ( MB_BASEMETADATALOCATION => '' , MB_CUSTOMMETADATALOCATION => 'custom/' , MB_WORKINGMETADATALOCATION => 'custom/working/' , MB_HISTORYMETADATALOCATION => 'custom/history/' )'

Default value

array ( MB_BASEMETADATALOCATION => '' , MB_CUSTOMMETADATALOCATION => 'custom/' , MB_WORKINGMETADATALOCATION => 'custom/working/' , MB_HISTORYMETADATALOCATION => 'custom/history/' )

Details

Type: n/a


                 $variableMap= 'array (
    	MB_EDITVIEW => 'EditView' ,
    	MB_DETAILVIEW => 'DetailView' ,
    	MB_QUICKCREATE => 'QuickCreate',
    	MB_WIRELESSEDITVIEW => 'EditView' ,
    	MB_WIRELESSDETAILVIEW => 'DetailView' ,
    	)'

staticinheritedInherited from: \GridLayoutMetaDataParser::$$variableMap

Default value

array (
    	MB_EDITVIEW => 'EditView' ,
    	MB_DETAILVIEW => 'DetailView' ,
    	MB_QUICKCREATE => 'QuickCreate',
    	MB_WIRELESSEDITVIEW => 'EditView' ,
    	MB_WIRELESSDETAILVIEW => 'DetailView' ,
    	)

Details

Type: n/a
Inherited_from: \GridLayoutMetaDataParser::$$variableMap

Methods

__construct(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

_convertFromCanonicalForm(
           $panels,  $fielddefs
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::_convertFromCanonicalForm()

Parameters

Name	Type	Description
$panels
$fielddefs

_convertToCanonicalForm(
           $panels,  $fielddefs
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::_convertToCanonicalForm()

Parameters

Name	Type	Description
$panels
$fielddefs

_populateFromRequest(
          
          )
        
        :
          void

_saveToFile(
           $filename,  $defs,  $useVariables
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$filename
$defs
$useVariables

_standardizeFieldLabels(
           $fielddefs
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::_standardizeFieldLabels()\GridLayoutMetaDataParser::_standardizeFieldLabels()

Parameters

Name	Type	Description
$fielddefs

_trimFieldDefs(
           $def
          )
        
        :
          void

staticinherited

Inherited from: \GridLayoutMetaDataParser::_trimFieldDefs()

Parameters

Name	Type	Description
$def

addField(
           $def,  $panelID
              =
              FALSE
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::addField()

Parameters

Name	Type	Description
$def
$panelID

convertFromCanonicalForm(
           $panels,  $fielddefs
          )
        
        :
          array

inherited

Public access to _convertFromCanonicalForm

Inherited from: \GridLayoutMetaDataParser::convertFromCanonicalForm()

Parameters

Name	Type	Description
$panels
$fielddefs

Returns

Type	Description
array

convertToCanonicalForm(
           $panels,  $fielddefs
          )
        
        :
          array

inherited

Public access to _convertToCanonicalForm

Inherited from: \GridLayoutMetaDataParser::convertToCanonicalForm()

Parameters

Name	Type	Description
$panels
$fielddefs

Returns

Type	Description
array

deploy(
           $defs
          )
        
        :
          void

Parameters

Name	Type	Description
$defs

fieldIsRequired(
           $def
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::fieldIsRequired()

Parameters

Name	Type	Description
$def

getAvailableFields(
          
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getAvailableFields()

getCalculatedFields(
          
          )
        
        :
          Array

inherited

Inherited from: \GridLayoutMetaDataParser::getCalculatedFields()

Returns

Type	Description
Array	list of fields in this module that have the calculated property

getDefForModule(
           $mod
          )
        
        :
          void

Parameters

Name	Type	Description
$mod

getFieldDefs(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getFieldDefs()\GridLayoutMetaDataParser::getFieldDefs()

getFieldsFromLayout(
           $viewdef
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getFieldsFromLayout()

Parameters

Name	Type	Description
$viewdef

getFieldsInPanel(
           $targetPanel
          )
        
        :
          Array

inherited

Inherited from: \GridLayoutMetaDataParser::getFieldsInPanel()

Parameters

Name	Type	Description
$targetPanel

Returns

Type	Description
Array	fields in the given panel

getFirstNewPanelId(
          
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getFirstNewPanelId()

getHistory(
          
          )
        
        :
          void

getImplementation(
          
          )
        
        :
          \DeployedMetaDataImplementation

inherited

Getter function to get the implementation method which is a private variable

Inherited from: \GridLayoutMetaDataParser::getImplementation()

Returns

Type	Description
\DeployedMetaDataImplementation

getLanguage(
          
          )
        
        :
          void

getLayout(
          
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getLayout()

getLayoutAsArray(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getLayoutAsArray()\GridLayoutMetaDataParser::getLayoutAsArray()

getMaxColumns(
          
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getMaxColumns()

getNewRowItem(
           $source,  $fielddef
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getNewRowItem()

Parameters

Name	Type	Description
$source
$fielddef

getOriginalViewDefs(
          
          )
        
        :
          void

getPanelDependency(
           $panelID
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getPanelDependency()

Parameters

Name	Type	Description
$panelID

getRequiredFields(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getRequiredFields()\GridLayoutMetaDataParser::getRequiredFields()

getSyncDetailEditViews(
          
          )
        
        :
          void

inherited

Return whether the Detail & EditView should be in sync.

Inherited from: \GridLayoutMetaDataParser::getSyncDetailEditViews()

getTabDefs(
          
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::getTabDefs()

getUseTabs(
          
          )
        
        :
          void

handleSave(
           $populate
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$populate

isTrue(
           $val
          )
        
        :
          bool

staticinherited

Used to determine if a field property is true or false given that it could be the boolean value or a string value such use 'false' or '0'

Inherited from: \AbstractMetaDataParser::isTrue()\GridLayoutMetaDataParser::isTrue()

Parameters

Name	Type	Description
$val

Returns

Type	Description
bool

Details

Static

loadViewDefs(
          
          )
        
        :
          void

removeField(
           $fieldName
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::removeField()

Parameters

Name	Type	Description
$fieldName

removeLayout(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

saveNewLabel(
           $key,  $label
          )
        
        :
          void

Parameters

Name	Type	Description
$key
$label

setPanelDependency(
           $panelID,  $dependency
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::setPanelDependency()

Parameters

Name	Type	Description
$panelID
$dependency

setSyncDetailEditViews(
           $syncDetailEditViews
          )
        
        :
          void

inherited

Sync DetailView & EditView. This should only be set on the EditView

Inherited from: \GridLayoutMetaDataParser::setSyncDetailEditViews()

Parameters

Name	Type	Description
$syncDetailEditViews

setTabDefs(
           $tabDefs
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::setTabDefs()

Parameters

Name	Type	Description
$tabDefs

setUseTabs(
           $useTabs
          )
        
        :
          void

Parameters

Name	Type	Description
$useTabs

updateOrder(
          array $data
          )
        
        :
          void

Should take in an updated set of definitions and re-arrange and override the current panel set with the new one.

Parameters

Name	Type	Description
$data	array

validField(
           $def,  $view
              =
              ""
          )
        
        :
          void

staticinherited

Inherited from: \AbstractMetaDataParser::validField()\GridLayoutMetaDataParser::validField()

Parameters

Name	Type	Description
$def
$view

writeWorkingFile(
           $populate
              =
              true
          )
        
        :
          void

inherited

Inherited from: \GridLayoutMetaDataParser::writeWorkingFile()

Parameters

Name	Type	Description
$populate

modules/Leads/ConvertLayoutMetadataParser.php

\ConvertLayoutImplementationjump to top

Properties

Methods

\ConvertLayoutMetadataParserjump to top

Properties

Methods

\ConvertLayoutImplementation
jump to top

\ConvertLayoutMetadataParser
jump to top