SugarCon 2010 - Best Practices for Creating Custom Apps in Sugar

Why do this?Module Builder/Studio changes are well supported and easier to manageCustomizations are separated from the shipped codeAllows you to manage your customizations via version control ( SVN, Git, etc )Files in here aren’t disturbed by any Sugar upgradesException – sometimes we will try to fix metadata templates on upgrades for new/removed fields. Makes your app “Upgrade Safe”4/14/10©2010 SugarCRM Inc. All rights reserved.4

Exceptions to this…New modules need to be under modules/ directory.Bean class customizations to OOTB modules need to be on the original bean file.We’ll look at using logic hooks and other techniques to avoid this for many use cases.Will need to manually manage this during upgrades, so best to avoid.4/14/10©2010 SugarCRM Inc. All rights reserved.5

MVC Framework – SugarApplicationBootstraps the applicationLoads many of the default application settingsLanguageThemeSessionHandles User AuthenticationLoads the controller4/14/10©2010 SugarCRM Inc. All rights reserved.9

MVC Framework - SugarControllerManages all the actions of a moduleContains logic for handling requests that don’t require a viewExample: Record savingMaps all other requests to the correct viewLogic for mapping an action of one name to a view of anotherCan detect if we should be using MVC or classic views4/14/10©2010 SugarCRM Inc. All rights reserved.10

MVC Framework – Controller Example4/14/10©2010 SugarCRM Inc. All rights reserved.12<?phpclass ExampleController extends SugarController{ public function action_hello() { echo "Hello World!"; } public function action_goodbye() { $this->view = 'goodbye'; }}

MVC Framework – Controller-less mappingIf your module doesn’t need to have any controller logic, use action mapping insteads.Create file named action_view_map.php with the following contents:4/14/10©2010 SugarCRM Inc. All rights reserved.13<?php$action_view_map['goodbye'] = 'goodbye';

MVC Framework - SugarViewContains the display logic for the actionUses a metadata backend for Edit, Detail, List, Popup viewsAnd Convert Lead in Sugar 6.0For other views, you write the code for the view and put it in modules/modulename/views/view.viewname.php4/14/10©2010 SugarCRM Inc. All rights reserved.14

MVC Framework – View Example4/14/10©2010 SugarCRM Inc. All rights reserved.17<?phpclass ViewExample extends SugarView{ public function preDisplay() { if ( !is_admin($GLOBALS["current_user"]) )sugar_die("Not an Admin"); } public function display() { echo "Hello Admin!"; }}

MVC Framework – ViewDetail Example4/14/10©2010 SugarCRM Inc. All rights reserved.18<?phprequire_once('include/MVC/View/views/view.detail.php');class ContactsViewDetail extends ViewDetail{ public function display() { $admin = new Administration(); $admin->retrieveSettings();if(isset($admin->settings['portal_on']) && $admin->settings['portal_on']) { $this->ss->assign("PORTAL_ENABLED", true); }parent::display(); }}

4/14/10©2010 SugarCRM Inc. All rights reserved.19Where do I put my customizations?Controllers/custom/modules/Modulename/controller.phpclass CustomModulenameController extends SugarControllerViews/custom/modules/Modulename/views/view.viewname.phpclass CustomModulenameViewViewname extends ModulenameViewViewnameIf that class doesn’t exist extend from ViewViewname or SugarView

Kinds of metadataeditviewdefs.php / detailviewdefs.php / quickcreatedefs.phpWireless variants: wireless.editviewdefs.php, wireless.detailviewdefs.phpsubpaneldefs.phplistviewdefs.phpwireless.listviewdefs.phpsearchdefs.phpwireless.searchdefs.phpSearchFields.phppopupdefs.php4/14/10©2010 SugarCRM Inc. All rights reserved.21

editviewdefs.php4/14/10©2010 SugarCRM Inc. All rights reserved.22<?php$viewdefs[$module_name]['EditView'] = array( 'templateMeta' => array( 'maxColumns' => '2', 'widths' => array(array('label' => '10', 'field' => '30'), array('label' => '10', 'field' => '30'), ), ), 'panels' =>array ( 'default' => array ( array ( 'name', 'assigned_user_name', ), array(array( 'name' => 'date_modified', 'customCode' => '{$fields.date_modified.value} {$APP.LBL_BY} {$fields.modified_by_name.value}', 'label' => 'LBL_DATE_MODIFIED',)), ), array( array ( 'description', ), ), ), );

