modules/ModuleBuilder/parsers/views/GridLayoutMetaDataParser.php

Show: inherited
Table of Contents

\GridLayoutMetaDataParser

Package:
Parent(s)
\AbstractMetaDataParser
Children
\WirelessGridLayoutMetaDataParser
\ConvertLayoutMetadataParser

Properties

Propertyprotected  $FILLER= ''
Details
Type
n/a
Propertypublic  $_fielddefs= ''
inheritedInherited from: \AbstractMetaDataParser::$$_fielddefs
Details
Type
n/a
Inherited_from
\AbstractMetaDataParser::$$_fielddefs  
Propertyprotected  $_moduleName= ''
inheritedInherited from: \AbstractMetaDataParser::$$_moduleName
Details
Type
n/a
Inherited_from
\AbstractMetaDataParser::$$_moduleName  
Propertypublic  $_viewdefs= ''
inheritedInherited from: \AbstractMetaDataParser::$$_viewdefs
Details
Type
n/a
Inherited_from
\AbstractMetaDataParser::$$_viewdefs  
Propertyprotected  $implementation= ''
Details
Type
n/a
Inherited_from
\AbstractMetaDataParser::$$implementation  
Propertypublic  $variableMap= 'array ( MB_EDITVIEW => 'EditView' , MB_DETAILVIEW => 'DetailView' , MB_QUICKCREATE => 'QuickCreate', MB_WIRELESSEDITVIEW => 'EditView' , MB_WIRELESSDETAILVIEW => 'DetailView' , )'
static
Default valuearray ( MB_EDITVIEW => 'EditView' , MB_DETAILVIEW => 'DetailView' , MB_QUICKCREATE => 'QuickCreate', MB_WIRELESSEDITVIEW => 'EditView' , MB_WIRELESSDETAILVIEW => 'DetailView' , )Details
Type
n/a

Methods

methodpublic__construct(  $view,  $moduleName,  $packageName = '' ) : void

Parameters
Name Type Description
$view
$moduleName
$packageName
methodprotected_convertFromCanonicalForm(  $panels,  $fielddefs ) : void

Parameters
Name Type Description
$panels
$fielddefs
methodprotected_convertToCanonicalForm(  $panels,  $fielddefs ) : void

Parameters
Name Type Description
$panels
$fielddefs
methodprotected_populateFromRequest(  $fielddefs ) : void

Parameters
Name Type Description
$fielddefs
methodprotected_standardizeFieldLabels(  $fielddefs ) : void
Parameters
Name Type Description
$fielddefs
methodpublic_trimFieldDefs(  $def ) : void
static

Parameters
Name Type Description
$def
methodpublicaddField(  $def,  $panelID = FALSE ) : void

Parameters
Name Type Description
$def
$panelID
methodpublicconvertFromCanonicalForm(  $panels,  $fielddefs ) : array

Public access to _convertFromCanonicalForm

Parameters
Name Type Description
$panels
$fielddefs
Returns
Type Description
array
methodpublicconvertToCanonicalForm(  $panels,  $fielddefs ) : array

Public access to _convertToCanonicalForm

Parameters
Name Type Description
$panels
$fielddefs
Returns
Type Description
array
methodprotectedfieldIsRequired(  $def ) : void

Parameters
Name Type Description
$def
methodpublicgetAvailableFields( ) : void

methodpublicgetCalculatedFields( ) : Array

Returns
Type Description
Array list of fields in this module that have the calculated property
methodpublicgetFieldDefs( ) : void
inherited

Inherited from: \AbstractMetaDataParser::getFieldDefs()
methodprotectedgetFieldsFromLayout(  $viewdef ) : void

Parameters
Name Type Description
$viewdef
methodpublicgetFieldsInPanel(  $targetPanel ) : Array

Parameters
Name Type Description
$targetPanel
Returns
Type Description
Array fields in the given panel
methodpublicgetFirstNewPanelId( ) : void

methodpublicgetHistory( ) : void
inherited

Inherited from: \AbstractMetaDataParser::getHistory()
methodpublicgetImplementation( ) : \DeployedMetaDataImplementation

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

Returns
Type Description
\DeployedMetaDataImplementation
methodpublicgetLanguage( ) : void
inherited

Inherited from: \AbstractMetaDataParser::getLanguage()
methodpublicgetLayout( ) : void

methodpublicgetLayoutAsArray( ) : void
methodpublicgetMaxColumns( ) : void

methodpublicgetNewRowItem(  $source,  $fielddef ) : void

Parameters
Name Type Description
$source
$fielddef
methodpublicgetPanelDependency(  $panelID ) : void

Parameters
Name Type Description
$panelID
methodpublicgetRequiredFields( ) : void
methodpublicgetSyncDetailEditViews( ) : void

Return whether the Detail & EditView should be in sync.

methodpublicgetTabDefs( ) : void

methodpublicgetUseTabs( ) : void

methodpublichandleSave(  $populate = true ) : void

Parameters
Name Type Description
$populate
methodprotectedisTrue(  $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()
Parameters
Name Type Description
$val
Returns
Type Description
bool
Details
Static
 
methodpublicremoveField(  $fieldName ) : void

Parameters
Name Type Description
$fieldName
methodpublicsetPanelDependency(  $panelID,  $dependency ) : void

Parameters
Name Type Description
$panelID
$dependency
methodpublicsetSyncDetailEditViews(  $syncDetailEditViews ) : void

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

Parameters
Name Type Description
$syncDetailEditViews
methodpublicsetTabDefs(  $tabDefs ) : void

Parameters
Name Type Description
$tabDefs
methodpublicsetUseTabs(  $useTabs ) : void

Parameters
Name Type Description
$useTabs
methodpublicvalidField(  $def,  $view = "" ) : void
staticinherited

Inherited from: \AbstractMetaDataParser::validField()
Parameters
Name Type Description
$def
$view
methodpublicwriteWorkingFile(  $populate = true ) : void

Parameters
Name Type Description
$populate
Documentation was generated by DocBlox 0.18.1.