modules/ModuleBuilder/MB/MBModule.php

Show:

inherited

Constants
- MB_IMPLEMENTS
- MB_TEMPLATES
Functions
Classes
- \MBModule

Table of Contents

Constants

 
                MB_TEMPLATES
                = 'include/SugarObjects/templates'

 
                MB_IMPLEMENTS
                = 'include/SugarObjects/implements'

\MBModule
jump to top

Package:

Properties


                 $always_implement= 'array ( 'assignable' => 'Assignable' , 'acl' => 'Access Controls' , 'studio' => 'Studio Support' , 'audit' => 'Audit Table' )'

Default value

array ( 'assignable' => 'Assignable' , 'acl' => 'Access Controls' , 'studio' => 'Studio Support' , 'audit' => 'Audit Table' )

Details

Type: n/a


                 $config= 'array (
    'assignable' => 1 , 'acl' => 1 , 'has_tab' => 1 , 'studio' => 1 , 'audit' => 1 )'

Default value

array (
    'assignable' => 1 , 'acl' => 1 , 'has_tab' => 1 , 'studio' => 1 , 'audit' => 1 )

Details

Type: n/a


                 $config_md5= 'null'

Default valuenullDetails

Type: n/a


                 $errors= 'array ( )'

Default valuearray ( )Details

Type: n/a


                 $iTemplate= 'array (
    'assignable' )'

Default value

array (
    'assignable' )

Details

Type: n/a


                 $implementable= 'array (
    'has_tab' => 'Navigation Tab' )'

Default value

array (
    'has_tab' => 'Navigation Tab' )

Details

Type: n/a


                 $mbpublicdefs= ''

Details

Type: n/a


                 $name= ''''

Default value''Details

Type: n/a


                 $path= ''''

Default value''Details

Type: n/a

Methods

__construct(
           $name,  $path,  $package,  $package_key
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$path
$package
$package_key

addField(
           $vardef
          )
        
        :
          void

Parameters

Name	Type	Description
$vardef

addFieldObject(
           $field
          )
        
        :
          void

Parameters

Name	Type	Description
$field

addInstallDefs(
           $installDefs
          )
        
        :
          void

Parameters

Name	Type	Description
$installDefs

addLabel(
           $displayLabel
          )
        
        :
          void

Required for an MB module to work with Dynamic fields

Parameters

Name	Type	Description
$displayLabel

addTemplate(
           $template
          )
        
        :
          void

Parameters

Name	Type	Description
$template

build(
           $basepath
          )
        
        :
          void

Parameters

Name	Type	Description
$basepath

copy(
           $new_name
          )
        
        :
          void

Parameters

Name	Type	Description
$new_name

copyCustomFiles(
           $from,  $to
          )
        
        :
          void

Parameters

Name	Type	Description
$from
$to

copyDashlet(
          
          )
        
        :
          void

copyMetaData(
          
          )
        
        :
          void

copyMetaRecursive(
           $from,  $to,  $overwrite
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$from
$to
$overwrite

copyViews(
          
          )
        
        :
          void

createClasses(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

createIcon(
          
          )
        
        :
          void

createMenu(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

delete(
          
          )
        
        :
          void

deleteDropDown(
           $language
              =
              'en_us',  $key
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$key

deleteField(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

deleteLabel(
           $language
              =
              'en_us',  $key
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$key

fieldExists(
           $name
              =
              '',  $type
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$type

getAppListStrings(
           $language
              =
              'en_us'
          )
        
        :
          void

Parameters

Name	Type	Description
$language

getAvailibleSubpanelDef(
           $panelName
          )
        
        :
          void

Parameters

Name	Type	Description
$panelName

getDBName(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

getLabel(
           $language
              =
              'en_us',  $key
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$key

getLinkFields(
          
          )
        
        :
          array

Returns an array of fields defs with all the link fields for this module.

Returns

Type	Description
array

getLocalSubpanelDef(
           $panelName
          )
        
        :
          void

Parameters

Name	Type	Description
$panelName

getModStrings(
           $language
              =
              'en_us'
          )
        
        :
          void

Parameters

Name	Type	Description
$language

getModuleDir(
          
          )
        
        :
          void

getModuleName(
          
          )
        
        :
          void

getNodes(
          
          )
        
        :
          void

getPackageName(
          
          )
        
        :
          void

getProvidedSubpanels(
          
          )
        
        :
          void

getRelationships(
          
          )
        
        :
          \UndeployedRelationships

Returns

Type	Description
\UndeployedRelationships

getTypes(
          
          )
        
        :
          void

getVardefs(
           $by_group
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$by_group

Loads the module based on the module name

populateFromPost(
          
          )
        
        :
          void

removeFieldFromLayouts(
           $fieldName
          )
        
        :
          void

Parameters

Name	Type	Description
$fieldName

removeTemplate(
           $template
          )
        
        :
          void

Parameters

Name	Type	Description
$template

rename(
           $new_name
          )
        
        :
          void

Parameters

Name	Type	Description
$new_name

renameLanguageFiles(
           $new_dir,  $duplicate
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$new_dir
$duplicate

renameMetaData(
          string $new_dir, string $old_name
          )
        
        :
          void

Rename module name in metadata

Parameters

Name	Type	Description
$new_dir	string
$old_name	string

saveAvailibleSubpanelDef(
           $panelName,  $layout
          )
        
        :
          void

Parameters

Name	Type	Description
$panelName
$layout

saveConfig(
          
          )
        
        :
          void

setAppListStrings(
           $language
              =
              'en_us',  $app_list_strings
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$app_list_strings

setConfigMD5(
          
          )
        
        :
          void

setDropDown(
           $language
              =
              'en_us',  $key,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$key
$value

setLabel(
           $language
              =
              'en_us',  $key,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$key
$value

setModStrings(
           $language
              =
              'en_us',  $mod_strings
          )
        
        :
          void

Parameters

Name	Type	Description
$language
$mod_strings

modules/ModuleBuilder/MB/MBModule.php

Constants

\MBModulejump to top

Properties

Methods

\MBModule
jump to top