subpaneldefs.php4/14/10©2010 SugarCRM Inc. All rights reserved.23<?php$layout_defs[$module_name] = array( 'subpanel_setup' => array( 'contacts' => array( 'order' => 20, 'module' => 'Contacts', 'sort_by' => 'last_name, first_name', 'sort_order' => 'asc', 'subpanel_name' => 'default', 'get_subpanel_data' => 'contacts', 'title_key' => 'LBL_CONTACTS_SUBPANEL_TITLE', 'top_buttons' => array(array('widget_class' => 'SubPanelTopButtonQuickCreate'), array( 'widget_class'=>'SubPanelTopSelectButton', 'mode'=>'MultiSelect’ ), ), ), ),);

searchdefs.php4/14/10©2010 SugarCRM Inc. All rights reserved.24<?php$searchdefs[$module_name] = array( 'templateMeta' => array( 'maxColumns' => '3', 'widths' => array('label' => '10', 'field' => '30'), ), 'layout' => array( 'basic_search' => array( 'name',array('name'=>'current_user_only', 'label'=>'LBL_CURRENT_USER_FILTER', 'type'=>'bool'), ), 'advanced_search' => array( 'name',array('name' => 'phone', 'label' =>'LBL_ANY_PHONE', 'type' => 'name'),array('name' => 'address_city', 'label' =>'LBL_CITY', 'type' => 'name'),array('name' => 'email', 'label' =>'LBL_ANY_EMAIL', 'type' => 'name'),array('name' => 'assigned_user_id', 'type' => 'enum', 'label' => 'LBL_ASSIGNED_TO', 'function' => array('name' => 'get_user_array', 'params' => array(false))), ), ),);

SearchFields.php4/14/10©2010 SugarCRM Inc. All rights reserved.25<?php$searchFields[$module_name] = array ( 'name' => array( 'query_type'=>'default'), 'current_user_only'=> array('query_type'=>'default', 'db_field'=>array('assigned_user_id'),'my_items'=>true, 'vname' => 'LBL_CURRENT_USER_FILTER', 'type' => 'bool'), 'assigned_user_id'=> array('query_type'=>'default'),);

popupdefs.php4/14/10©2010 SugarCRM Inc. All rights reserved.26<?phpglobal $mod_strings;$popupMeta = array( 'moduleMain' => 'Account', 'varName' => 'ACCOUNT', 'orderBy' => 'name', 'whereClauses' => array( 'name' => 'accounts.name', 'billing_address_city' => 'accounts.billing_address_city', 'phone_office' => 'accounts.phone_office'), 'searchInputs' => array('name', 'billing_address_city', 'phone_office'), 'create' => array( 'formBase' => 'AccountFormBase.php', 'formBaseClass' => 'AccountFormBase', 'getFormBodyParams' => array('','','AccountSave'), 'createButton' => $mod_strings['LNK_NEW_ACCOUNT’]), 'listviewdefs' => array( 'NAME' => array( 'width' => '40', 'label' => 'LBL_LIST_ACCOUNT_NAME', 'link' => true,'default' => true,), ), 'searchdefs' => array( 'name', array('name' => 'assigned_user_id', 'label'=>'LBL_ASSIGNED_TO', 'type' => 'enum', 'function' => array('name' => 'get_user_array', 'params' => array(false))), ),);

Where do I put my customizations?Subpaneldefscustom/Extension/modules/Modulename/Ext/Layoutdefs/NameWhateverYouWant.phpNeed to run ‘Quick Repair and Rebuild’ after changes are madeEverything else/custom/modules/Modulename/metadataWatch for Studio blowing out your changes.4/14/10©2010 SugarCRM Inc. All rights reserved.27

logic_hooks.php4/14/10©2010 SugarCRM Inc. All rights reserved.32<?php$hook_version = 1; $hook_array = Array(); $hook_array['before_save'] = Array(); $hook_array['before_save'][] = Array(1, 'AccountHooks', 'custom/Accounts/AccountHooks.php','AccountHooks', 'getParentAccountIndustry'); Parameters for Logic Hook DefinitionParameter 1 - Sorting index used to sort the arrays of logic hook definitions before they are processed.Parameter 2 - A string value to identify the hookParameter 3 - Path to the PHP file to include which contains your logic hook codeParameter 4 - Name of the PHP class the logic hook method is inParameter 5 - Name of the PHP method to call

AccountHooks.php4/14/10©2010 SugarCRM Inc. All rights reserved.33<?phpclass AccountHooks{ public function getParentAccountIndustry( SugarBean $bean, $event, $arguments ) { if ( empty($bean->industry) && !empty($bean->parent_id) ) { $parentAccountFocus = new Account(); $parentAccountFocus->retrieve($bean->parent_id); if ( !empty($parentAccountFocus->id) ) $bean->industry = $parentAccountFocus->industry; } } }

Theme Directory Layoutcss/ - contains all css filesimages/ - contains all imagesjs/ - contains any js files.tpls/ - smarty templatesthemedef.php definition file.12/30/08©2009 SugarCRM Inc. All rights reserved.36

Allow upgrade-safe modifications to themesAll themes can be modified by putting the replacement or overriding file in the custom/theme/<themename> directoryImage, HTML template file overrides are used as a replacement of the previous fileExample: an image custom/theme/<themename>/dog.gif would be used instead of theme/<themename>/dog.gif CSS and Javascript files are combined in order of inheritanceUses cssmin and jsmin to help reduce file sizeNo further code changes are required – changes are picked up automatically when themes cache is rebuilt.12/30/08©2009 SugarCRM Inc. All rights reserved.38

SugarCon 2010 - Best Practices for Creating Custom Apps in Sugar

More Related Content

What's hot (20)

Similar to SugarCon 2010 - Best Practices for Creating Custom Apps in Sugar (20)

More from John Mertic (11)

Recently uploaded (20)

SugarCon 2010 - Best Practices for Creating Custom Apps in Sugar