modules/ModuleBuilder/parsers/views/PopupMetaDataParser.php

Show: inherited
Table of Contents

\PopupMetaDataParser

Package:
Parent(s)
\ListLayoutMetaDataParser < \AbstractMetaDataParser

Properties

Propertypublic  $_viewdefs= ''
Details
Type
n/a
Inherited_from
\AbstractMetaDataParser::$$_viewdefs  
Inherited_from
\ListLayoutMetaDataParser::$$_viewdefs  
Propertyprotected  $allowParent= 'false'
inheritedInherited from: \ListLayoutMetaDataParser::$$allowParent
Default valuefalseDetails
Type
n/a
Inherited_from
\ListLayoutMetaDataParser::$$allowParent  
Propertypublic  $columns= 'array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' )'
Default valuearray ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' )Details
Type
n/a
Propertypublic  $defsMap= 'array(MB_POPUPSEARCH => 'searchdefs' , MB_POPUPLIST => 'listviewdefs')'
static
Default valuearray(MB_POPUPSEARCH => 'searchdefs' , MB_POPUPLIST => 'listviewdefs')Details
Type
n/a
Propertyprotected  $labelIdentifier= ''label''
Default value'label'Details
Type
n/a
Inherited_from
\ListLayoutMetaDataParser::$$labelIdentifier  
Propertypublic  $reserveProperties= 'array('moduleMain', 'varName' , 'orderBy', 'whereClauses', 'searchInputs', 'create','addToReserve')'
static
Default valuearray('moduleMain', 'varName' , 'orderBy', 'whereClauses', 'searchInputs', 'create','addToReserve')Details
Type
n/a

Methods

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

Parameters
Name Type Description
$view
$moduleName
$packageName
methodprivate__diffAndUpdate(  $newDefs,  $targetDefs,  $forWhere = false ) : void

Parameters
Name Type Description
$newDefs
$targetDefs
$forWhere
methodprivate__getTargetModuleName(  $def ) : void

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

Inherited from: \ListLayoutMetaDataParser::_trimFieldDefs()
Parameters
Name Type Description
$def
methodpublicaddNewSearchDef(  $searchDefs,  $popupMeta ) : void

Parameters
Name Type Description
$searchDefs
$popupMeta
methodpublicconvertSearchToListDefs(  $defs ) : void

Parameters
Name Type Description
$defs
methodpublicgetAdditionalFields( ) : 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>
methodpublicgetArrayDiff(  $one,  $two ) : void
staticinherited

Inherited from: \ListLayoutMetaDataParser::getArrayDiff()
Parameters
Name Type Description
$one
$two
methodpublicgetAvailableFields( ) : 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>
methodpublicgetDefaultFields( ) : 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>
methodpublicgetLayout( ) : void
inherited

Inherited from: \ListLayoutMetaDataParser::getLayout()
methodpublicgetOriginalViewDefs( ) : void

methodpublicgetSearchFields( ) : 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()\ListLayoutMetaDataParser::isTrue()
Parameters
Name Type Description
$val
Returns
Type Description
bool
Details
Static
 
methodpublicisValidField(  $key,  $def ) : void
inherited

Inherited from: \ListLayoutMetaDataParser::isValidField()
Parameters
Name Type Description
$key
$def
methodpublicmergeFieldDefinitions(  $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
methodpublicremoveField(  $fieldName ) : void
inherited

Inherited from: \ListLayoutMetaDataParser::removeField()
Parameters
Name Type Description
$fieldName
methodpublicvalidField(  $def,  $view = "" ) : void
Parameters
Name Type Description
$def
$view
Documentation was generated by DocBlox 0.18.1.