modules/ModuleBuilder/parsers/views/ListLayoutMetaDataParser.php

Show:

inherited

Classes
- \ListLayoutMetaDataParser

Table of Contents

\ListLayoutMetaDataParser
jump to top

Package:

Parent(s): \AbstractMetaDataParser
Children: \SubpanelMetaDataParser; \SearchViewMetaDataParser; \DashletMetaDataParser; \PopupMetaDataParser

Properties


                 $_fielddefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_fielddefs

Details

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


                 $_moduleName= ''

inheritedInherited from: \AbstractMetaDataParser::$$_moduleName

Details

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


                 $_viewdefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_viewdefs

Details

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


                 $allowParent= 'false'

Default valuefalseDetails

Type: n/a


                 $columns= 'array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' )'

Default value

array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' )

Details

Type: n/a


                 $implementation= ''

inheritedInherited from: \AbstractMetaDataParser::$$implementation

Details

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


                 $labelIdentifier= ''label''

Default value'label'Details

Type: n/a

Methods

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

Parameters

Name	Type	Description
$view
$moduleName
$packageName

_populateFromRequest(
          
          )
        
        :
          void

_standardizeFieldLabels(
           $fielddefs
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::_standardizeFieldLabels()

Parameters

Name	Type	Description
$fielddefs

_trimFieldDefs(
           $def
          )
        
        :
          void

static

Parameters

Name	Type	Description
$def

getAdditionalFields(
          
          )
        
        :
          array

Returns additional fields available for users to create fields

Returns

Type	Description
array	List of additional fields as an array, where key = value = <field name>

getArrayDiff(
           $one,  $two
          )
        
        :
          void

static

Parameters

Name	Type	Description
$one
$two

getAvailableFields(
          
          )
        
        :
          array

Returns unused fields that are available for use in either default or additional list views

Returns

Type	Description
array	List of available fields as an array, where key = value = <field name>

getDefaultFields(
          
          )
        
        :
          array

Return a list of the default fields for a listview

Returns

Type	Description
array	List of default fields as an array, where key = value = <field name>

getFieldDefs(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getFieldDefs()

getHistory(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getHistory()

getLanguage(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getLanguage()

getLayout(
          
          )
        
        :
          void

getLayoutAsArray(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getLayoutAsArray()

getOriginalViewDefs(
          
          )
        
        :
          void

getRequiredFields(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getRequiredFields()

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()

Parameters

Name	Type	Description
$val

Returns

Type	Description
bool

Details

Static

isValidField(
           $key,  $def
          )
        
        :
          void

Parameters

Name	Type	Description
$key
$def

removeField(
           $fieldName
          )
        
        :
          void

Parameters

Name	Type	Description
$fieldName

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

staticinherited

Inherited from: \AbstractMetaDataParser::validField()

Parameters

Name	Type	Description
$def
$view

modules/ModuleBuilder/parsers/views/ListLayoutMetaDataParser.php

\ListLayoutMetaDataParserjump to top

Properties

Methods

\ListLayoutMetaDataParser
jump to top