include/utils/layout_utils.php

Show:

inherited

Table of Contents

Functions

getClassicModuleTitle(
          \$module $module, \$params $params, \$show_create $show_create
              =
              false, \$index_url_override $index_url_override
              =
              '', \$create_url_override $create_url_override
              =
              ''
          )
        
        :
          String

Handles displaying the header for classic view modules

Parameters

Name	Type	Description
$module	\$module	String value of the module to create the title section for
$params	\$params	Array of arguments used to create the title label. Typically this is just the current language string label for the section These should be in the form of array('label' => '', 'link' => ''); the first breadcrumb should be index at 0, and built from there e.g. `array( 'Contacts', 'John Smith', 'Edit', );` would display as: Contacts >> John Smith >> Edit
$show_create	\$show_create	boolean flag indicating whether or not to display the create link (defaults to false)
$index_url_override	\$index_url_override	String value of url to override for module index link (defaults to module's index action if none supplied)
$create_url_override	\$create_url_override	String value of url to override for module create link (defaults to EditView action if none supplied)

Returns

Type	Description
String	HTML content for a classic module title section

get_form_header(
          \$form_title $form_title, \$other_text $other_text, \$show_help $show_help
          )
        
        :
          string

Create HTML to display formatted form title.

Parameters

Name	Type	Description
$form_title	\$form_title	string to display as the title in the header
$other_text	\$other_text	string to next to the title. Typically used for form buttons.
$show_help	\$show_help	boolean which determines if the print and help links are shown.

Returns

Type	Description
string	HTML

get_module_title(
          \$module $module, \$module_title $module_title, \$show_help $show_create,  $count
              =
              0
          )
        
        :
          string

Wrapper function for the get_module_title function, which is mostly used for pre-MVC modules.

Parameters

Name	Type	Description
$module	\$module	string to next to the title. Typically used for form buttons.
$module_title	\$module_title	string to display as the module title
$show_create	\$show_help	boolean which determines if the print and help links are shown.
$count

Returns

Type	Description
string	HTML

Details

Deprecated: use SugarView::getModuleTitle() for MVC modules, or getClassicModuleTitle() for non-MVC modules

insert_popup_footer(
          
          )
        
        :
          string

Create a footer for a popup.

Returns

Type	Description
string	HTML

Details

Todo: refactor this into the base Popup_Picker class

insert_popup_header(
          \$theme $theme
              =
              null,  $includeJS
              =
              true
          )
        
        :
          string

Create a header for a popup.

Parameters

Name	Type	Description
$theme	\$theme	string the name of the current theme, ignorred to use SugarThemeRegistry::current() instead.
$includeJS

Returns

Type	Description
string	HTML

Details

Todo: refactor this into the base Popup_Picker class