include/SubPanel/SubPanelDefinitions.php

Show:

inherited

Classes
- \SubPanelDefinitions
- \aSubPanel

Table of Contents

\SubPanelDefinitions
jump to top

Package:

Properties


                 $_focus= ''

Details

Type: n/a


                 $_visible_tabs_array= ''

Details

Type: n/a


                 $layout_defs= ''

Details

Type: n/a


                 $panels= ''

Details

Type: n/a

Methods

SubPanelDefinitions(
          \BEAN $focus, STRING $layout_def_key
              =
              '', ARRAY $layout_def_override
              =
              ''
          )
        
        :
          \SubPanelDefinitions

Enter description here...

Parameters

Name	Type	Description
$focus	\BEAN	this is the bean you want to get the data from
$layout_def_key	STRING	if you wish to use a layout_def defined in the default metadata/subpaneldefs.php that is not keyed off of $bean->module_dir pass in the key here
$layout_def_override	ARRAY	if you wish to override the default loaded layout defs you pass them in here.

Returns

Type	Description
\SubPanelDefinitions

exclude_tab(
           $tab_name
          )
        
        :
          void

Removes a tab from the list of loaded tabs.

Returns true if successful, false otherwise. Hint: Used by Campaign's DetailView.

Parameters

Name	Type	Description
$tab_name

get_all_subpanels(
           $return_tab_modules_only
              =
              true,  $group_by_module
              =
              false
          )
        
        :
          void

return all available subpanels that belong to the list of tab modules. You can optionally return all available subpanels, and also optionally group by module (prepends the key with the bean class name).

Parameters

Name	Type	Description
$return_tab_modules_only
$group_by_module

get_available_tabs(
          boolean $FromGetModuleSubpanels
              =
              false
          )
        
        :
          array

This function returns an ordered list of all "tabs", actually subpanels, for this module The source list is obtained from the subpanel layout contained in the layout_defs for this module, found either in the modules metadata/subpaneldefs.php file, or in the modules custom/.../Ext/Layoutdefs/layoutdefs.ext.php file and filtered through an ACL check.

Note that the keys for the resulting array of tabs are in practice the name of the underlying source relationship for the subpanel So for example, the key for a custom module's subpanel with Accounts might be 'one_one_accounts', as generated by the Studio Relationship Editor Although OOB module subpanels have keys such as 'accounts', which might on the face of it appear to be a reference to the related module, in fact 'accounts' is still the relationship name

Parameters

Name	Type	Description
$FromGetModuleSubpanels	boolean	Optional - include the subpanel title label in the return array (false)

Returns

Type	Description
array	All tabs that pass an ACL check

get_hidden_subpanels(
          
          )
        
        :
          void

load_subpanel(
          string $name, boolean $reload
              =
              false, boolean $original_only
              =
              false
          )
        
        :
          boolean | \aSubPanel

Load the definition of the a sub-panel.

Also the sub-panel is added to an array of sub-panels. use of reload has been deprecated, since the subpanel is initialized every time.

Parameters

Name	Type	Description
$name	string	The name of the sub-panel to reload
$reload	boolean	Reload the sub-panel (unused)
$original_only	boolean	Only load the original sub-panel and no custom ones

Returns

Type	Description
boolean \| \aSubPanel	Returns aSubPanel object or boolean false if one is not found or it can't be displayed due to ACL reasons.

open_layout_defs(
           $reload
              =
              false,  $layout_def_key
              =
              '',  $original_only
              =
              false
          )
        
        :
          void

Load the layout def file and associate the definition with a variable in the file.

Parameters

Name	Type	Description
$reload
$layout_def_key
$original_only

set_hidden_subpanels(
           $panels
          )
        
        :
          void

Parameters

Name	Type	Description
$panels

\aSubPanel
jump to top

Package: SugarCRM

Subpanel implementation

Api

Properties


                 $_instance_properties= ''

Details

Type: n/a


                 $bean_name= ''

Details

Type: n/a

bool
                 $canDisplay= 'true'

Can we display this subpanel?

This is set after it loads the def's for the subpanel. If there are no beans to display in the collection we don't want to display this as it will just throw errors.

Default valuetrueDetails

Type: bool


                 $db_fields= ''

Details

Type: n/a


                 $mod_strings= ''

Details

Type: n/a


                 $name= ''

Details

Type: n/a


                 $panel_definition= ''

Details

Type: n/a


                 $parent_bean= ''

Details

Type: n/a


                 $sub_subpanels= ''

Details

Type: n/a


                 $table_name= ''

Details

Type: n/a


                 $template_instance= ''

Details

Type: n/a

Methods

_to_array(
          
          )
        
        :
          void

Returns an array of current properties of the class.

It will simply give the class name for instances of classes.

aSubPanel(
           $name,  $instance_properties,  $parent_bean,  $reload
              =
              false,  $original_only
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$instance_properties
$parent_bean
$reload
$original_only

distinct_query(
          
          )
        
        :
          void

getDisplayFieldsFromCollection(
           $sub_subpanels
          )
        
        :
          void

Parameters

Name	Type	Description
$sub_subpanels

get_buttons(
          
          )
        
        :
          void

get_data_source_name(
           $check_set_subpanel_data
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$check_set_subpanel_data

get_def_prop_value(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

get_function_parameters(
          
          )
        
        :
          void

get_header_panel_def(
          
          )
        
        :
          void

get_inst_prop_value(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

get_list_fields(
          
          )
        
        :
          void

get_module_name(
          
          )
        
        :
          void

get_name(
          
          )
        
        :
          void

get_title(
          
          )
        
        :
          void

get_where(
          
          )
        
        :
          void

isCollection(
          
          )
        
        :
          bool

Test to see if the sub panels defs contain a collection

Returns

Type	Description
bool

isDatasourceFunction(
          
          )
        
        :
          void

isDefaultHidden(
          
          )
        
        :
          bool

is the sub panel default hidden?

Returns

Type	Description
bool

is_fill_in_additional_fields(
          
          )
        
        :
          void

load_module_info(
          
          )
        
        :
          void

load_sub_subpanels(
          
          )
        
        :
          bool

Load the Sub-Panel objects if it can from the metadata files.

call this function for sub-panels that have unions.

Returns

Type	Description
bool	True by default if the subpanel was loaded. Will return false if none in the collection are allowed by the current user.

include/SubPanel/SubPanelDefinitions.php

\SubPanelDefinitionsjump to top

Properties

Methods

\aSubPaneljump to top

Properties

Methods

\SubPanelDefinitions
jump to top

\aSubPanel
jump to top