modules/ModuleBuilder/parsers/views/DashletMetaDataParser.php

Show:

inherited

Classes
- \DashletMetaDataParser

Table of Contents

\DashletMetaDataParser
jump to top

Package:

Parent(s): \ListLayoutMetaDataParser < \AbstractMetaDataParser

Properties


                 $_fielddefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_fielddefs \ListLayoutMetaDataParser::$$_fielddefs

Details

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


                 $_moduleName= ''

inheritedInherited from: \AbstractMetaDataParser::$$_moduleName \ListLayoutMetaDataParser::$$_moduleName

Details

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


                 $_viewdefs= ''

inheritedInherited from: \AbstractMetaDataParser::$$_viewdefs \ListLayoutMetaDataParser::$$_viewdefs

Details

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


                 $allowParent= 'false'

inheritedInherited from: \ListLayoutMetaDataParser::$$allowParent

Default valuefalseDetails

Type: n/a
Inherited_from: \ListLayoutMetaDataParser::$$allowParent


                 $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 \ListLayoutMetaDataParser::$$implementation

Details

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


                 $labelIdentifier= ''label''

inheritedInherited from: \ListLayoutMetaDataParser::$$labelIdentifier

Default value'label'Details

Type: n/a
Inherited_from: \ListLayoutMetaDataParser::$$labelIdentifier

Methods

ConvertSearchToDashletDefs(
           $defs
          )
        
        :
          void

Parameters

Name	Type	Description
$defs

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

Parameters

Name	Type	Description
$view
$moduleName
$packageName

_populateFromRequest(
          
          )
        
        :
          void

inherited

Inherited from: \ListLayoutMetaDataParser::_populateFromRequest()

_standardizeFieldLabels(
           $fielddefs
          )
        
        :
          void

inherited

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

Parameters

Name	Type	Description
$fielddefs

_trimFieldDefs(
           $def
          )
        
        :
          void

staticinherited

Inherited from: \ListLayoutMetaDataParser::_trimFieldDefs()

Parameters

Name	Type	Description
$def

convertSearchToListDefs(
           $defs
          )
        
        :
          void

Parameters

Name	Type	Description
$defs

getAdditionalFields(
          
          )
        
        :
          array

inherited

Returns additional fields available for users to create fields

Inherited from: \ListLayoutMetaDataParser::getAdditionalFields()

Returns

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

getArrayDiff(
           $one,  $two
          )
        
        :
          void

staticinherited

Inherited from: \ListLayoutMetaDataParser::getArrayDiff()

Parameters

Name	Type	Description
$one
$two

getAvailableFields(
          
          )
        
        :
          array

inherited

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

Inherited from: \ListLayoutMetaDataParser::getAvailableFields()

Returns

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

getDefaultFields(
          
          )
        
        :
          array

inherited

Return a list of the default fields for a listview

Inherited from: \ListLayoutMetaDataParser::getDefaultFields()

Returns

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

getFieldDefs(
          
          )
        
        :
          void

inherited

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

getHistory(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getHistory()\ListLayoutMetaDataParser::getHistory()

getLanguage(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getLanguage()\ListLayoutMetaDataParser::getLanguage()

getLayout(
          
          )
        
        :
          void

inherited

Inherited from: \ListLayoutMetaDataParser::getLayout()

getLayoutAsArray(
          
          )
        
        :
          void

inherited

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

getOriginalViewDefs(
          
          )
        
        :
          void

inherited

Inherited from: \ListLayoutMetaDataParser::getOriginalViewDefs()

getRequiredFields(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractMetaDataParser::getRequiredFields()\ListLayoutMetaDataParser::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()\ListLayoutMetaDataParser::isTrue()

Parameters

Name	Type	Description
$val

Returns

Type	Description
bool

Details

Static

isValidField(
           $key,  $def
          )
        
        :
          void

inherited

Inherited from: \ListLayoutMetaDataParser::isValidField()

Parameters

Name	Type	Description
$key
$def

mergeFieldDefinitions(
           $viewdefs,  $fielddefs
          )
        
        :
          void

Dashlets contain both a searchview and list view definition, therefore we need to merge only the relevant info

Parameters

Name	Type	Description
$viewdefs
$fielddefs

removeField(
           $fieldName
          )
        
        :
          void

inherited

Inherited from: \ListLayoutMetaDataParser::removeField()

Parameters

Name	Type	Description
$fieldName

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

staticinherited

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

Parameters

Name	Type	Description
$def
$view

modules/ModuleBuilder/parsers/views/DashletMetaDataParser.php

\DashletMetaDataParserjump to top

Properties

Methods

\DashletMetaDataParser
jump to top