2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
38 /*********************************************************************************
40 * Description: Defines the base class for all data entities used throughout the
41 * application. The base class including its methods and variables is designed to
42 * be overloaded with module-specific methods and variables particular to the
43 * module's base entity class.
44 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
45 * All Rights Reserved.
46 *******************************************************************************/
48 require_once('modules/DynamicFields/DynamicField.php');
51 * SugarBean is the base class for all business objects in Sugar. It implements
52 * the primary functionality needed for manipulating business objects: create,
53 * retrieve, update, delete. It allows for searching and retrieving list of records.
54 * It allows for retrieving related objects (e.g. contacts related to a specific account).
56 * In the current implementation, there can only be one bean per folder.
57 * Naming convention has the bean name be the same as the module and folder name.
58 * All bean names should be singular (e.g. Contact). The primary table name for
59 * a bean should be plural (e.g. contacts).
65 * A pointer to the database helper object DBHelper
72 * When createing a bean, you can specify a value in the id column as
73 * long as that value is unique. During save, if the system finds an
74 * id, it assumes it is an update. Setting new_with_id to true will
75 * make sure the system performs an insert instead of an update.
77 * @var BOOL -- default false
79 var $new_with_id = false;
83 * Disble vardefs. This should be set to true only for beans that do not have varders. Tracker is an example
85 * @var BOOL -- default false
87 var $disable_vardefs = false;
91 * holds the full name of the user that an item is assigned to. Only used if notifications
92 * are turned on and going to be sent out.
96 var $new_assigned_user_name;
99 * An array of booleans. This array is cleared out when data is loaded.
100 * As date/times are converted, a "1" is placed under the key, the field is converted.
102 * @var Array of booleans
104 var $processed_dates_times = array();
107 * Whether to process date/time fields for storage in the database in GMT
111 var $process_save_dates =true;
114 * This signals to the bean that it is being saved in a mass mode.
115 * Examples of this kind of save are import and mass update.
116 * We turn off notificaitons of this is the case to make things more efficient.
120 var $save_from_post = true;
123 * When running a query on related items using the method: retrieve_by_string_fields
124 * this value will be set to true if more than one item matches the search criteria.
128 var $duplicates_found = false;
131 * The DBManager instance that was used to load this bean and should be used for
132 * future database interactions.
139 * true if this bean has been deleted, false otherwise.
146 * Should the date modified column of the bean be updated during save?
147 * This is used for admin level functionality that should not be updating
148 * the date modified. This is only used by sync to allow for updates to be
149 * replicated in a way that will not cause them to be replicated back.
153 var $update_date_modified = true;
156 * Should the modified by column of the bean be updated during save?
157 * This is used for admin level functionality that should not be updating
158 * the modified by column. This is only used by sync to allow for updates to be
159 * replicated in a way that will not cause them to be replicated back.
163 var $update_modified_by = true;
166 * Setting this to true allows for updates to overwrite the date_entered
170 var $update_date_entered = false;
173 * This allows for seed data to be created without using the current uesr to set the id.
174 * This should be replaced by altering the current user before the call to save.
178 //TODO This should be replaced by altering the current user before the call to save.
179 var $set_created_by = true;
184 * The database table where records of this Bean are stored.
188 var $table_name = '';
191 * This is the singular name of the bean. (i.e. Contact).
195 var $object_name = '';
197 /** Set this to true if you query contains a sub-select and bean is converting both select statements
198 * into count queries.
200 var $ungreedy_count=false;
203 * The name of the module folder for this type of bean.
207 var $module_dir = '';
211 var $column_fields = array();
212 var $list_fields = array();
213 var $additional_column_fields = array();
214 var $relationship_fields = array();
215 var $current_notify_user;
216 var $fetched_row=false;
218 var $force_load_details = false;
219 var $optimistic_lock = false;
220 var $disable_custom_fields = false;
221 var $number_formatting_done = false;
222 var $process_field_encrypted=false;
224 * The default ACL type
226 var $acltype = 'module';
229 var $additional_meta_fields = array();
232 * Set to true in the child beans if the module supports importing
234 var $importable = false;
237 * Set to true in the child beans if the module use the special notification template
239 var $special_notification = false;
242 * Set to true if the bean is being dealt with in a workflow
244 var $in_workflow = false;
248 * By default it will be true but if any module is to be kept non visible
249 * to tracker, then its value needs to be overriden in that particular module to false.
252 var $tracker_visibility = true;
255 * Used to pass inner join string to ListView Data.
257 var $listview_inner_join = array();
260 * Set to true in <modules>/Import/views/view.step4.php if a module is being imported
262 var $in_import = false;
264 * Constructor for the bean, it performs following tasks:
266 * 1. Initalized a database connections
267 * 2. Load the vardefs for the module implemeting the class. cache the entries
269 * 3. Setup row-level security preference
270 * All implementing classes must call this constructor using the parent::SugarBean() class.
275 global $dictionary, $current_user;
276 static $loaded_defs = array();
277 $this->db = DBManagerFactory::getInstance();
279 $this->dbManager = DBManagerFactory::getInstance();
280 if((false == $this->disable_vardefs && empty($loaded_defs[$this->object_name])) || !empty($GLOBALS['reload_vardefs']))
282 VardefManager::loadVardef($this->module_dir, $this->object_name);
284 // build $this->column_fields from the field_defs if they exist
285 if (!empty($dictionary[$this->object_name]['fields'])) {
286 foreach ($dictionary[$this->object_name]['fields'] as $key=>$value_array) {
287 $column_fields[] = $key;
288 if(!empty($value_array['required']) && !empty($value_array['name'])) {
289 $this->required_fields[$value_array['name']] = 1;
292 $this->column_fields = $column_fields;
295 //setup custom fields
296 if(!isset($this->custom_fields) &&
297 empty($this->disable_custom_fields))
299 $this->setupCustomFields($this->module_dir);
301 //load up field_arrays from CacheHandler;
302 if(empty($this->list_fields))
303 $this->list_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'list_fields');
304 if(empty($this->column_fields))
305 $this->column_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'column_fields');
306 if(empty($this->required_fields))
307 $this->required_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'required_fields');
309 if(isset($GLOBALS['dictionary'][$this->object_name]) && !$this->disable_vardefs)
311 $this->field_name_map = $dictionary[$this->object_name]['fields'];
312 $this->field_defs = $dictionary[$this->object_name]['fields'];
314 if(!empty($dictionary[$this->object_name]['optimistic_locking']))
316 $this->optimistic_lock=true;
319 $loaded_defs[$this->object_name]['column_fields'] =& $this->column_fields;
320 $loaded_defs[$this->object_name]['list_fields'] =& $this->list_fields;
321 $loaded_defs[$this->object_name]['required_fields'] =& $this->required_fields;
322 $loaded_defs[$this->object_name]['field_name_map'] =& $this->field_name_map;
323 $loaded_defs[$this->object_name]['field_defs'] =& $this->field_defs;
327 $this->column_fields =& $loaded_defs[$this->object_name]['column_fields'] ;
328 $this->list_fields =& $loaded_defs[$this->object_name]['list_fields'];
329 $this->required_fields =& $loaded_defs[$this->object_name]['required_fields'];
330 $this->field_name_map =& $loaded_defs[$this->object_name]['field_name_map'];
331 $this->field_defs =& $loaded_defs[$this->object_name]['field_defs'];
332 $this->added_custom_field_defs = true;
334 if(!isset($this->custom_fields) &&
335 empty($this->disable_custom_fields))
337 $this->setupCustomFields($this->module_dir, false);
339 if(!empty($dictionary[$this->object_name]['optimistic_locking']))
341 $this->optimistic_lock=true;
345 if($this->bean_implements('ACL') && !empty($GLOBALS['current_user'])){
346 $this->acl_fields = (isset($dictionary[$this->object_name]['acl_fields']) && $dictionary[$this->object_name]['acl_fields'] === false)?false:true;
348 $this->populateDefaultValues();
353 * Returns the object name. If object_name is not set, table_name is returned.
355 * All implementing classes must set a value for the object_name variable.
357 * @param array $arr row of data fetched from the database.
361 function getObjectName()
363 if ($this->object_name)
364 return $this->object_name;
366 // This is a quick way out. The generated metadata files have the table name
367 // as the key. The correct way to do this is to override this function
368 // in bean and return the object name. That requires changing all the beans
369 // as well as put the object name in the generator.
370 return $this->table_name;
374 * Returns a list of fields with their definitions that have the audited property set to true.
375 * Before calling this function, check whether audit has been enabled for the table/module or not.
376 * You would set the audit flag in the implemting module's vardef file.
378 * @return an array of
379 * @see is_AuditEnabled
381 * Internal function, do not override.
383 function getAuditEnabledFieldDefinitions()
385 $aclcheck = $this->bean_implements('ACL');
386 $is_owner = $this->isOwner($GLOBALS['current_user']->id);
387 if (!isset($this->audit_enabled_fields))
390 $this->audit_enabled_fields=array();
391 foreach ($this->field_defs as $field => $properties)
396 !empty($properties['Audited']) || !empty($properties['audited']))
400 $this->audit_enabled_fields[$field]=$properties;
405 return $this->audit_enabled_fields;
409 * Return true if auditing is enabled for this object
410 * You would set the audit flag in the implemting module's vardef file.
414 * Internal function, do not override.
416 function is_AuditEnabled()
419 if (isset($dictionary[$this->getObjectName()]['audited']))
421 return $dictionary[$this->getObjectName()]['audited'];
432 * Returns the name of the audit table.
433 * Audit table's name is based on implementing class' table name.
435 * @return String Audit table name.
437 * Internal function, do not override.
439 function get_audit_table_name()
441 return $this->getTableName().'_audit';
445 * If auditing is enabled, create the audit table.
447 * Function is used by the install scripts and a repair utility in the admin panel.
449 * Internal function, do not override.
451 function create_audit_table()
454 $table_name=$this->get_audit_table_name();
456 require('metadata/audit_templateMetaData.php');
458 $fieldDefs = $dictionary['audit']['fields'];
459 $indices = $dictionary['audit']['indices'];
460 // '0' stands for the first index for all the audit tables
461 $indices[0]['name'] = 'idx_' . strtolower($this->getTableName()) . '_' . $indices[0]['name'];
462 $indices[1]['name'] = 'idx_' . strtolower($this->getTableName()) . '_' . $indices[1]['name'];
464 if(isset($dictionary['audit']['engine'])) {
465 $engine = $dictionary['audit']['engine'];
466 } else if(isset($dictionary[$this->getObjectName()]['engine'])) {
467 $engine = $dictionary[$this->getObjectName()]['engine'];
470 $sql=$this->dbManager->helper->createTableSQLParams($table_name, $fieldDefs, $indices, $engine);
472 $msg = "Error creating table: ".$table_name. ":";
473 $this->dbManager->query($sql,true,$msg);
477 * Returns the implementing class' table name.
479 * All implementing classes set a value for the table_name variable. This value is returned as the
480 * table name. If not set, table name is extracted from the implementing module's vardef.
482 * @return String Table name.
484 * Internal function, do not override.
486 function getTableName()
489 if(isset($this->table_name))
491 return $this->table_name;
493 return $dictionary[$this->getObjectName()]['table'];
497 * Returns field definitions for the implementing module.
499 * The definitions were loaded in the constructor.
501 * @return Array Field definitions.
503 * Internal function, do not override.
505 function getFieldDefinitions()
507 return $this->field_defs;
511 * Returns index definitions for the implementing module.
513 * The definitions were loaded in the constructor.
515 * @return Array Index definitions.
517 * Internal function, do not override.
519 function getIndices()
522 if(isset($dictionary[$this->getObjectName()]['indices']))
524 return $dictionary[$this->getObjectName()]['indices'];
530 * Returns field definition for the requested field name.
532 * The definitions were loaded in the constructor.
534 * @param string field name,
535 * @return Array Field properties or boolean false if the field doesn't exist
537 * Internal function, do not override.
539 function getFieldDefinition($name)
541 if ( !isset($this->field_defs[$name]) )
544 return $this->field_defs[$name];
548 * Returnss definition for the id field name.
550 * The definitions were loaded in the constructor.
552 * @return Array Field properties.
554 * Internal function, do not override.
556 function getPrimaryFieldDefinition()
558 $def = $this->getFieldDefinition("id");
560 $def = $this->getFieldDefinition(0);
564 * Returns the value for the requested field.
566 * When a row of data is fetched using the bean, all fields are created as variables in the context
567 * of the bean and then fetched values are set in these variables.
569 * @param string field name,
570 * @return varies Field value.
572 * Internal function, do not override.
574 function getFieldValue($name)
576 if (!isset($this->$name)){
579 if($this->$name === TRUE){
582 if($this->$name === FALSE){
589 * Basically undoes the effects of SugarBean::populateDefaultValues(); this method is best called right after object
592 public function unPopulateDefaultValues()
594 if ( !is_array($this->field_defs) )
597 foreach ($this->field_defs as $field => $value) {
598 if( !empty($this->$field)
599 && ((isset($value['default']) && $this->$field == $value['default']) || (!empty($value['display_default']) && $this->$field == $value['display_default']))
601 $this->$field = null;
604 if(!empty($this->$field) && !empty($value['display_default']) && in_array($value['type'], array('date', 'datetime', 'datetimecombo')) &&
605 $this->$field == $this->parseDateDefault($value['display_default'], ($value['type'] != 'date'))) {
606 $this->$field = null;
612 * Create date string from default value
614 * @param string $value
615 * @param bool $time Should be expect time set too?
618 protected function parseDateDefault($value, $time = false)
622 $dtAry = explode('&', $value, 2);
623 $dateValue = $timedate->getNow(true)->modify($dtAry[0]);
624 if(!empty($dtAry[1])) {
625 $timeValue = $timedate->fromString($dtAry[1]);
626 $dateValue->setTime($timeValue->hour, $timeValue->min, $timeValue->sec);
628 return $timedate->asUser($dateValue);
630 return $timedate->asUserDate($timedate->getNow(true)->modify($value));
634 function populateDefaultValues($force=false){
635 if ( !is_array($this->field_defs) )
637 foreach($this->field_defs as $field=>$value){
638 if((isset($value['default']) || !empty($value['display_default'])) && ($force || empty($this->$field))){
639 $type = $value['type'];
643 if(!empty($value['display_default'])){
644 $this->$field = $this->parseDateDefault($value['display_default']);
648 case 'datetimecombo':
649 if(!empty($value['display_default'])){
650 $this->$field = $this->parseDateDefault($value['display_default'], true);
654 if(empty($value['default']) && !empty($value['display_default']))
655 $this->$field = $value['display_default'];
657 $this->$field = $value['default'];
660 if ( isset($value['default']) && $value['default'] !== '' ) {
661 $this->$field = htmlentities($value['default'], ENT_QUOTES, 'UTF-8');
672 * Removes relationship metadata cache.
674 * Every module that has relationships defined with other modules, has this meta data cached. The cache is
675 * stores in 2 locations: relationships table and file system. This method clears the cache from both locations.
677 * @param string $key module whose meta cache is to be cleared.
678 * @param string $db database handle.
679 * @param string $tablename table name
680 * @param string $dictionary vardef for the module
681 * @param string $module_dir name of subdirectory where module is installed.
686 * Internal function, do not override.
688 function removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir)
690 //load the module dictionary if not supplied.
691 if ((!isset($dictionary) or empty($dictionary)) && !empty($module_dir))
693 $filename='modules/'. $module_dir . '/vardefs.php';
694 if(file_exists($filename))
699 if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
701 $GLOBALS['log']->fatal("removeRelationshipMeta: Metadata for table ".$tablename. " does not exist");
702 display_notice("meta data absent for table ".$tablename." keyed to $key ");
706 if (isset($dictionary[$key]['relationships']))
708 $RelationshipDefs = $dictionary[$key]['relationships'];
709 foreach ($RelationshipDefs as $rel_name)
711 Relationship::delete($rel_name,$db);
719 * This method has been deprecated.
721 * @see removeRelationshipMeta()
722 * @deprecated 4.5.1 - Nov 14, 2006
725 function remove_relationship_meta($key,$db,$log,$tablename,$dictionary,$module_dir)
727 SugarBean::removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
732 * Populates the relationship meta for a module.
734 * It is called during setup/install. It is used statically to create relationship meta data for many-to-many tables.
736 * @param string $key name of the object.
737 * @param object $db database handle.
738 * @param string $tablename table, meta data is being populated for.
739 * @param array dictionary vardef dictionary for the object. *
740 * @param string module_dir name of subdirectory where module is installed.
741 * @param boolean $iscustom Optional,set to true if module is installed in a custom directory. Default value is false.
744 * Internal function, do not override.
746 function createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir,$iscustom=false)
748 //load the module dictionary if not supplied.
749 if (empty($dictionary) && !empty($module_dir))
753 $filename='custom/modules/' . $module_dir . '/Ext/Vardefs/vardefs.ext.php';
759 // a very special case for the Employees module
760 // this must be done because the Employees/vardefs.php does an include_once on
762 $filename='modules/Users/vardefs.php';
766 $filename='modules/'. $module_dir . '/vardefs.php';
770 if(file_exists($filename))
773 // cn: bug 7679 - dictionary entries defined as $GLOBALS['name'] not found
774 if(empty($dictionary) || !empty($GLOBALS['dictionary'][$key]))
776 $dictionary = $GLOBALS['dictionary'];
781 $GLOBALS['log']->debug("createRelationshipMeta: no metadata file found" . $filename);
786 if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
788 $GLOBALS['log']->fatal("createRelationshipMeta: Metadata for table ".$tablename. " does not exist");
789 display_notice("meta data absent for table ".$tablename." keyed to $key ");
793 if (isset($dictionary[$key]['relationships']))
796 $RelationshipDefs = $dictionary[$key]['relationships'];
800 $beanList_ucase=array_change_key_case ( $beanList ,CASE_UPPER);
801 foreach ($RelationshipDefs as $rel_name=>$rel_def)
803 if (isset($rel_def['lhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['lhs_module'])])) {
804 $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' lhs module is missing ' . $rel_def['lhs_module']);
807 if (isset($rel_def['rhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['rhs_module'])])) {
808 $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' rhs module is missing ' . $rel_def['rhs_module']);
813 //check whether relationship exists or not first.
814 if (Relationship::exists($rel_name,$db))
816 $GLOBALS['log']->debug('Skipping, reltionship already exists '.$rel_name);
820 // add Id to the insert statement.
822 $value_list="'".create_guid()."'";
824 //add relationship name to the insert statement.
825 $column_list .= $delimiter.'relationship_name';
826 $value_list .= $delimiter."'".$rel_name."'";
828 //todo check whether $rel_def is an array or not.
829 //for now make that assumption.
830 //todo specify defaults if meta not defined.
831 foreach ($rel_def as $def_key=>$value)
833 $column_list.= $delimiter.$def_key;
834 $value_list.= $delimiter."'".$value."'";
837 //create the record. todo add error check.
838 $insert_string = "INSERT into relationships (" .$column_list. ") values (".$value_list.")";
839 $db->query($insert_string, true);
846 //log informational message stating no relationships meta was set for this bean.
852 * This method has been deprecated.
853 * @see createRelationshipMeta()
854 * @deprecated 4.5.1 - Nov 14, 2006
857 function create_relationship_meta($key,&$db,&$log,$tablename,$dictionary,$module_dir)
859 SugarBean::createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
864 * Loads the request relationship. This method should be called before performing any operations on the related data.
866 * This method searches the vardef array for the requested attribute's definition. If the attribute is of the type
867 * link then it creates a similary named variable and loads the relationship definition.
869 * @param string $rel_name relationship/attribute name.
872 function load_relationship($rel_name)
874 $GLOBALS['log']->debug("SugarBean.load_relationships, Loading relationship (".$rel_name.").");
876 if (empty($rel_name))
878 $GLOBALS['log']->error("SugarBean.load_relationships, Null relationship name passed.");
881 $fieldDefs = $this->getFieldDefinitions();
883 //find all definitions of type link.
884 if (!empty($fieldDefs))
886 //if rel_name is provided, search the fieldef array keys by name.
887 if (array_key_exists($rel_name, $fieldDefs))
889 if (array_search('link',$fieldDefs[$rel_name]) === 'type')
891 //initialize a variable of type Link
892 require_once('data/Link.php');
893 $class = load_link_class($fieldDefs[$rel_name]);
895 $this->$rel_name=new $class($fieldDefs[$rel_name]['relationship'], $this, $fieldDefs[$rel_name]);
897 if (empty($this->$rel_name->_relationship->id)) {
898 unset($this->$rel_name);
906 $GLOBALS['log']->debug("SugarBean.load_relationships, Error Loading relationship (".$rel_name.").");
915 * Loads all attributes of type link.
917 * Method searches the implmenting module's vardef file for attributes of type link, and for each attribute
918 * create a similary named variable and load the relationship definition.
922 * Internal function, do not override.
924 function load_relationships()
927 $GLOBALS['log']->debug("SugarBean.load_relationships, Loading all relationships of type link.");
929 $linked_fields=$this->get_linked_fields();
930 require_once("data/Link.php");
931 foreach($linked_fields as $name=>$properties)
933 $class = load_link_class($properties);
935 $this->$name=new $class($properties['relationship'], $this, $properties);
940 * Returns an array of beans of related data.
942 * For instance, if an account is related to 10 contacts , this function will return an array of contacts beans (10)
943 * with each bean representing a contact record.
944 * Method will load the relationship if not done so already.
946 * @param string $field_name relationship to be loaded.
947 * @param string $bean name class name of the related bean.
948 * @param array $sort_array optional, unused
949 * @param int $begin_index Optional, default 0, unused.
950 * @param int $end_index Optional, default -1
951 * @param int $deleted Optional, Default 0, 0 adds deleted=0 filter, 1 adds deleted=1 filter.
952 * @param string $optional_where, Optional, default empty.
954 * Internal function, do not override.
956 function get_linked_beans($field_name,$bean_name, $sort_array = array(), $begin_index = 0, $end_index = -1,
957 $deleted=0, $optional_where="")
960 //if bean_name is Case then use aCase
961 if($bean_name=="Case")
962 $bean_name = "aCase";
964 //add a references to bean_name if it doe not exist aleady.
965 if (!(class_exists($bean_name)))
968 if (isset($GLOBALS['beanList']) && isset($GLOBALS['beanFiles']))
976 $bean_file=$beanFiles[$bean_name];
977 include_once($bean_file);
980 $this->load_relationship($field_name);
982 return $this->$field_name->getBeans(new $bean_name(), $sort_array, $begin_index, $end_index, $deleted, $optional_where);
986 * Returns an array of fields that are of type link.
988 * @return array List of fields.
990 * Internal function, do not override.
992 function get_linked_fields()
995 $linked_fields=array();
997 // require_once('data/Link.php');
999 $fieldDefs = $this->getFieldDefinitions();
1001 //find all definitions of type link.
1002 if (!empty($fieldDefs))
1004 foreach ($fieldDefs as $name=>$properties)
1006 if (array_search('link',$properties) === 'type')
1008 $linked_fields[$name]=$properties;
1013 return $linked_fields;
1017 * Returns an array of fields that are able to be Imported into
1018 * i.e. 'importable' not set to 'false'
1020 * @return array List of fields.
1022 * Internal function, do not override.
1024 function get_importable_fields()
1026 $importableFields = array();
1028 $fieldDefs= $this->getFieldDefinitions();
1030 if (!empty($fieldDefs)) {
1031 foreach ($fieldDefs as $key=>$value_array) {
1032 if ( (isset($value_array['importable'])
1033 && (is_string($value_array['importable']) && $value_array['importable'] == 'false'
1034 || is_bool($value_array['importable']) && $value_array['importable'] == false))
1035 || (isset($value_array['type']) && $value_array['type'] == 'link')
1036 || (isset($value_array['auto_increment'])
1037 && ($value_array['type'] == true || $value_array['type'] == 'true')) ) {
1038 // only allow import if we force it
1039 if (isset($value_array['importable'])
1040 && (is_string($value_array['importable']) && $value_array['importable'] == 'true'
1041 || is_bool($value_array['importable']) && $value_array['importable'] == true)) {
1042 $importableFields[$key]=$value_array;
1046 $importableFields[$key]=$value_array;
1051 return $importableFields;
1055 * Returns an array of fields that are of type relate.
1057 * @return array List of fields.
1059 * Internal function, do not override.
1061 function get_related_fields()
1064 $related_fields=array();
1066 // require_once('data/Link.php');
1068 $fieldDefs = $this->getFieldDefinitions();
1070 //find all definitions of type link.
1071 if (!empty($fieldDefs))
1073 foreach ($fieldDefs as $name=>$properties)
1075 if (array_search('relate',$properties) === 'type')
1077 $related_fields[$name]=$properties;
1082 return $related_fields;
1086 * Returns an array of fields that are required for import
1090 function get_import_required_fields()
1092 $importable_fields = $this->get_importable_fields();
1093 $required_fields = array();
1095 foreach ( $importable_fields as $name => $properties ) {
1096 if ( isset($properties['importable']) && is_string($properties['importable']) && $properties['importable'] == 'required' ) {
1097 $required_fields[$name] = $properties;
1101 return $required_fields;
1105 * Iterates through all the relationships and deletes all records for reach relationship.
1107 * @param string $id Primary key value of the parent reocrd
1109 function delete_linked($id)
1111 $linked_fields=$this->get_linked_fields();
1113 foreach ($linked_fields as $name => $value)
1115 if ($this->load_relationship($name))
1117 $GLOBALS['log']->debug('relationship loaded');
1118 $this->$name->delete($id);
1122 $GLOBALS['log']->error('error loading relationship');
1128 * Creates tables for the module implementing the class.
1129 * If you override this function make sure that your code can handles table creation.
1132 function create_tables()
1136 $key = $this->getObjectName();
1137 if (!array_key_exists($key, $dictionary))
1139 $GLOBALS['log']->fatal("create_tables: Metadata for table ".$this->table_name. " does not exist");
1140 display_notice("meta data absent for table ".$this->table_name." keyed to $key ");
1144 if(!$this->db->tableExists($this->table_name))
1146 $this->dbManager->createTable($this);
1147 if($this->bean_implements('ACL')){
1148 if(!empty($this->acltype)){
1149 ACLAction::addActions($this->getACLCategory(), $this->acltype);
1151 ACLAction::addActions($this->getACLCategory());
1157 echo "Table already exists : $this->table_name<br>";
1159 if($this->is_AuditEnabled()){
1160 if (!$this->db->tableExists($this->get_audit_table_name())) {
1161 $this->create_audit_table();
1169 * Delete the primary table for the module implementing the class.
1170 * If custom fields were added to this table/module, the custom table will be removed too, along with the cache
1171 * entries that define the custom fields.
1174 function drop_tables()
1177 $key = $this->getObjectName();
1178 if (!array_key_exists($key, $dictionary))
1180 $GLOBALS['log']->fatal("drop_tables: Metadata for table ".$this->table_name. " does not exist");
1181 echo "meta data absent for table ".$this->table_name."<br>\n";
1183 if(empty($this->table_name))return;
1184 if ($this->db->tableExists($this->table_name))
1186 $this->dbManager->dropTable($this);
1187 if ($this->db->tableExists($this->table_name. '_cstm'))
1189 $this->dbManager->dropTableName($this->table_name. '_cstm');
1190 DynamicField::deleteCache();
1192 if ($this->db->tableExists($this->get_audit_table_name())) {
1193 $this->dbManager->dropTableName($this->get_audit_table_name());
1202 * Loads the definition of custom fields defined for the module.
1203 * Local file system cache is created as needed.
1205 * @param string $module_name setting up custom fields for this module.
1206 * @param boolean $clean_load Optional, default true, rebuilds the cache if set to true.
1208 function setupCustomFields($module_name, $clean_load=true)
1210 $this->custom_fields = new DynamicField($module_name);
1211 $this->custom_fields->setup($this);
1216 * Cleans char, varchar, text, etc. fields of XSS type materials
1218 function cleanBean() {
1219 foreach($this->field_defs as $key => $def) {
1221 if (isset($def['type'])) {
1224 if(isset($def['dbType']))
1225 $type .= $def['dbType'];
1227 if((strpos($type, 'char') !== false ||
1228 strpos($type, 'text') !== false ||
1232 $str = from_html($this->$key);
1233 // Julian's XSS cleaner
1234 $potentials = clean_xss($str, false);
1236 if(is_array($potentials) && !empty($potentials)) {
1237 foreach($potentials as $bad) {
1238 $str = str_replace($bad, "", $str);
1240 $this->$key = to_html($str);
1247 * Implements a generic insert and update logic for any SugarBean
1248 * This method only works for subclasses that implement the same variable names.
1249 * This method uses the presence of an id field that is not null to signify and update.
1250 * The id field should not be set otherwise.
1252 * @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
1253 * @todo Add support for field type validation and encoding of parameters.
1255 function save($check_notify = FALSE)
1257 // cn: SECURITY - strip XSS potential vectors
1259 // This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
1260 $this->fixUpFormatting();
1262 global $current_user, $action;
1265 if(empty($this->id))
1270 if ( $this->new_with_id == true )
1274 if(empty($this->date_modified) || $this->update_date_modified)
1276 $this->date_modified = $GLOBALS['timedate']->nowDb();
1279 $this->_checkOptimisticLocking($action, $isUpdate);
1281 if(!empty($this->modified_by_name)) $this->old_modified_by_name = $this->modified_by_name;
1282 if($this->update_modified_by)
1284 $this->modified_user_id = 1;
1286 if (!empty($current_user))
1288 $this->modified_user_id = $current_user->id;
1289 $this->modified_by_name = $current_user->user_name;
1292 if ($this->deleted != 1)
1300 if (empty($this->date_entered))
1302 $this->date_entered = $this->date_modified;
1304 if($this->set_created_by == true)
1306 // created by should always be this user
1307 $this->created_by = (isset($current_user)) ? $current_user->id : "";
1309 if( $this->new_with_id == false)
1311 $this->id = create_guid();
1313 $query = "INSERT into ";
1315 if($isUpdate && !$this->update_date_entered)
1317 unset($this->date_entered);
1319 // call the custom business logic
1320 $custom_logic_arguments['check_notify'] = $check_notify;
1323 $this->call_custom_logic("before_save", $custom_logic_arguments);
1324 unset($custom_logic_arguments);
1326 if(isset($this->custom_fields))
1328 $this->custom_fields->bean = $this;
1329 $this->custom_fields->save($isUpdate);
1332 // use the db independent query generator
1333 $this->preprocess_fields_on_save();
1335 //construct the SQL to create the audit record if auditing is enabled.
1336 $dataChanges=array();
1337 if ($this->is_AuditEnabled())
1339 if ($isUpdate && !isset($this->fetched_row))
1341 $GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
1345 $dataChanges=$this->dbManager->helper->getDataChanges($this);
1349 $this->_sendNotifications($check_notify);
1351 if ($this->db->dbType == "oci8")
1354 if ($this->db->dbType == 'mysql')
1356 // write out the SQL statement.
1357 $query .= $this->table_name." set ";
1361 foreach($this->field_defs as $field=>$value)
1363 if(!isset($value['source']) || $value['source'] == 'db')
1365 // Do not write out the id field on the update statement.
1366 // We are not allowed to change ids.
1367 if($isUpdate && ('id' == $field))
1369 //custom fields handle there save seperatley
1370 if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type']))
1373 // Only assign variables that have been set.
1374 if(isset($this->$field))
1376 //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1377 //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1378 if(!empty($value['type']) && $value['type'] == 'bool'){
1379 $this->$field = $this->getFieldValue($field);
1382 if(strlen($this->$field) <= 0)
1384 if(!$isUpdate && isset($value['default']) && (strlen($value['default']) > 0))
1386 $this->$field = $value['default'];
1390 $this->$field = null;
1393 // Try comparing this element with the head element.
1399 if(is_null($this->$field))
1401 $query .= $field."=null";
1405 //added check for ints because sql-server does not like casting varchar with a decimal value
1407 if(isset($value['type']) and $value['type']=='int') {
1408 $query .= $field."=".$this->db->quote($this->$field);
1409 } elseif ( isset($value['len']) ) {
1410 $query .= $field."='".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1412 $query .= $field."='".$this->db->quote($this->$field)."'";
1421 $query = $query." WHERE ID = '$this->id'";
1422 $GLOBALS['log']->info("Update $this->object_name: ".$query);
1426 $GLOBALS['log']->info("Insert: ".$query);
1428 $GLOBALS['log']->info("Save: $query");
1429 $this->db->query($query, true);
1431 //process if type is set to mssql
1432 if ($this->db->dbType == 'mssql')
1436 // build out the SQL UPDATE statement.
1437 $query = "UPDATE " . $this->table_name." SET ";
1439 foreach($this->field_defs as $field=>$value)
1441 if(!isset($value['source']) || $value['source'] == 'db')
1443 // Do not write out the id field on the update statement.
1444 // We are not allowed to change ids.
1445 if($isUpdate && ('id' == $field))
1448 // If the field is an auto_increment field, then we shouldn't be setting it. This was added
1449 // specially for Bugs and Cases which have a number associated with them.
1450 if ($isUpdate && isset($this->field_name_map[$field]['auto_increment']) &&
1451 $this->field_name_map[$field]['auto_increment'] == true)
1454 //custom fields handle their save seperatley
1455 if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type']))
1458 // Only assign variables that have been set.
1459 if(isset($this->$field))
1461 //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1462 //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1463 if(!empty($value['type']) && $value['type'] == 'bool'){
1464 $this->$field = $this->getFieldValue($field);
1467 if(strlen($this->$field) <= 0)
1469 if(!$isUpdate && isset($value['default']) && (strlen($value['default']) > 0))
1471 $this->$field = $value['default'];
1475 $this->$field = null;
1478 // Try comparing this element with the head element.
1484 if(is_null($this->$field))
1486 $query .= $field."=null";
1488 elseif ( isset($value['len']) )
1490 $query .= $field."='".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1494 $query .= $field."='".$this->db->quote($this->$field)."'";
1499 $query = $query." WHERE ID = '$this->id'";
1500 $GLOBALS['log']->info("Update $this->object_name: ".$query);
1506 foreach($this->field_defs as $field=>$value)
1508 if(!isset($value['source']) || $value['source'] == 'db')
1510 // Do not write out the id field on the update statement.
1511 // We are not allowed to change ids.
1512 //if($isUpdate && ('id' == $field)) continue;
1513 //custom fields handle there save seperatley
1515 if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_module']))
1518 // Only assign variables that have been set.
1519 if(isset($this->$field))
1521 //trim the value in case empty space is passed in.
1522 //this will allow default values set in db to take effect, otherwise
1523 //will insert blanks into db
1524 $trimmed_field = trim($this->$field);
1525 //if this value is empty, do not include the field value in statement
1526 if($trimmed_field =='')
1530 //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1531 //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1532 if(!empty($value['type']) && $value['type'] == 'bool'){
1533 $this->$field = $this->getFieldValue($field);
1535 //added check for ints because sql-server does not like casting varchar with a decimal value
1537 if(isset($value['type']) and $value['type']=='int') {
1538 $values[] = $this->db->quote($this->$field);
1539 } elseif ( isset($value['len']) ) {
1540 $values[] = "'".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1542 $values[] = "'".$this->db->quote($this->$field)."'";
1545 $columns[] = $field;
1549 // build out the SQL INSERT statement.
1550 $query = "INSERT INTO $this->table_name (" .implode("," , $columns). " ) VALUES ( ". implode("," , $values). ')';
1551 $GLOBALS['log']->info("Insert: ".$query);
1554 $GLOBALS['log']->info("Save: $query");
1555 $this->db->query($query, true);
1557 if (!empty($dataChanges) && is_array($dataChanges))
1559 foreach ($dataChanges as $change)
1561 $this->dbManager->helper->save_audit_records($this,$change);
1566 // let subclasses save related field changes
1567 $this->save_relationship_changes($isUpdate);
1569 //If we aren't in setup mode and we have a current user and module, then we track
1570 if(isset($GLOBALS['current_user']) && isset($this->module_dir))
1572 $this->track_view($current_user->id, $this->module_dir, 'save');
1575 $this->call_custom_logic('after_save', '');
1582 * Performs a check if the record has been modified since the specified date
1584 * @param date $date Datetime for verification
1585 * @param string $modified_user_id User modified by
1587 function has_been_modified_since($date, $modified_user_id)
1589 global $current_user;
1590 if (isset($current_user))
1592 if ($this->db->dbType == 'mssql')
1593 $date_modified_string = 'CONVERT(varchar(20), date_modified, 120)';
1595 $date_modified_string = 'date_modified';
1597 $query = "SELECT date_modified FROM $this->table_name WHERE id='$this->id' AND modified_user_id != '$current_user->id' AND (modified_user_id != '$modified_user_id' OR $date_modified_string > " . db_convert("'".$date."'", 'datetime') . ')';
1598 $result = $this->db->query($query);
1600 if($this->db->fetchByAssoc($result))
1609 * Determines which users receive a notification
1611 function get_notification_recipients() {
1612 $notify_user = new User();
1613 $notify_user->retrieve($this->assigned_user_id);
1614 $this->new_assigned_user_name = $notify_user->full_name;
1616 $GLOBALS['log']->info("Notifications: recipient is $this->new_assigned_user_name");
1618 $user_list = array($notify_user);
1621 //send notifications to followers, but ensure to not query for the assigned_user.
1622 return SugarFollowing::getFollowers($this, $notify_user);
1627 * Handles sending out email notifications when items are first assigned to users
1629 * @param string $notify_user user to notify
1630 * @param string $admin the admin user that sends out the notification
1632 function send_assignment_notifications($notify_user, $admin)
1634 global $current_user;
1636 if(($this->object_name == 'Meeting' || $this->object_name == 'Call') || $notify_user->receive_notifications)
1638 $sendToEmail = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1640 if(empty($sendToEmail)) {
1641 $GLOBALS['log']->warn("Notifications: no e-mail address set for user {$notify_user->user_name}, cancelling send");
1645 $notify_mail = $this->create_notification_email($notify_user);
1646 $notify_mail->setMailerForSystem();
1648 if(empty($admin->settings['notify_send_from_assigning_user'])) {
1649 $notify_mail->From = $admin->settings['notify_fromaddress'];
1650 $notify_mail->FromName = (empty($admin->settings['notify_fromname'])) ? "" : $admin->settings['notify_fromname'];
1652 // Send notifications from the current user's e-mail (ifset)
1653 $fromAddress = $current_user->emailAddress->getReplyToAddress($current_user);
1654 $fromAddress = !empty($fromAddress) ? $fromAddress : $admin->settings['notify_fromaddress'];
1655 $notify_mail->From = $fromAddress;
1656 //Use the users full name is available otherwise default to system name
1657 $from_name = !empty($admin->settings['notify_fromname']) ? $admin->settings['notify_fromname'] : "";
1658 $from_name = !empty($current_user->full_name) ? $current_user->full_name : $from_name;
1659 $notify_mail->FromName = $from_name;
1662 if($sendEmail && !$notify_mail->Send()) {
1663 $GLOBALS['log']->fatal("Notifications: error sending e-mail (method: {$notify_mail->Mailer}), (error: {$notify_mail->ErrorInfo})");
1665 $GLOBALS['log']->fatal("Notifications: e-mail successfully sent");
1672 * This function handles create the email notifications email.
1673 * @param string $notify_user the user to send the notification email to
1675 function create_notification_email($notify_user) {
1676 global $sugar_version;
1677 global $sugar_config;
1678 global $app_list_strings;
1679 global $current_user;
1682 $OBCharset = $locale->getPrecedentPreference('default_email_charset');
1685 require_once("include/SugarPHPMailer.php");
1687 $notify_address = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1688 $notify_name = $notify_user->full_name;
1689 $GLOBALS['log']->debug("Notifications: user has e-mail defined");
1691 $notify_mail = new SugarPHPMailer();
1692 $notify_mail->AddAddress($notify_address,$locale->translateCharsetMIME(trim($notify_name), 'UTF-8', $OBCharset));
1694 if(empty($_SESSION['authenticated_user_language'])) {
1695 $current_language = $sugar_config['default_language'];
1697 $current_language = $_SESSION['authenticated_user_language'];
1699 $xtpl = new XTemplate(get_notify_template_file($current_language));
1700 if($this->module_dir == "Cases") {
1701 $template_name = "Case"; //we should use Case, you can refer to the en_us.notify_template.html.
1704 $template_name = $beanList[$this->module_dir]; //bug 20637, in workflow this->object_name = strange chars.
1707 $this->current_notify_user = $notify_user;
1709 if(in_array('set_notification_body', get_class_methods($this))) {
1710 $xtpl = $this->set_notification_body($xtpl, $this);
1712 $xtpl->assign("OBJECT", $this->object_name);
1713 $template_name = "Default";
1715 if(!empty($_SESSION["special_notification"]) && $_SESSION["special_notification"]) {
1716 $template_name = $beanList[$this->module_dir].'Special';
1718 if($this->special_notification) {
1719 $template_name = $beanList[$this->module_dir].'Special';
1721 $xtpl->assign("ASSIGNED_USER", $this->new_assigned_user_name);
1722 $xtpl->assign("ASSIGNER", $current_user->name);
1725 if(isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
1726 $port = $_SERVER['SERVER_PORT'];
1729 if (!isset($_SERVER['HTTP_HOST'])) {
1730 $_SERVER['HTTP_HOST'] = '';
1733 $httpHost = $_SERVER['HTTP_HOST'];
1735 if($colon = strpos($httpHost, ':')) {
1736 $httpHost = substr($httpHost, 0, $colon);
1739 $parsedSiteUrl = parse_url($sugar_config['site_url']);
1740 $host = $parsedSiteUrl['host'];
1741 if(!isset($parsedSiteUrl['port'])) {
1742 $parsedSiteUrl['port'] = 80;
1745 $port = ($parsedSiteUrl['port'] != 80) ? ":".$parsedSiteUrl['port'] : '';
1746 $path = !empty($parsedSiteUrl['path']) ? $parsedSiteUrl['path'] : "";
1747 $cleanUrl = "{$parsedSiteUrl['scheme']}://{$host}{$port}{$path}";
1749 $xtpl->assign("URL", $cleanUrl."/index.php?module={$this->module_dir}&action=DetailView&record={$this->id}");
1750 $xtpl->assign("SUGAR", "Sugar v{$sugar_version}");
1751 $xtpl->parse($template_name);
1752 $xtpl->parse($template_name . "_Subject");
1754 $notify_mail->Body = from_html(trim($xtpl->text($template_name)));
1755 $notify_mail->Subject = from_html($xtpl->text($template_name . "_Subject"));
1757 // cn: bug 8568 encode notify email in User's outbound email encoding
1758 $notify_mail->prepForOutbound();
1760 return $notify_mail;
1764 * This function is a good location to save changes that have been made to a relationship.
1765 * This should be overriden in subclasses that have something to save.
1767 * @param $is_update true if this save is an update.
1769 function save_relationship_changes($is_update, $exclude=array())
1771 $new_rel_id = false;
1772 $new_rel_link = false;
1773 //this allows us to dynamically relate modules without adding it to the relationship_fields array
1774 if(!empty($_REQUEST['relate_id']) && !in_array($_REQUEST['relate_to'], $exclude) && $_REQUEST['relate_id'] != $this->id){
1775 $new_rel_id = $_REQUEST['relate_id'];
1776 $new_rel_relname = $_REQUEST['relate_to'];
1777 if(!empty($this->in_workflow) && !empty($this->not_use_rel_in_req)) {
1778 $new_rel_id = $this->new_rel_id;
1779 $new_rel_relname = $this->new_rel_relname;
1781 $new_rel_link = $new_rel_relname;
1782 //Try to find the link in this bean based on the relationship
1783 foreach ( $this->field_defs as $key => $def ) {
1784 if (isset($def['type']) && $def['type'] == 'link'
1785 && isset($def['relationship']) && $def['relationship'] == $new_rel_relname) {
1786 $new_rel_link = $key;
1791 // First we handle the preset fields listed in the fixed relationship_fields array hardcoded into the OOB beans
1792 // TODO: remove this mechanism and replace with mechanism exclusively based on the vardefs
1793 if (isset($this->relationship_fields) && is_array($this->relationship_fields))
1795 foreach ($this->relationship_fields as $id=>$rel_name)
1798 if(in_array($id, $exclude))continue;
1800 if(!empty($this->$id))
1802 $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - adding a relationship record: '.$rel_name . ' = ' . $this->$id);
1803 //already related the new relationship id so let's set it to false so we don't add it again using the _REQUEST['relate_i'] mechanism in a later block
1804 if($this->$id == $new_rel_id){
1805 $new_rel_id = false;
1807 $this->load_relationship($rel_name);
1808 $this->$rel_name->add($this->$id);
1813 //if before value is not empty then attempt to delete relationship
1814 if(!empty($this->rel_fields_before_value[$id]))
1816 $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - attempting to remove the relationship record, using relationship attribute'.$rel_name);
1817 $this->load_relationship($rel_name);
1818 $this->$rel_name->delete($this->id,$this->rel_fields_before_value[$id]);
1824 /* Next, we'll attempt to update all of the remaining relate fields in the vardefs that have 'save' set in their field_def
1825 Only the 'save' fields should be saved as some vardef entries today are not for display only purposes and break the application if saved
1826 If the vardef has entries for field <a> of type relate, where a->id_name = <b> and field <b> of type link
1827 then we receive a value for b from the MVC in the _REQUEST, and it should be set in the bean as $this->$b
1830 foreach ( $this->field_defs as $def )
1832 if ($def [ 'type' ] == 'relate' && isset ( $def [ 'id_name'] ) && isset ( $def [ 'link'] ) && isset ( $def[ 'save' ]) )
1834 if ( in_array( $def['id_name'], $exclude) || in_array( $def['id_name'], $this->relationship_fields ) )
1835 continue ; // continue to honor the exclude array and exclude any relationships that will be handled by the relationship_fields mechanism
1837 if (isset( $this->field_defs[ $def [ 'link' ] ] ))
1840 $linkfield = $this->field_defs[$def [ 'link' ]] ;
1842 if ($this->load_relationship ( $def [ 'link' ])){
1843 if (!empty($this->rel_fields_before_value[$def [ 'id_name' ]]))
1845 //if before value is not empty then attempt to delete relationship
1846 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to remove the relationship record: {$def [ 'link' ]} = {$this->rel_fields_before_value[$def [ 'id_name' ]]}");
1847 $this->$def ['link' ]->delete($this->id, $this->rel_fields_before_value[$def [ 'id_name' ]] );
1849 if (!empty($this->$def['id_name']) && is_string($this->$def['id_name']))
1851 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to add a relationship record - {$def [ 'link' ]} = {$this->$def [ 'id_name' ]}" );
1852 $this->$def ['link' ]->add($this->$def['id_name']);
1855 $GLOBALS['log']->fatal("Failed to load relationship {$def [ 'link' ]} while saving {$this->module_dir}");
1861 // Finally, we update a field listed in the _REQUEST['*/relate_id']/_REQUEST['relate_to'] mechanism (if it hasn't already been updated above)
1862 if(!empty($new_rel_id)){
1864 if($this->load_relationship($new_rel_link)){
1865 $this->$new_rel_link->add($new_rel_id);
1868 $lower_link = strtolower($new_rel_link);
1869 if($this->load_relationship($lower_link)){
1870 $this->$lower_link->add($new_rel_id);
1873 require_once('data/Link.php');
1874 $rel = Relationship::retrieve_by_modules($new_rel_link, $this->module_dir, $GLOBALS['db'], 'many-to-many');
1877 foreach($this->field_defs as $field=>$def){
1878 if($def['type'] == 'link' && !empty($def['relationship']) && $def['relationship'] == $rel){
1879 $this->load_relationship($field);
1880 $this->$field->add($new_rel_id);
1886 //ok so we didn't find it in the field defs let's save it anyway if we have the relationshp
1888 $this->$rel=new Link($rel, $this, array());
1889 $this->$rel->add($new_rel_id);
1900 * This function retrieves a record of the appropriate type from the DB.
1901 * It fills in all of the fields from the DB into the object it was called on.
1903 * @param $id - If ID is specified, it overrides the current value of $this->id. If not specified the current value of $this->id will be used.
1904 * @return this - The object that it was called apon or null if exactly 1 record was not found.
1908 function check_date_relationships_load()
1910 global $disable_date_format;
1912 if (empty($timedate))
1913 $timedate=TimeDate::getInstance();
1915 if(empty($this->field_defs))
1919 foreach($this->field_defs as $fieldDef)
1921 $field = $fieldDef['name'];
1922 if(!isset($this->processed_dates_times[$field]))
1924 $this->processed_dates_times[$field] = '1';
1925 if(empty($this->$field)) continue;
1926 if($field == 'date_modified' || $field == 'date_entered')
1928 $this->$field = from_db_convert($this->$field, 'datetime');
1929 if(empty($disable_date_format)) {
1930 $this->$field = $timedate->to_display_date_time($this->$field);
1933 elseif(isset($this->field_name_map[$field]['type']))
1935 $type = $this->field_name_map[$field]['type'];
1937 if($type == 'relate' && isset($this->field_name_map[$field]['custom_module']))
1939 $type = $this->field_name_map[$field]['type'];
1944 $this->$field = from_db_convert($this->$field, 'date');
1946 if($this->$field == '0000-00-00')
1949 } elseif(!empty($this->field_name_map[$field]['rel_field']))
1951 $rel_field = $this->field_name_map[$field]['rel_field'];
1953 if(!empty($this->$rel_field))
1955 $this->$rel_field=from_db_convert($this->$rel_field, 'time');
1956 if(empty($disable_date_format)) {
1957 $mergetime = $timedate->merge_date_time($this->$field,$this->$rel_field);
1958 $this->$field = $timedate->to_display_date($mergetime);
1959 $this->$rel_field = $timedate->to_display_time($mergetime);
1965 if(empty($disable_date_format)) {
1966 $this->$field = $timedate->to_display_date($this->$field, false);
1969 } elseif($type == 'datetime' || $type == 'datetimecombo')
1971 if($this->$field == '0000-00-00 00:00:00')
1977 $this->$field = from_db_convert($this->$field, 'datetime');
1978 if(empty($disable_date_format)) {
1979 $this->$field = $timedate->to_display_date_time($this->$field, true, true);
1982 } elseif($type == 'time')
1984 if($this->$field == '00:00:00')
1989 //$this->$field = from_db_convert($this->$field, 'time');
1990 if(empty($this->field_name_map[$field]['rel_field']) && empty($disable_date_format))
1992 $this->$field = $timedate->to_display_time($this->$field,true, false);
1995 } elseif($type == 'encrypt' && empty($disable_date_format)){
1996 $this->$field = $this->decrypt_after_retrieve($this->$field);
2004 * This function processes the fields before save.
2005 * Interal function, do not override.
2007 function preprocess_fields_on_save()
2009 $GLOBALS['log']->deprecated('SugarBean.php: preprocess_fields_on_save() is deprecated');
2013 * Removes formatting from values posted from the user interface.
2014 * It only unformats numbers. Function relies on user/system prefernce for format strings.
2016 * Internal Function, do not override.
2018 function unformat_all_fields()
2020 $GLOBALS['log']->deprecated('SugarBean.php: unformat_all_fields() is deprecated');
2024 * This functions adds formatting to all number fields before presenting them to user interface.
2026 * Internal function, do not override.
2028 function format_all_fields()
2030 $GLOBALS['log']->deprecated('SugarBean.php: format_all_fields() is deprecated');
2033 function format_field($fieldDef)
2035 $GLOBALS['log']->deprecated('SugarBean.php: format_field() is deprecated');
2039 * Function corrects any bad formatting done by 3rd party/custom code
2041 * This function will be removed in a future release, it is only here to assist upgrading existing code that expects formatted data in the bean
2043 function fixUpFormatting()
2046 static $boolean_false_values = array('off', 'false', '0', 'no');
2049 foreach($this->field_defs as $field=>$def)
2051 if ( !isset($this->$field) ) {
2054 if ( (isset($def['source'])&&$def['source']=='non-db') || $field == 'deleted' ) {
2057 if ( isset($this->fetched_row[$field]) && $this->$field == $this->fetched_row[$field] ) {
2058 // Don't hand out warnings because the field was untouched between retrieval and saving, most database drivers hand pretty much everything back as strings.
2061 $reformatted = false;
2062 switch($def['type']) {
2064 case 'datetimecombo':
2065 if(empty($this->$field)) break;
2066 if ($this->$field == 'NULL') {
2070 if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$/',$this->$field) ) {
2071 // This appears to be formatted in user date/time
2072 $this->$field = $timedate->to_db($this->$field);
2073 $reformatted = true;
2077 if(empty($this->$field)) break;
2078 if ($this->$field == 'NULL') {
2082 if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/',$this->$field) ) {
2083 // This date appears to be formatted in the user's format
2084 $this->$field = $timedate->to_db_date($this->$field, false);
2085 $reformatted = true;
2089 if(empty($this->$field)) break;
2090 if ($this->$field == 'NULL') {
2094 if ( preg_match('/(am|pm)/i',$this->$field) ) {
2095 // This time appears to be formatted in the user's format
2096 $this->$field = $timedate->fromUserTime($this->$field)->format(TimeDate::DB_TIME_FORMAT);
2097 $reformatted = true;
2104 if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2107 if ( is_string($this->$field) ) {
2108 $this->$field = (float)unformat_number($this->$field);
2109 $reformatted = true;
2118 if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2121 if ( is_string($this->$field) ) {
2122 $this->$field = (int)unformat_number($this->$field);
2123 $reformatted = true;
2127 if (empty($this->$field)) {
2128 $this->$field = false;
2129 } else if(true === $this->$field || 1 == $this->$field) {
2130 $this->$field = true;
2131 } else if(in_array(strval($this->$field), $boolean_false_values)) {
2132 $this->$field = false;
2133 $reformatted = true;
2135 $this->$field = true;
2136 $reformatted = true;
2140 $this->$field = $this->encrpyt_before_save($this->$field);
2143 if ( $reformatted ) {
2144 $GLOBALS['log']->deprecated('Formatting correction: '.$this->module_dir.'->'.$field.' had formatting automatically corrected. This will be removed in the future, please upgrade your external code');
2151 * Function fetches a single row of data given the primary key value.
2153 * The fetched data is then set into the bean. The function also processes the fetched data by formattig
2154 * date/time and numeric values.
2156 * @param string $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
2157 * @param boolean $encode Optional, default true, encodes the values fetched from the database.
2158 * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
2160 * Internal function, do not override.
2162 function retrieve($id = -1, $encode=true,$deleted=true)
2165 $custom_logic_arguments['id'] = $id;
2166 $this->call_custom_logic('before_retrieve', $custom_logic_arguments);
2172 if(isset($this->custom_fields))
2174 $custom_join = $this->custom_fields->getJOIN();
2177 $custom_join = false;
2181 $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name ";
2185 $query = "SELECT $this->table_name.* FROM $this->table_name ";
2190 $query .= ' ' . $custom_join['join'];
2192 $query .= " WHERE $this->table_name.id = '$id' ";
2193 if ($deleted) $query .= " AND $this->table_name.deleted=0";
2194 $GLOBALS['log']->debug("Retrieve $this->object_name : ".$query);
2195 //requireSingleResult has beeen deprecated.
2196 //$result = $this->db->requireSingleResult($query, true, "Retrieving record by id $this->table_name:$id found ");
2197 $result = $this->db->limitQuery($query,0,1,true, "Retrieving record by id $this->table_name:$id found ");
2203 $row = $this->db->fetchByAssoc($result, -1, $encode);
2209 //make copy of the fetched row for construction of audit record and for business logic/workflow
2210 $this->fetched_row=$row;
2211 $this->populateFromRow($row);
2213 global $module, $action;
2214 //Just to get optimistic locking working for this release
2215 if($this->optimistic_lock && $module == $this->module_dir && $action =='EditView' )
2217 $_SESSION['o_lock_id']= $id;
2218 $_SESSION['o_lock_dm']= $this->date_modified;
2219 $_SESSION['o_lock_on'] = $this->object_name;
2221 $this->processed_dates_times = array();
2222 $this->check_date_relationships_load();
2226 $this->custom_fields->fill_relationships();
2229 $this->fill_in_additional_detail_fields();
2230 $this->fill_in_relationship_fields();
2231 //make a copy of fields in the relatiosnhip_fields array. these field values will be used to
2232 //clear relatioship.
2233 foreach ( $this->field_defs as $key => $def )
2235 if ($def [ 'type' ] == 'relate' && isset ( $def [ 'id_name'] ) && isset ( $def [ 'link'] ) && isset ( $def[ 'save' ])) {
2236 if (isset($this->$key)) {
2237 $this->rel_fields_before_value[$key]=$this->$key;
2238 if (isset($this->$def [ 'id_name']))
2239 $this->rel_fields_before_value[$def [ 'id_name']]=$this->$def [ 'id_name'];
2242 $this->rel_fields_before_value[$key]=null;
2245 if (isset($this->relationship_fields) && is_array($this->relationship_fields))
2247 foreach ($this->relationship_fields as $rel_id=>$rel_name)
2249 if (isset($this->$rel_id))
2250 $this->rel_fields_before_value[$rel_id]=$this->$rel_id;
2252 $this->rel_fields_before_value[$rel_id]=null;
2256 // call the custom business logic
2257 $custom_logic_arguments['id'] = $id;
2258 $custom_logic_arguments['encode'] = $encode;
2259 $this->call_custom_logic("after_retrieve", $custom_logic_arguments);
2260 unset($custom_logic_arguments);
2265 * Sets value from fetched row into the bean.
2267 * @param array $row Fetched row
2268 * @todo loop through vardefs instead
2269 * @internal runs into an issue when populating from field_defs for users - corrupts user prefs
2271 * Internal function, do not override.
2273 function populateFromRow($row)
2276 foreach($this->field_defs as $field=>$field_value)
2278 if($field == 'user_preferences' && $this->module_dir == 'Users')
2280 $rfield = $field; // fetch returns it in lowercase only
2281 if(isset($row[$rfield]))
2283 $this->$field = $row[$rfield];
2284 $owner = $rfield . '_owner';
2285 if(!empty($row[$owner])){
2286 $this->$owner = $row[$owner];
2291 $this->$field = $nullvalue;
2299 * Add any required joins to the list count query. The joins are required if there
2300 * is a field in the $where clause that needs to be joined.
2302 * @param string $query
2303 * @param string $where
2305 * Internal Function, do Not override.
2307 function add_list_count_joins(&$query, $where)
2309 $custom_join = $this->custom_fields->getJOIN();
2312 $query .= $custom_join['join'];
2318 * Changes the select expression of the given query to be 'count(*)' so you
2319 * can get the number of items the query will return. This is used to
2320 * populate the upper limit on ListViews.
2322 * @param string $query Select query string
2323 * @return string count query
2325 * Internal function, do not override.
2327 function create_list_count_query($query)
2329 // remove the 'order by' clause which is expected to be at the end of the query
2330 $pattern = '/\sORDER BY.*/is'; // ignores the case
2332 $query = preg_replace($pattern, $replacement, $query);
2333 //handle distinct clause
2335 if(substr_count(strtolower($query), 'distinct')){
2336 if (!empty($this->seed) && !empty($this->seed->table_name ))
2337 $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2339 $star = 'DISTINCT ' . $this->table_name . '.id';
2343 // change the select expression to 'count(*)'
2344 $pattern = '/SELECT(.*?)(\s){1}FROM(\s){1}/is'; // ignores the case
2345 $replacement = 'SELECT count(' . $star . ') c FROM ';
2347 //if the passed query has union clause then replace all instances of the pattern.
2348 //this is very rare. I have seen this happening only from projects module.
2349 //in addition to this added a condition that has union clause and uses
2351 if (strstr($query," UNION ALL ") !== false) {
2353 //seperate out all the queries.
2354 $union_qs=explode(" UNION ALL ", $query);
2355 foreach ($union_qs as $key=>$union_query) {
2357 preg_match($pattern, $union_query, $matches);
2358 if (!empty($matches)) {
2359 if (stristr($matches[0], "distinct")) {
2360 if (!empty($this->seed) && !empty($this->seed->table_name ))
2361 $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2363 $star = 'DISTINCT ' . $this->table_name . '.id';
2366 $replacement = 'SELECT count(' . $star . ') c FROM ';
2367 $union_qs[$key] = preg_replace($pattern, $replacement, $union_query,1);
2369 $modified_select_query=implode(" UNION ALL ",$union_qs);
2371 $modified_select_query = preg_replace($pattern, $replacement, $query,1);
2374 return $modified_select_query;
2378 * This function returns a paged list of the current object type. It is intended to allow for
2379 * hopping back and forth through pages of data. It only retrieves what is on the current page.
2381 * @internal This method must be called on a new instance. It trashes the values of all the fields in the current one.
2382 * @param string $order_by
2383 * @param string $where Additional where clause
2384 * @param int $row_offset Optaional,default 0, starting row number
2385 * @param init $limit Optional, default -1
2386 * @param int $max Optional, default -1
2387 * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
2388 * @return array Fetched data.
2390 * Internal function, do not override.
2393 function get_list($order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $singleSelect=false)
2395 $GLOBALS['log']->debug("get_list: order_by = '$order_by' and where = '$where' and limit = '$limit'");
2396 if(isset($_SESSION['show_deleted']))
2400 $order_by=$this->process_order_by($order_by, null);
2402 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2404 global $current_user;
2405 $owner_where = $this->getOwnerWhere($current_user->id);
2407 //rrs - because $this->getOwnerWhere() can return '' we need to be sure to check for it and
2408 //handle it properly else you could get into a situation where you are create a where stmt like
2410 if(!empty($owner_where)){
2412 $where = $owner_where;
2414 $where .= ' AND '. $owner_where;
2418 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted,'',false,null,$singleSelect);
2419 return $this->process_list_query($query, $row_offset, $limit, $max, $where);
2423 * Prefixes column names with this bean's table name.
2424 * This call can be ignored for mysql since it does a better job than Oracle in resolving ambiguity.
2426 * @param string $order_by Order by clause to be processed
2427 * @param string $submodule name of the module this order by clause is for
2428 * @return string Processed order by clause
2430 * Internal function, do not override.
2432 function process_order_by ($order_by, $submodule)
2434 if (empty($order_by))
2437 //submodule is empty,this is for list object in focus
2438 if (empty($submodule))
2440 $bean_queried = &$this;
2444 //submodule is set, so this is for subpanel, use submodule
2445 $bean_queried = $submodule;
2447 $elements = explode(',',$order_by);
2448 foreach ($elements as $key=>$value)
2450 if (strchr($value,'.') === false)
2452 //value might have ascending and descending decorations
2453 $list_column = explode(' ',trim($value));
2454 if (isset($list_column[0]))
2456 $list_column_name=trim($list_column[0]);
2457 if (isset($bean_queried->field_defs[$list_column_name]))
2459 $source=isset($bean_queried->field_defs[$list_column_name]['source']) ? $bean_queried->field_defs[$list_column_name]['source']:'db';
2460 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='db')
2462 $list_column[0] = $bean_queried->table_name .".".$list_column[0] ;
2464 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='custom_fields')
2466 $list_column[0] = $bean_queried->table_name ."_cstm.".$list_column[0] ;
2468 $value = implode($list_column,' ');
2469 // Bug 38803 - Use CONVERT() function when doing an order by on ntext, text, and image fields
2470 if ( $this->db->dbType == 'mssql'
2471 && $source != 'non-db'
2473 $this->db->getHelper()->getColumnType($this->db->getHelper()->getFieldType($bean_queried->field_defs[$list_column_name])),
2474 array('ntext','text','image')
2477 $value = "CONVERT(varchar(500),{$list_column[0]}) {$list_column[1]}";
2479 // Bug 29011 - Use TO_CHAR() function when doing an order by on a clob field
2480 if ( $this->db->dbType == 'oci8'
2481 && $source != 'non-db'
2483 $this->db->getHelper()->getColumnType($this->db->getHelper()->getFieldType($bean_queried->field_defs[$list_column_name])),
2487 $value = "TO_CHAR({$list_column[0]}) {$list_column[1]}";
2492 $GLOBALS['log']->debug("process_order_by: ($list_column[0]) does not have a vardef entry.");
2496 $elements[$key]=$value;
2498 return implode($elements,',');
2504 * Returns a detail object like retrieving of the current object type.
2506 * It is intended for use in navigation buttons on the DetailView. It will pass an offset and limit argument to the sql query.
2507 * @internal This method must be called on a new instance. It overrides the values of all the fields in the current one.
2509 * @param string $order_by
2510 * @param string $where Additional where clause
2511 * @param int $row_offset Optaional,default 0, starting row number
2512 * @param init $limit Optional, default -1
2513 * @param int $max Optional, default -1
2514 * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
2515 * @return array Fetched data.
2517 * Internal function, do not override.
2519 function get_detail($order_by = "", $where = "", $offset = 0, $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2521 $GLOBALS['log']->debug("get_detail: order_by = '$order_by' and where = '$where' and limit = '$limit' and offset = '$offset'");
2522 if(isset($_SESSION['show_deleted']))
2527 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2529 global $current_user;
2530 $owner_where = $this->getOwnerWhere($current_user->id);
2534 $where = $owner_where;
2538 $where .= ' AND '. $owner_where;
2541 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted, $offset);
2543 //Add Limit and Offset to query
2544 //$query .= " LIMIT 1 OFFSET $offset";
2546 return $this->process_detail_query($query, $row_offset, $limit, $max, $where, $offset);
2550 * Fetches data from all related tables.
2552 * @param object $child_seed
2553 * @param string $related_field_name relation to fetch data for
2554 * @param string $order_by Optional, default empty
2555 * @param string $where Optional, additional where clause
2556 * @return array Fetched data.
2558 * Internal function, do not override.
2560 function get_related_list($child_seed,$related_field_name, $order_by = "", $where = "",
2561 $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2563 global $layout_edit_mode;
2564 if(isset($layout_edit_mode) && $layout_edit_mode)
2566 $response = array();
2567 $child_seed->assign_display_fields($child_seed->module_dir);
2568 $response['list'] = array($child_seed);
2569 $response['row_count'] = 1;
2570 $response['next_offset'] = 0;
2571 $response['previous_offset'] = 0;
2575 $GLOBALS['log']->debug("get_related_list: order_by = '$order_by' and where = '$where' and limit = '$limit'");
2576 if(isset($_SESSION['show_deleted']))
2581 $this->load_relationship($related_field_name);
2582 $query_array = $this->$related_field_name->getQuery(true);
2583 $entire_where = $query_array['where'];
2586 if(empty($entire_where))
2588 $entire_where = ' WHERE ' . $where;
2592 $entire_where .= ' AND ' . $where;
2596 $query = 'SELECT '.$child_seed->table_name.'.* ' . $query_array['from'] . ' ' . $entire_where;
2597 if(!empty($order_by))
2599 $query .= " ORDER BY " . $order_by;
2602 return $child_seed->process_list_query($query, $row_offset, $limit, $max, $where);
2606 protected static function build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by)
2608 global $layout_edit_mode, $beanFiles, $beanList;
2609 $subqueries = array();
2610 foreach($subpanel_list as $this_subpanel)
2612 if(!$this_subpanel->isDatasourceFunction() || ($this_subpanel->isDatasourceFunction()
2613 && isset($this_subpanel->_instance_properties['generate_select'])
2614 && $this_subpanel->_instance_properties['generate_select']==true))
2616 //the custom query function must return an array with
2617 if ($this_subpanel->isDatasourceFunction()) {
2618 $shortcut_function_name = $this_subpanel->get_data_source_name();
2619 $parameters=$this_subpanel->get_function_parameters();
2620 if (!empty($parameters))
2622 //if the import file function is set, then import the file to call the custom function from
2623 if (is_array($parameters) && isset($parameters['import_function_file'])){
2624 //this call may happen multiple times, so only require if function does not exist
2625 if(!function_exists($shortcut_function_name)){
2626 require_once($parameters['import_function_file']);
2628 //call function from required file
2629 $query_array = $shortcut_function_name($parameters);
2631 //call function from parent bean
2632 $query_array = $parentbean->$shortcut_function_name($parameters);
2637 $query_array = $parentbean->$shortcut_function_name();
2640 $related_field_name = $this_subpanel->get_data_source_name();
2641 if (!$parentbean->load_relationship($related_field_name)){
2642 unset ($parentbean->$related_field_name);
2645 $query_array = $parentbean->$related_field_name->getQuery(true,array(),0,'',true, null, null, true);
2647 $table_where = $this_subpanel->get_where();
2648 $where_definition = $query_array['where'];
2650 if(!empty($table_where))
2652 if(empty($where_definition))
2654 $where_definition = $table_where;
2658 $where_definition .= ' AND ' . $table_where;
2662 $submodulename = $this_subpanel->_instance_properties['module'];
2663 $submoduleclass = $beanList[$submodulename];
2664 //require_once($beanFiles[$submoduleclass]);
2665 $submodule = new $submoduleclass();
2666 $subwhere = $where_definition;
2670 $subwhere = str_replace('WHERE', '', $subwhere);
2671 $list_fields = $this_subpanel->get_list_fields();
2672 foreach($list_fields as $list_key=>$list_field)
2674 if(isset($list_field['usage']) && $list_field['usage'] == 'display_only')
2676 unset($list_fields[$list_key]);
2679 if(!$subpanel_def->isCollection() && isset($list_fields[$order_by]) && isset($submodule->field_defs[$order_by])&& (!isset($submodule->field_defs[$order_by]['source']) || $submodule->field_defs[$order_by]['source'] == 'db'))
2681 $order_by = $submodule->table_name .'.'. $order_by;
2683 $table_name = $this_subpanel->table_name;
2684 $panel_name=$this_subpanel->name;
2686 $params['distinct'] = $this_subpanel->distinct_query();
2688 $params['joined_tables'] = $query_array['join_tables'];
2689 $params['include_custom_fields'] = !$subpanel_def->isCollection();
2690 $params['collection_list'] = $subpanel_def->get_inst_prop_value('collection_list');
2692 $subquery = $submodule->create_new_list_query('',$subwhere ,$list_fields,$params, 0,'', true,$parentbean);
2694 $subquery['select'] = $subquery['select']." , '$panel_name' panel_name ";
2695 $subquery['from'] = $subquery['from'].$query_array['join'];
2696 $subquery['query_array'] = $query_array;
2697 $subquery['params'] = $params;
2699 $subqueries[] = $subquery;
2706 * Constructs a query to fetch data for supanels and list views
2708 * It constructs union queries for activities subpanel.
2710 * @param Object $parentbean constructing queries for link attributes in this bean
2711 * @param string $order_by Optional, order by clause
2712 * @param string $sort_order Optional, sort order
2713 * @param string $where Optional, additional where clause
2715 * Internal Function, do not overide.
2717 function get_union_related_list($parentbean, $order_by = "", $sort_order='', $where = "",
2718 $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $subpanel_def)
2720 $secondary_queries = array();
2721 global $layout_edit_mode, $beanFiles, $beanList;
2723 if(isset($_SESSION['show_deleted']))
2728 $final_query_rows = '';
2729 $subpanel_list=array();
2730 if ($subpanel_def->isCollection())
2732 $subpanel_def->load_sub_subpanels();
2733 $subpanel_list=$subpanel_def->sub_subpanels;
2737 $subpanel_list[]=$subpanel_def;
2742 //Breaking the building process into two loops. The first loop gets a list of all the sub-queries.
2743 //The second loop merges the queries and forces them to select the same number of columns
2744 //All columns in a sub-subpanel group must have the same aliases
2745 //If the subpanel is a datasource function, it can't be a collection so we just poll that function for the and return that
2746 foreach($subpanel_list as $this_subpanel)
2748 if($this_subpanel->isDatasourceFunction() && empty($this_subpanel->_instance_properties['generate_select']))
2750 $shortcut_function_name = $this_subpanel->get_data_source_name();
2751 $parameters=$this_subpanel->get_function_parameters();
2752 if (!empty($parameters))
2754 //if the import file function is set, then import the file to call the custom function from
2755 if (is_array($parameters) && isset($parameters['import_function_file'])){
2756 //this call may happen multiple times, so only require if function does not exist
2757 if(!function_exists($shortcut_function_name)){
2758 require_once($parameters['import_function_file']);
2760 //call function from required file
2761 $tmp_final_query = $shortcut_function_name($parameters);
2763 //call function from parent bean
2764 $tmp_final_query = $parentbean->$shortcut_function_name($parameters);
2769 $tmp_final_query = $parentbean->$shortcut_function_name();
2773 $final_query_rows .= ' UNION ALL ( '.$parentbean->create_list_count_query($tmp_final_query, $parameters) . ' )';
2774 $final_query .= ' UNION ALL ( '.$tmp_final_query . ' )';
2776 $final_query_rows = '(' . $parentbean->create_list_count_query($tmp_final_query, $parameters) . ')';
2777 $final_query = '(' . $tmp_final_query . ')';
2782 //If final_query is still empty, its time to build the sub-queries
2783 if (empty($final_query))
2785 $subqueries = SugarBean::build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by);
2786 $all_fields = array();
2787 foreach($subqueries as $i => $subquery)
2789 $query_fields = $GLOBALS['db']->helper->getSelectFieldsFromQuery($subquery['select']);
2790 foreach($query_fields as $field => $select)
2792 if (!in_array($field, $all_fields))
2793 $all_fields[] = $field;
2795 $subqueries[$i]['query_fields'] = $query_fields;
2798 //Now ensure the queries have the same set of fields in the same order.
2799 foreach($subqueries as $subquery)
2801 $subquery['select'] = "SELECT";
2802 foreach($all_fields as $field)
2804 if (!isset($subquery['query_fields'][$field]))
2806 $subquery['select'] .= " ' ' $field,";
2810 $subquery['select'] .= " {$subquery['query_fields'][$field]},";
2813 $subquery['select'] = substr($subquery['select'], 0 , strlen($subquery['select']) - 1);
2814 //Put the query into the final_query
2815 $query = $subquery['select'] . " " . $subquery['from'] . " " . $subquery['where'];
2818 $query = ' UNION ALL ( '.$query . ' )';
2819 $final_query_rows .= " UNION ALL ";
2821 $query = '(' . $query . ')';
2824 $query_array = $subquery['query_array'];
2825 $select_position=strpos($query_array['select'],"SELECT");
2826 $distinct_position=strpos($query_array['select'],"DISTINCT");
2827 if ($select_position !== false && $distinct_position!= false)
2829 $query_rows = "( ".substr_replace($query_array['select'],"SELECT count(",$select_position,6). ")" . $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2833 //resort to default behavior.
2834 $query_rows = "( SELECT count(*)". $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2836 if(!empty($subquery['secondary_select']))
2839 $subquerystring= $subquery['secondary_select'] . $subquery['secondary_from'].$query_array['join']. $subquery['where'];
2840 if (!empty($subquery['secondary_where']))
2842 if (empty($subquery['where']))
2844 $subquerystring.=" WHERE " .$subquery['secondary_where'];
2848 $subquerystring.=" AND " .$subquery['secondary_where'];
2851 $secondary_queries[]=$subquerystring;
2853 $final_query .= $query;
2854 $final_query_rows .= $query_rows;
2858 if(!empty($order_by))
2861 if(!$subpanel_def->isCollection())
2863 $submodulename = $subpanel_def->_instance_properties['module'];
2864 $submoduleclass = $beanList[$submodulename];
2865 $submodule = new $submoduleclass();
2867 if(!empty($submodule) && !empty($submodule->table_name))
2869 $final_query .= " ORDER BY " .$parentbean->process_order_by($order_by, $submodule);
2874 $final_query .= " ORDER BY ". $order_by . ' ';
2876 if(!empty($sort_order))
2878 $final_query .= ' ' .$sort_order;
2883 if(isset($layout_edit_mode) && $layout_edit_mode)
2885 $response = array();
2886 if(!empty($submodule))
2888 $submodule->assign_display_fields($submodule->module_dir);
2889 $response['list'] = array($submodule);
2893 $response['list'] = array();
2895 $response['parent_data'] = array();
2896 $response['row_count'] = 1;
2897 $response['next_offset'] = 0;
2898 $response['previous_offset'] = 0;
2903 return $parentbean->process_union_list_query($parentbean, $final_query, $row_offset, $limit, $max, '',$subpanel_def, $final_query_rows, $secondary_queries);
2908 * Returns a full (ie non-paged) list of the current object type.
2910 * @param string $order_by the order by SQL parameter. defaults to ""
2911 * @param string $where where clause. defaults to ""
2912 * @param boolean $check_dates. defaults to false
2913 * @param int $show_deleted show deleted records. defaults to 0
2915 function get_full_list($order_by = "", $where = "", $check_dates=false, $show_deleted = 0)
2917 $GLOBALS['log']->debug("get_full_list: order_by = '$order_by' and where = '$where'");
2918 if(isset($_SESSION['show_deleted']))
2922 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted);
2923 return $this->process_full_list_query($query, $check_dates);
2927 * Return the list query used by the list views and export button. Next generation of create_new_list_query function.
2929 * Override this function to return a custom query.
2931 * @param string $order_by custom order by clause
2932 * @param string $where custom where clause
2933 * @param array $filter Optioanal
2934 * @param array $params Optional *
2935 * @param int $show_deleted Optional, default 0, show deleted records is set to 1.
2936 * @param string $join_type
2937 * @param boolean $return_array Optional, default false, response as array
2938 * @param object $parentbean creating a subquery for this bean.
2939 * @param boolean $singleSelect Optional, default false.
2940 * @return String select query string, optionally an array value will be returned if $return_array= true.
2942 function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
2944 global $beanFiles, $beanList;
2945 $selectedFields = array();
2946 $secondarySelectedFields = array();
2947 $ret_array = array();
2949 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2951 global $current_user;
2952 $owner_where = $this->getOwnerWhere($current_user->id);
2955 $where = $owner_where;
2959 $where .= ' AND '. $owner_where;
2962 if(!empty($params['distinct']))
2964 $distinct = ' DISTINCT ';
2968 $ret_array['select'] = " SELECT $distinct $this->table_name.* ";
2972 $ret_array['select'] = " SELECT $distinct $this->table_name.id ";
2974 $ret_array['from'] = " FROM $this->table_name ";
2975 $ret_array['from_min'] = $ret_array['from'];
2976 $ret_array['secondary_from'] = $ret_array['from'] ;
2977 $ret_array['where'] = '';
2978 $ret_array['order_by'] = '';
2979 //secondary selects are selects that need to be run after the primarty query to retrieve additional info on main
2982 $ret_array['secondary_select']=& $ret_array['select'];
2983 $ret_array['secondary_from'] = & $ret_array['from'];
2987 $ret_array['secondary_select'] = '';
2989 $custom_join = false;
2990 if((!isset($params['include_custom_fields']) || $params['include_custom_fields']) && isset($this->custom_fields))
2993 $custom_join = $this->custom_fields->getJOIN( empty($filter)? true: $filter );
2996 $ret_array['select'] .= ' ' .$custom_join['select'];
3001 $ret_array['from'] .= ' ' . $custom_join['join'];
3004 //LOOP AROUND FOR FIXIN VARDEF ISSUES
3005 require('include/VarDefHandler/listvardefoverride.php');
3006 $joined_tables = array();
3007 if(isset($params['joined_tables']))
3009 foreach($params['joined_tables'] as $table)
3011 $joined_tables[$table] = 1;
3017 $filterKeys = array_keys($filter);
3018 if(is_numeric($filterKeys[0]))
3021 foreach($filter as $field)
3023 $field = strtolower($field);
3024 //remove out id field so we don't duplicate it
3025 if ( $field == 'id' && !empty($filter) ) {
3028 if(isset($this->field_defs[$field]))
3030 $fields[$field]= $this->field_defs[$field];
3034 $fields[$field] = array('force_exists'=>true);
3043 $fields = $this->field_defs;
3046 $used_join_key = array();
3048 foreach($fields as $field=>$value)
3050 //alias is used to alias field names
3052 if (isset($value['alias']))
3054 $alias =' as ' . $value['alias'] . ' ';
3057 if(empty($this->field_defs[$field]) || !empty($value['force_blank']) )
3059 if(!empty($filter) && isset($filter[$field]['force_exists']) && $filter[$field]['force_exists'])
3061 if ( isset($filter[$field]['force_default']) )
3062 $ret_array['select'] .= ", {$filter[$field]['force_default']} $field ";
3064 //spaces are a fix for length issue problem with unions. The union only returns the maximum number of characters from the first select statemtn.
3065 $ret_array['select'] .= ", ' ' $field ";
3071 $data = $this->field_defs[$field];
3074 //ignore fields that are a part of the collection and a field has been removed as a result of
3075 //layout customization.. this happens in subpanel customizations, use case, from the contacts subpanel
3076 //in opportunities module remove the contact_role/opportunity_role field.
3077 $process_field=true;
3078 if (isset($data['relationship_fields']) and !empty($data['relationship_fields']))
3080 foreach ($data['relationship_fields'] as $field_name)
3082 if (!isset($fields[$field_name]))
3084 $process_field=false;
3088 if (!$process_field)
3093 if( (!isset($data['source']) || $data['source'] == 'db') && (!empty($alias) || !empty($filter) ))
3095 $ret_array['select'] .= ", $this->table_name.$field $alias";
3096 $selectedFields["$this->table_name.$field"] = true;
3101 if($data['type'] != 'relate' && isset($data['db_concat_fields']))
3103 $ret_array['select'] .= ", " . db_concat($this->table_name, $data['db_concat_fields']) . " as $field";
3104 $selectedFields[db_concat($this->table_name, $data['db_concat_fields'])] = true;
3106 //Custom relate field or relate fields built in module builder which have no link field associated.
3107 if ($data['type'] == 'relate' && (isset($data['custom_module']) || isset($data['ext2']))) {
3108 $joinTableAlias = 'jt' . $jtcount;
3109 $relateJoinInfo = $this->custom_fields->getRelateJoin($data, $joinTableAlias);
3110 $ret_array['select'] .= $relateJoinInfo['select'];
3111 $ret_array['from'] .= $relateJoinInfo['from'];
3112 //Replace any references to the relationship in the where clause with the new alias
3113 //If the link isn't set, assume that search used the local table for the field
3114 $searchTable = isset($data['link']) ? $relateJoinInfo['rel_table'] : $this->table_name;
3115 $field_name = $relateJoinInfo['rel_table'] . '.' . !empty($data['name'])?$data['name']:'name';
3116 $where = preg_replace('/(^|[\s(])' . $field_name . '/' , '${1}' . $relateJoinInfo['name_field'], $where);
3120 if ($data['type'] == 'parent') {
3121 //See if we need to join anything by inspecting the where clause
3122 $match = preg_match('/(^|[\s(])parent_(\w+)_(\w+)\.name/', $where, $matches);
3124 $joinTableAlias = 'jt' . $jtcount;
3125 $joinModule = $matches[2];
3126 $joinTable = $matches[3];
3127 $localTable = $this->table_name;
3128 if (!empty($data['custom_module'])) {
3129 $localTable .= '_cstm';
3131 global $beanFiles, $beanList, $module;
3132 require_once($beanFiles[$beanList[$joinModule]]);
3133 $rel_mod = new $beanList[$joinModule]();
3134 $nameField = "$joinTableAlias.name";
3135 if (isset($rel_mod->field_defs['name']))
3137 $name_field_def = $rel_mod->field_defs['name'];
3138 if(isset($name_field_def['db_concat_fields']))
3140 $nameField = db_concat($joinTableAlias, $name_field_def['db_concat_fields']);
3143 $ret_array['select'] .= ", $nameField {$data['name']} ";
3144 $ret_array['from'] .= " LEFT JOIN $joinTable $joinTableAlias
3145 ON $localTable.{$data['id_name']} = $joinTableAlias.id";
3146 //Replace any references to the relationship in the where clause with the new alias
3147 $where = preg_replace('/(^|[\s(])parent_' . $joinModule . '_' . $joinTable . '\.name/', '${1}' . $nameField, $where);
3151 if($data['type'] == 'relate' && isset($data['link']))
3153 $this->load_relationship($data['link']);
3154 if(!empty($this->$data['link']))
3157 if(empty($join_type))
3159 $params['join_type'] = ' LEFT JOIN ';
3163 $params['join_type'] = $join_type;
3165 if(isset($data['join_name']))
3167 $params['join_table_alias'] = $data['join_name'];
3171 $params['join_table_alias'] = 'jt' . $jtcount;
3174 if(isset($data['join_link_name']))
3176 $params['join_table_link_alias'] = $data['join_link_name'];
3180 $params['join_table_link_alias'] = 'jtl' . $jtcount;
3182 $join_primary = !isset($data['join_primary']) || $data['join_primary'];
3184 $join = $this->$data['link']->getJoin($params, true);
3185 $used_join_key[] = $join['rel_key'];
3186 $rel_module = $this->$data['link']->getRelatedModuleName();
3187 $table_joined = !empty($joined_tables[$params['join_table_alias']]) || (!empty($joined_tables[$params['join_table_link_alias']]) && isset($data['link_type']) && $data['link_type'] == 'relationship_info');
3189 //if rnanme is set to 'name', and bean files exist, then check if field should be a concatenated name
3190 global $beanFiles, $beanList;
3191 if($data['rname'] && !empty($beanFiles[$beanList[$rel_module]])) {
3193 //create an instance of the related bean
3194 require_once($beanFiles[$beanList[$rel_module]]);
3195 $rel_mod = new $beanList[$rel_module]();
3196 //if bean has first and last name fields, then name should be concatenated
3197 if(isset($rel_mod->field_name_map['first_name']) && isset($rel_mod->field_name_map['last_name'])){
3198 $data['db_concat_fields'] = array(0=>'first_name', 1=>'last_name');
3203 if($join['type'] == 'many-to-many')
3205 if(empty($ret_array['secondary_select']))
3207 $ret_array['secondary_select'] = " SELECT $this->table_name.id ref_id ";
3209 if(!empty($beanFiles[$beanList[$rel_module]]) && $join_primary)
3211 require_once($beanFiles[$beanList[$rel_module]]);
3212 $rel_mod = new $beanList[$rel_module]();
3213 if(isset($rel_mod->field_defs['assigned_user_id']))
3215 $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".assigned_user_id {$field}_owner, '$rel_module' {$field}_mod";
3220 if(isset($rel_mod->field_defs['created_by']))
3222 $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".created_by {$field}_owner , '$rel_module' {$field}_mod";
3233 if(isset($data['db_concat_fields']))
3235 $ret_array['secondary_select'] .= ' , ' . db_concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3239 if(!isset($data['relationship_fields']))
3241 $ret_array['secondary_select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3246 $ret_array['select'] .= ", ' ' $field ";
3247 $ret_array['select'] .= ", ' ' " . $join['rel_key'] . ' ';
3250 if($this->db->dbType != 'mysql') {//bug 26801, these codes are just used to duplicate rel_key in the select sql, or it will throw error in MSSQL and Oracle.
3251 foreach($used_join_key as $used_key) {
3252 if($used_key == $join['rel_key']) $count_used++;
3255 if($count_used <= 1) {//27416, the $ret_array['secondary_select'] should always generate, regardless the dbtype
3256 $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $join['rel_key'] .' ' . $join['rel_key'];
3258 if(isset($data['relationship_fields']))
3260 foreach($data['relationship_fields'] as $r_name=>$alias_name)
3262 if(!empty( $secondarySelectedFields[$alias_name]))continue;
3263 $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $r_name .' ' . $alias_name;
3264 $secondarySelectedFields[$alias_name] = true;
3269 $ret_array['secondary_from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3270 if (isset($data['link_type']) && $data['link_type'] == 'relationship_info' && ($parentbean instanceOf SugarBean))
3272 $ret_array['secondary_where'] = $params['join_table_link_alias'] . '.' . $join['rel_key']. "='" .$parentbean->id . "'";
3278 if(isset($data['db_concat_fields']))
3280 $ret_array['select'] .= ' , ' . db_concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3284 $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3286 if(isset($data['additionalFields'])){
3287 foreach($data['additionalFields'] as $k=>$v){
3288 $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $k . ' ' . $v;
3293 $ret_array['from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3294 if(!empty($beanList[$rel_module]) && !empty($beanFiles[$beanList[$rel_module]]))
3296 require_once($beanFiles[$beanList[$rel_module]]);
3297 $rel_mod = new $beanList[$rel_module]();
3298 if(isset($value['target_record_key']) && !empty($filter))
3300 $selectedFields[$this->table_name.'.'.$value['target_record_key']] = true;
3301 $ret_array['select'] .= " , $this->table_name.{$value['target_record_key']} ";
3303 if(isset($rel_mod->field_defs['assigned_user_id']))
3305 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.assigned_user_id ' . $field . '_owner';
3309 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.created_by ' . $field . '_owner';
3311 $ret_array['select'] .= " , '".$rel_module ."' " . $field . '_mod';
3315 //Replace references to this table in the where clause with the new alias
3316 $join_table_name = $this->$data['link']->getRelatedTableName();
3317 // To fix SOAP stuff where we are trying to retrieve all the accounts data where accounts.id = ..
3318 // and this code changes accounts to jt4 as there is a self join with the accounts table.
3320 if(isset($data['db_concat_fields'])){
3321 $buildWhere = false;
3322 if(in_array('first_name', $data['db_concat_fields']) && in_array('last_name', $data['db_concat_fields']))
3324 $exp = '/\(\s*?'.$data['name'].'.*?\%\'\s*?\)/';
3325 if(preg_match($exp, $where, $matches))
3327 $search_expression = $matches[0];
3328 //Create three search conditions - first + last, first, last
3329 $first_name_search = str_replace($data['name'], $params['join_table_alias'] . '.first_name', $search_expression);
3330 $last_name_search = str_replace($data['name'], $params['join_table_alias'] . '.last_name', $search_expression);
3331 $full_name_search = str_replace($data['name'], db_concat($params['join_table_alias'], $data['db_concat_fields']), $search_expression);
3333 $where = str_replace($search_expression, '(' . $full_name_search . ' OR ' . $first_name_search . ' OR ' . $last_name_search . ')', $where);
3339 $db_field = db_concat($params['join_table_alias'], $data['db_concat_fields']);
3340 $where = preg_replace('/'.$data['name'].'/', $db_field, $where);
3343 $where = preg_replace('/(^|[\s(])' . $data['name'] . '/', '${1}' . $params['join_table_alias'] . '.'.$data['rname'], $where);
3347 $joined_tables[$params['join_table_alias']]=1;
3348 $joined_tables[$params['join_table_link_alias']]=1;
3357 if(isset($this->field_defs['assigned_user_id']) && empty($selectedFields[$this->table_name.'.assigned_user_id']))
3359 $ret_array['select'] .= ", $this->table_name.assigned_user_id ";
3361 else if(isset($this->field_defs['created_by']) && empty($selectedFields[$this->table_name.'.created_by']))
3363 $ret_array['select'] .= ", $this->table_name.created_by ";
3365 if(isset($this->field_defs['system_id']) && empty($selectedFields[$this->table_name.'.system_id']))
3367 $ret_array['select'] .= ", $this->table_name.system_id ";
3371 $where_auto = '1=1';
3372 if($show_deleted == 0)
3374 $where_auto = "$this->table_name.deleted=0";
3375 }else if($show_deleted == 1)
3377 $where_auto = "$this->table_name.deleted=1";
3380 $ret_array['where'] = " where ($where) AND $where_auto";
3382 $ret_array['where'] = " where $where_auto";
3383 if(!empty($order_by))
3385 //make call to process the order by clause
3386 $ret_array['order_by'] = " ORDER BY ". $this->process_order_by($order_by, null);
3390 unset($ret_array['secondary_where']);
3391 unset($ret_array['secondary_from']);
3392 unset($ret_array['secondary_select']);
3400 return $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
3407 * Returns parent record data for objects that store relationship information
3409 * @param array $type_info
3411 * Interal function, do not override.
3413 function retrieve_parent_fields($type_info)
3416 global $beanList, $beanFiles;
3417 $templates = array();
3418 $parent_child_map = array();
3419 foreach($type_info as $children_info)
3421 foreach($children_info as $child_info)
3423 if($child_info['type'] == 'parent')
3425 if(empty($templates[$child_info['parent_type']]))
3427 //Test emails will have an invalid parent_type, don't try to load the non-existant parent bean
3428 if ($child_info['parent_type'] == 'test') {
3431 $class = $beanList[$child_info['parent_type']];
3432 // Added to avoid error below; just silently fail and write message to log
3433 if ( empty($beanFiles[$class]) ) {
3434 $GLOBALS['log']->error($this->object_name.'::retrieve_parent_fields() - cannot load class "'.$class.'", skip loading.');
3437 require_once($beanFiles[$class]);
3438 $templates[$child_info['parent_type']] = new $class();
3441 if(empty($queries[$child_info['parent_type']]))
3443 $queries[$child_info['parent_type']] = "SELECT id ";
3444 $field_def = $templates[$child_info['parent_type']]->field_defs['name'];
3445 if(isset($field_def['db_concat_fields']))
3447 $queries[$child_info['parent_type']] .= ' , ' . db_concat($templates[$child_info['parent_type']]->table_name, $field_def['db_concat_fields']) . ' parent_name';
3451 $queries[$child_info['parent_type']] .= ' , name parent_name';
3453 if(isset($templates[$child_info['parent_type']]->field_defs['assigned_user_id']))
3455 $queries[$child_info['parent_type']] .= ", assigned_user_id parent_name_owner , '{$child_info['parent_type']}' parent_name_mod";;
3456 }else if(isset($templates[$child_info['parent_type']]->field_defs['created_by']))
3458 $queries[$child_info['parent_type']] .= ", created_by parent_name_owner, '{$child_info['parent_type']}' parent_name_mod";
3460 $queries[$child_info['parent_type']] .= " FROM " . $templates[$child_info['parent_type']]->table_name ." WHERE id IN ('{$child_info['parent_id']}'";
3464 if(empty($parent_child_map[$child_info['parent_id']]))
3465 $queries[$child_info['parent_type']] .= " ,'{$child_info['parent_id']}'";
3467 $parent_child_map[$child_info['parent_id']][] = $child_info['child_id'];
3472 foreach($queries as $query)
3474 $result = $this->db->query($query . ')');
3475 while($row = $this->db->fetchByAssoc($result))
3477 $results[$row['id']] = $row;
3481 $child_results = array();
3482 foreach($parent_child_map as $parent_key=>$parent_child)
3484 foreach($parent_child as $child)
3486 if(isset( $results[$parent_key]))
3488 $child_results[$child] = $results[$parent_key];
3492 return $child_results;
3496 * Processes the list query and return fetched row.
3498 * Internal function, do not override.
3499 * @param string $query select query to be processed.
3500 * @param int $row_offset starting position
3501 * @param int $limit Optioanl, default -1
3502 * @param int $max_per_page Optional, default -1
3503 * @param string $where Optional, additional filter criteria.
3504 * @return array Fetched data
3506 function process_list_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '')
3508 global $sugar_config;
3509 $db = &DBManagerFactory::getInstance('listviews');
3511 * if the row_offset is set to 'end' go to the end of the list
3513 $toEnd = strval($row_offset) == 'end';
3514 $GLOBALS['log']->debug("process_list_query: ".$query);
3515 if($max_per_page == -1)
3517 $max_per_page = $sugar_config['list_max_entries_per_page'];
3519 // Check to see if we have a count query available.
3520 if(empty($sugar_config['disable_count_query']) || $toEnd)
3522 $count_query = $this->create_list_count_query($query);
3523 if(!empty($count_query) && (empty($limit) || $limit == -1))
3525 // We have a count query. Run it and get the results.
3526 $result = $db->query($count_query, true, "Error running count query for $this->object_name List: ");
3527 $assoc = $db->fetchByAssoc($result);
3528 if(!empty($assoc['c']))
3530 $rows_found = $assoc['c'];
3531 $limit = $sugar_config['list_max_entries_per_page'];
3535 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3541 if((empty($limit) || $limit == -1))
3543 $limit = $max_per_page + 1;
3544 $max_per_page = $limit;
3548 if(empty($row_offset))
3552 if(!empty($limit) && $limit != -1 && $limit != -99)
3554 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
3558 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3563 if(empty($rows_found))
3565 $rows_found = $db->getRowCount($result);
3568 $GLOBALS['log']->debug("Found $rows_found ".$this->object_name."s");
3570 $previous_offset = $row_offset - $max_per_page;
3571 $next_offset = $row_offset + $max_per_page;
3573 $class = get_class($this);
3574 if($rows_found != 0 or $db->dbType != 'mysql')
3576 //todo Bug? we should remove the magic number -99
3577 //use -99 to return all
3578 $index = $row_offset;
3579 while ($max_per_page == -99 || ($index < $row_offset + $max_per_page))
3582 if(!empty($sugar_config['disable_count_query']))
3584 $row = $db->fetchByAssoc($result);
3588 $row = $db->fetchByAssoc($result, $index);
3595 //instantiate a new class each time. This is because php5 passes
3596 //by reference by default so if we continually update $this, we will
3597 //at the end have a list of all the same objects
3598 $temp = new $class();
3600 foreach($this->field_defs as $field=>$value)
3602 if (isset($row[$field]))
3604 $temp->$field = $row[$field];
3605 $owner_field = $field . '_owner';
3606 if(isset($row[$owner_field]))
3608 $temp->$owner_field = $row[$owner_field];
3611 $GLOBALS['log']->debug("$temp->object_name({$row['id']}): ".$field." = ".$temp->$field);
3612 }else if (isset($row[$this->table_name .'.'.$field]))
3614 $temp->$field = $row[$this->table_name .'.'.$field];
3622 $temp->check_date_relationships_load();
3623 $temp->fill_in_additional_list_fields();
3624 if($temp->hasCustomFields()) $temp->custom_fields->fill_relationships();
3625 $temp->call_custom_logic("process_record");
3632 if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3635 $rows_found = $row_offset + count($list);
3637 unset($list[$limit - 1]);
3644 $response = Array();
3645 $response['list'] = $list;
3646 $response['row_count'] = $rows_found;
3647 $response['next_offset'] = $next_offset;
3648 $response['previous_offset'] = $previous_offset;
3649 $response['current_offset'] = $row_offset ;
3654 * Returns the number of rows that the given SQL query should produce
3656 * Internal function, do not override.
3657 * @param string $query valid select query
3658 * @param boolean $is_count_query Optional, Default false, set to true if passed query is a count query.
3659 * @return int count of rows found
3661 function _get_num_rows_in_query($query, $is_count_query=false)
3663 $num_rows_in_query = 0;
3664 if (!$is_count_query)
3666 $count_query = SugarBean::create_list_count_query($query);
3668 $count_query=$query;
3670 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
3672 $row = $this->db->fetchByAssoc($result, $row_num);
3675 $num_rows_in_query += current($row);
3677 $row = $this->db->fetchByAssoc($result, $row_num);
3680 return $num_rows_in_query;
3684 * Applies pagination window to union queries used by list view and subpanels,
3685 * executes the query and returns fetched data.
3687 * Internal function, do not override.
3688 * @param object $parent_bean
3689 * @param string $query query to be processed.
3690 * @param int $row_offset
3691 * @param int $limit optional, default -1
3692 * @param int $max_per_page Optional, default -1
3693 * @param string $where Custom where clause.
3694 * @param array $subpanel_def definition of sub-panel to be processed
3695 * @param string $query_row_count
3696 * @param array $seconday_queries
3697 * @return array Fetched data.
3699 function process_union_list_query($parent_bean, $query,
3700 $row_offset, $limit= -1, $max_per_page = -1, $where = '', $subpanel_def, $query_row_count='', $secondary_queries = array())
3703 $db = &DBManagerFactory::getInstance('listviews');
3705 * if the row_offset is set to 'end' go to the end of the list
3707 $toEnd = strval($row_offset) == 'end';
3708 global $sugar_config;
3709 $use_count_query=false;
3710 $processing_collection=$subpanel_def->isCollection();
3712 $GLOBALS['log']->debug("process_list_query: ".$query);
3713 if($max_per_page == -1)
3715 $max_per_page = $sugar_config['list_max_entries_per_subpanel'];
3717 if(empty($query_row_count))
3719 $query_row_count = $query;
3721 $distinct_position=strpos($query_row_count,"DISTINCT");
3723 if ($distinct_position!= false)
3725 $use_count_query=true;
3727 $performSecondQuery = true;
3728 if(empty($sugar_config['disable_count_query']) || $toEnd)
3730 $rows_found = $this->_get_num_rows_in_query($query_row_count,$use_count_query);
3733 $performSecondQuery = false;
3735 if(!empty($rows_found) && (empty($limit) || $limit == -1))
3737 $limit = $sugar_config['list_max_entries_per_subpanel'];
3741 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3747 if((empty($limit) || $limit == -1))
3749 $limit = $max_per_page + 1;
3750 $max_per_page = $limit;
3754 if(empty($row_offset))
3759 $previous_offset = $row_offset - $max_per_page;
3760 $next_offset = $row_offset + $max_per_page;
3762 if($performSecondQuery)
3764 if(!empty($limit) && $limit != -1 && $limit != -99)
3766 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $parent_bean->object_name list: ");
3770 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3772 if(empty($rows_found))
3774 $rows_found = $db->getRowCount($result);
3777 $GLOBALS['log']->debug("Found $rows_found ".$parent_bean->object_name."s");
3778 if($rows_found != 0 or $db->dbType != 'mysql')
3780 //use -99 to return all
3782 // get the current row
3783 $index = $row_offset;
3784 if(!empty($sugar_config['disable_count_query']))
3786 $row = $db->fetchByAssoc($result);
3790 $row = $db->fetchByAssoc($result, $index);
3793 $post_retrieve = array();
3794 $isFirstTime = true;
3797 $function_fields = array();
3798 if(($index < $row_offset + $max_per_page || $max_per_page == -99) or ($db->dbType != 'mysql'))
3800 if ($processing_collection)
3802 $current_bean =$subpanel_def->sub_subpanels[$row['panel_name']]->template_instance;
3805 $class = get_class($subpanel_def->sub_subpanels[$row['panel_name']]->template_instance);
3806 $current_bean = new $class();
3809 $current_bean=$subpanel_def->template_instance;
3812 $class = get_class($subpanel_def->template_instance);
3813 $current_bean = new $class();
3816 $isFirstTime = false;
3817 //set the panel name in the bean instance.
3818 if (isset($row['panel_name']))
3820 $current_bean->panel_name=$row['panel_name'];
3822 foreach($current_bean->field_defs as $field=>$value)
3825 if (isset($row[$field]))
3827 $current_bean->$field = $row[$field];
3828 unset($row[$field]);
3830 else if (isset($row[$this->table_name .'.'.$field]))
3832 $current_bean->$field = $row[$current_bean->table_name .'.'.$field];
3833 unset($row[$current_bean->table_name .'.'.$field]);
3837 $current_bean->$field = "";
3838 unset($row[$field]);
3840 if(isset($value['source']) && $value['source'] == 'function')
3842 $function_fields[]=$field;
3845 foreach($row as $key=>$value)
3847 $current_bean->$key = $value;
3849 foreach($function_fields as $function_field)
3851 $value = $current_bean->field_defs[$function_field];
3852 $can_execute = true;
3853 $execute_params = array();
3854 $execute_function = array();
3855 if(!empty($value['function_class']))
3857 $execute_function[] = $value['function_class'];
3858 $execute_function[] = $value['function_name'];
3862 $execute_function = $value['function_name'];
3864 foreach($value['function_params'] as $param )
3866 if (empty($value['function_params_source']) or $value['function_params_source']=='parent')
3868 if(empty($this->$param))
3870 $can_execute = false;
3874 $execute_params[] = $this->$param;
3876 } else if ($value['function_params_source']=='this')
3878 if(empty($current_bean->$param))
3880 $can_execute = false;
3884 $execute_params[] = $current_bean->$param;
3889 $can_execute = false;
3895 if(!empty($value['function_require']))
3897 require_once($value['function_require']);
3899 $current_bean->$function_field = call_user_func_array($execute_function, $execute_params);
3902 if(!empty($current_bean->parent_type) && !empty($current_bean->parent_id))
3904 if(!isset($post_retrieve[$current_bean->parent_type]))
3906 $post_retrieve[$current_bean->parent_type] = array();
3908 $post_retrieve[$current_bean->parent_type][] = array('child_id'=>$current_bean->id, 'parent_id'=> $current_bean->parent_id, 'parent_type'=>$current_bean->parent_type, 'type'=>'parent');
3910 //$current_bean->fill_in_additional_list_fields();
3911 $list[$current_bean->id] = $current_bean;
3913 // go to the next row
3915 $row = $db->fetchByAssoc($result, $index);
3918 //now handle retrieving many-to-many relationships
3921 foreach($secondary_queries as $query2)
3923 $result2 = $db->query($query2);
3925 $row2 = $db->fetchByAssoc($result2);
3928 $id_ref = $row2['ref_id'];
3930 if(isset($list[$id_ref]))
3932 foreach($row2 as $r2key=>$r2value)
3934 if($r2key != 'ref_id')
3936 $list[$id_ref]->$r2key = $r2value;
3940 $row2 = $db->fetchByAssoc($result2);
3946 if(isset($post_retrieve))
3948 $parent_fields = $this->retrieve_parent_fields($post_retrieve);
3952 $parent_fields = array();
3954 if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3956 $rows_found = $row_offset + count($list);
3957 if(count($list) >= $limit)
3971 $parent_fields = array();
3973 $response = array();
3974 $response['list'] = $list;
3975 $response['parent_data'] = $parent_fields;
3976 $response['row_count'] = $rows_found;
3977 $response['next_offset'] = $next_offset;
3978 $response['previous_offset'] = $previous_offset;
3979 $response['current_offset'] = $row_offset ;
3980 $response['query'] = $query;
3986 * Applies pagination window to select queries used by detail view,
3987 * executes the query and returns fetched data.
3989 * Internal function, do not override.
3990 * @param string $query query to be processed.
3991 * @param int $row_offset
3992 * @param int $limit optional, default -1
3993 * @param int $max_per_page Optional, default -1
3994 * @param string $where Custom where clause.
3995 * @param int $offset Optional, default 0
3996 * @return array Fetched data.
3999 function process_detail_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '', $offset = 0)
4001 global $sugar_config;
4002 $GLOBALS['log']->debug("process_list_query: ".$query);
4003 if($max_per_page == -1)
4005 $max_per_page = $sugar_config['list_max_entries_per_page'];
4008 // Check to see if we have a count query available.
4009 $count_query = $this->create_list_count_query($query);
4011 if(!empty($count_query) && (empty($limit) || $limit == -1))
4013 // We have a count query. Run it and get the results.
4014 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
4015 $assoc = $this->db->fetchByAssoc($result);
4016 if(!empty($assoc['c']))
4018 $total_rows = $assoc['c'];
4022 if(empty($row_offset))
4027 $result = $this->db->limitQuery($query, $offset, 1, true,"Error retrieving $this->object_name list: ");
4029 $rows_found = $this->db->getRowCount($result);
4031 $GLOBALS['log']->debug("Found $rows_found ".$this->object_name."s");
4033 $previous_offset = $row_offset - $max_per_page;
4034 $next_offset = $row_offset + $max_per_page;
4036 if($rows_found != 0 or $this->db->dbType != 'mysql')
4039 $row = $this->db->fetchByAssoc($result, $index);
4040 $this->retrieve($row['id']);
4043 $response = Array();
4044 $response['bean'] = $this;
4045 if (empty($total_rows))
4047 $response['row_count'] = $total_rows;
4048 $response['next_offset'] = $next_offset;
4049 $response['previous_offset'] = $previous_offset;
4055 * Processes fetched list view data
4057 * Internal function, do not override.
4058 * @param string $query query to be processed.
4059 * @param boolean $check_date Optional, default false. if set to true date time values are processed.
4060 * @return array Fetched data.
4063 function process_full_list_query($query, $check_date=false)
4066 $GLOBALS['log']->debug("process_full_list_query: query is ".$query);
4067 $result = $this->db->query($query, false);
4068 $GLOBALS['log']->debug("process_full_list_query: result is ".print_r($result,true));
4069 $class = get_class($this);
4070 $isFirstTime = true;
4071 $bean = new $class();
4073 //if($this->db->getRowCount($result) > 0){
4076 // We have some data.
4077 //while ($row = $this->db->fetchByAssoc($result)) {
4078 while (($row = $bean->db->fetchByAssoc($result)) != null)
4082 $bean = new $class();
4084 $isFirstTime = false;
4086 foreach($bean->field_defs as $field=>$value)
4088 if (isset($row[$field]))
4090 $bean->$field = $row[$field];
4091 $GLOBALS['log']->debug("process_full_list: $bean->object_name({$row['id']}): ".$field." = ".$bean->$field);
4100 $bean->processed_dates_times = array();
4101 $bean->check_date_relationships_load();
4103 $bean->fill_in_additional_list_fields();
4104 $bean->call_custom_logic("process_record");
4105 $bean->fetched_row = $row;
4110 if (isset($list)) return $list;
4115 * Tracks the viewing of a detail record.
4116 * This leverages get_summary_text() which is object specific.
4118 * Internal function, do not override.
4119 * @param string $user_id - String value of the user that is viewing the record.
4120 * @param string $current_module - String value of the module being processed.
4121 * @param string $current_view - String value of the current view
4123 function track_view($user_id, $current_module, $current_view='')
4125 $trackerManager = TrackerManager::getInstance();
4126 if($monitor = $trackerManager->getMonitor('tracker')){
4127 $monitor->setValue('date_modified', $GLOBALS['timedate']->nowDb());
4128 $monitor->setValue('user_id', $user_id);
4129 $monitor->setValue('module_name', $current_module);
4130 $monitor->setValue('action', $current_view);
4131 $monitor->setValue('item_id', $this->id);
4132 $monitor->setValue('item_summary', $this->get_summary_text());
4133 $monitor->setValue('visible', $this->tracker_visibility);
4134 $trackerManager->saveMonitor($monitor);
4139 * Returns the summary text that should show up in the recent history list for this object.
4143 public function get_summary_text()
4145 return "Base Implementation. Should be overridden.";
4149 * This is designed to be overridden and add specific fields to each record.
4150 * This allows the generic query to fill in the major fields, and then targeted
4151 * queries to get related fields and add them to the record. The contact's
4152 * account for instance. This method is only used for populating extra fields
4155 function fill_in_additional_list_fields(){
4156 if(!empty($this->field_defs['parent_name']) && empty($this->parent_name)){
4157 $this->fill_in_additional_parent_fields();
4162 * This is designed to be overridden and add specific fields to each record.
4163 * This allows the generic query to fill in the major fields, and then targeted
4164 * queries to get related fields and add them to the record. The contact's
4165 * account for instance. This method is only used for populating extra fields
4166 * in the detail form
4168 function fill_in_additional_detail_fields()
4170 if(!empty($this->field_defs['assigned_user_name']) && !empty($this->assigned_user_id)){
4172 $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
4175 if(!empty($this->field_defs['created_by']) && !empty($this->created_by))
4176 $this->created_by_name = get_assigned_user_name($this->created_by);
4177 if(!empty($this->field_defs['modified_user_id']) && !empty($this->modified_user_id))
4178 $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
4180 if(!empty($this->field_defs['parent_name'])){
4181 $this->fill_in_additional_parent_fields();
4186 * This is desgined to be overridden or called from extending bean. This method
4187 * will fill in any parent_name fields.
4189 function fill_in_additional_parent_fields() {
4191 if(!empty($this->parent_id) && !empty($this->last_parent_id) && $this->last_parent_id == $this->parent_id){
4194 $this->parent_name = '';
4196 if(!empty($this->parent_type)) {
4197 $this->last_parent_id = $this->parent_id;
4198 $this->getRelatedFields($this->parent_type, $this->parent_id, array('name'=>'parent_name', 'document_name' => 'parent_document_name', 'first_name'=>'parent_first_name', 'last_name'=>'parent_last_name'));
4199 if(!empty($this->parent_first_name) || !empty($this->parent_last_name) ){
4200 $this->parent_name = $GLOBALS['locale']->getLocaleFormattedName($this->parent_first_name, $this->parent_last_name);
4201 } else if(!empty($this->parent_document_name)){
4202 $this->parent_name = $this->parent_document_name;
4208 * Fill in a link field
4211 function fill_in_link_field( $linkFieldName )
4213 if ($this->load_relationship($linkFieldName))
4215 $list=$this->$linkFieldName->get();
4216 $this->$linkFieldName = '' ; // match up with null value in $this->populateFromRow()
4218 $this->$linkFieldName = $list[0];
4223 * Fill in fields where type = relate
4225 function fill_in_relationship_fields(){
4226 if(!empty($this->relDepth)) {
4227 if($this->relDepth > 1)return;
4228 }else $this->relDepth = 0;
4230 foreach($this->field_defs as $field)
4232 if(0 == strcmp($field['type'],'relate') && !empty($field['module']))
4234 $name = $field['name'];
4235 if(empty($this->$name))
4237 // set the value of this relate field in this bean ($this->$field['name']) to the value of the 'name' field in the related module for the record identified by the value of $this->$field['id_name']
4238 $related_module = $field['module'];
4239 $id_name = $field['id_name'];
4240 if (empty($this->$id_name)){
4241 $this->fill_in_link_field($id_name);
4243 if(!empty($this->$id_name) && ( $this->object_name != $related_module || ( $this->object_name == $related_module && $this->$id_name != $this->id ))){
4244 if(isset($GLOBALS['beanList'][ $related_module])){
4245 $class = $GLOBALS['beanList'][$related_module];
4247 if(!empty($this->$id_name) && file_exists($GLOBALS['beanFiles'][$class]) && isset($this->$name)){
4248 require_once($GLOBALS['beanFiles'][$class]);
4249 $mod = new $class();
4250 $mod->relDepth = $this->relDepth + 1;
4251 $mod->retrieve($this->$id_name);
4252 if (!empty($field['rname'])) {
4253 $this->$name = $mod->$field['rname'];
4254 } else if (isset($mod->name)) {
4255 $this->$name = $mod->name;
4260 if(!empty($this->$id_name) && isset($this->$name))
4262 if(!isset($field['additionalFields']))
4263 $field['additionalFields'] = array();
4264 if(!empty($field['rname']))
4266 $field['additionalFields'][$field['rname']]= $name;
4270 $field['additionalFields']['name']= $name;
4272 $this->getRelatedFields($related_module, $this->$id_name, $field['additionalFields']);
4280 * This is a helper function that is used to quickly created indexes when creating tables.
4282 function create_index($query)
4284 $GLOBALS['log']->info($query);
4286 $result = $this->db->query($query, true, "Error creating index:");
4290 * This function should be overridden in each module. It marks an item as deleted.
4292 * If it is not overridden, then marking this type of item is not allowed
4294 function mark_deleted($id)
4296 global $current_user;
4297 $date_modified = $GLOBALS['timedate']->nowDb();
4298 if(isset($_SESSION['show_deleted']))
4300 $this->mark_undeleted($id);
4304 // call the custom business logic
4305 $custom_logic_arguments['id'] = $id;
4306 $this->call_custom_logic("before_delete", $custom_logic_arguments);
4308 if ( isset($this->field_defs['modified_user_id']) ) {
4309 if (!empty($current_user)) {
4310 $this->modified_user_id = $current_user->id;
4312 $this->modified_user_id = 1;
4314 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified', modified_user_id = '$this->modified_user_id' where id='$id'";
4316 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified' where id='$id'";
4317 $this->db->query($query, true,"Error marking record deleted: ");
4319 $this->mark_relationships_deleted($id);
4321 // Take the item off the recently viewed lists
4322 $tracker = new Tracker();
4323 $tracker->makeInvisibleForAll($id);
4325 // call the custom business logic
4326 $this->call_custom_logic("after_delete", $custom_logic_arguments);
4331 * Restores data deleted by call to mark_deleted() function.
4333 * Internal function, do not override.
4335 function mark_undeleted($id)
4337 // call the custom business logic
4338 $custom_logic_arguments['id'] = $id;
4339 $this->call_custom_logic("before_restore", $custom_logic_arguments);
4341 $date_modified = $GLOBALS['timedate']->nowDb();
4342 $query = "UPDATE $this->table_name set deleted=0 , date_modified = '$date_modified' where id='$id'";
4343 $this->db->query($query, true,"Error marking record undeleted: ");
4345 // call the custom business logic
4346 $this->call_custom_logic("after_restore", $custom_logic_arguments);
4350 * This function deletes relationships to this object. It should be overridden
4351 * to handle the relationships of the specific object.
4352 * This function is called when the item itself is being deleted.
4354 * @param int $id id of the relationship to delete
4356 function mark_relationships_deleted($id)
4358 $this->delete_linked($id);
4362 * This function is used to execute the query and create an array template objects
4363 * from the resulting ids from the query.
4364 * It is currently used for building sub-panel arrays.
4366 * @param string $query - the query that should be executed to build the list
4367 * @param object $template - The object that should be used to copy the records.
4368 * @param int $row_offset Optional, default 0
4369 * @param int $limit Optional, default -1
4372 function build_related_list($query, &$template, $row_offset = 0, $limit = -1)
4374 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4375 $db = &DBManagerFactory::getInstance('listviews');
4377 if(!empty($row_offset) && $row_offset != 0 && !empty($limit) && $limit != -1)
4379 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $template->object_name list: ");
4383 $result = $db->query($query, true);
4387 $isFirstTime = true;
4388 $class = get_class($template);
4389 while($row = $this->db->fetchByAssoc($result))
4393 $template = new $class();
4395 $isFirstTime = false;
4396 $record = $template->retrieve($row['id']);
4400 // this copies the object into the array
4401 $list[] = $template;
4408 * This function is used to execute the query and create an array template objects
4409 * from the resulting ids from the query.
4410 * It is currently used for building sub-panel arrays. It supports an additional
4411 * where clause that is executed as a filter on the results
4413 * @param string $query - the query that should be executed to build the list
4414 * @param object $template - The object that should be used to copy the records.
4416 function build_related_list_where($query, &$template, $where='', $in='', $order_by, $limit='', $row_offset = 0)
4418 $db = &DBManagerFactory::getInstance('listviews');
4419 // No need to do an additional query
4420 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4421 if(empty($in) && !empty($query))
4423 $idList = $this->build_related_in($query);
4424 $in = $idList['in'];
4426 // MFH - Added Support For Custom Fields in Searches
4428 if(isset($this->custom_fields)) {
4429 $custom_join = $this->custom_fields->getJOIN();
4432 $query = "SELECT id ";
4434 if (!empty($custom_join)) {
4435 $query .= $custom_join['select'];
4437 $query .= " FROM $this->table_name ";
4439 if (!empty($custom_join) && !empty($custom_join['join'])) {
4440 $query .= " " . $custom_join['join'];
4443 $query .= " WHERE deleted=0 AND id IN $in";
4446 $query .= " AND $where";
4450 if(!empty($order_by))
4452 $query .= "ORDER BY $order_by";
4456 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
4460 $result = $db->query($query, true);
4464 $isFirstTime = true;
4465 $class = get_class($template);
4467 $disable_security_flag = ($template->disable_row_level_security) ? true : false;
4468 while($row = $db->fetchByAssoc($result))
4472 $template = new $class();
4473 $template->disable_row_level_security = $disable_security_flag;
4475 $isFirstTime = false;
4476 $record = $template->retrieve($row['id']);
4479 // this copies the object into the array
4480 $list[] = $template;
4488 * Constructs an comma seperated list of ids from passed query results.
4490 * @param string @query query to be executed.
4493 function build_related_in($query)
4496 $result = $this->db->query($query, true);
4498 while($row = $this->db->fetchByAssoc($result))
4500 $idList[] = $row['id'];
4503 $ids = "('" . $row['id'] . "'";
4507 $ids .= ",'" . $row['id'] . "'";
4517 return array('list'=>$idList, 'in'=>$ids);
4521 * Optionally copies values from fetched row into the bean.
4523 * Internal function, do not override.
4525 * @param string $query - the query that should be executed to build the list
4526 * @param object $template - The object that should be used to copy the records
4527 * @param array $field_list List of fields.
4530 function build_related_list2($query, &$template, &$field_list)
4532 $GLOBALS['log']->debug("Finding linked values $this->object_name: ".$query);
4534 $result = $this->db->query($query, true);
4537 $isFirstTime = true;
4538 $class = get_class($template);
4539 while($row = $this->db->fetchByAssoc($result))
4541 // Create a blank copy
4545 $copy = new $class();
4547 $isFirstTime = false;
4548 foreach($field_list as $field)
4550 // Copy the relevant fields
4551 $copy->$field = $row[$field];
4555 // this copies the object into the array
4563 * Let implementing classes to fill in row specific columns of a list view form
4566 function list_view_parse_additional_sections(&$list_form)
4571 * Assigns all of the values into the template for the list view
4573 function get_list_view_array()
4575 static $cache = array();
4576 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4577 $sensitiveFields = array('user_hash' => '');
4579 $return_array = Array();
4580 global $app_list_strings, $mod_strings;
4581 foreach($this->field_defs as $field=>$value){
4583 if(isset($this->$field)){
4585 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4586 if(isset($sensitiveFields[$field]))
4588 if(!isset($cache[$field]))
4589 $cache[$field] = strtoupper($field);
4591 //Fields hidden by Dependent Fields
4592 if (isset($value['hidden']) && $value['hidden'] === true) {
4593 $return_array[$cache[$field]] = "";
4596 //cn: if $field is a _dom, detect and return VALUE not KEY
4597 //cl: empty function check for meta-data enum types that have values loaded from a function
4598 else if (((!empty($value['type']) && ($value['type'] == 'enum' || $value['type'] == 'radioenum') )) && empty($value['function'])){
4599 if(!empty($app_list_strings[$value['options']][$this->$field])){
4600 $return_array[$cache[$field]] = $app_list_strings[$value['options']][$this->$field];
4602 //nsingh- bug 21672. some modules such as manufacturers, Releases do not have a listing for select fields in the $app_list_strings. Must also check $mod_strings to localize.
4603 elseif(!empty($mod_strings[$value['options']][$this->$field]))
4605 $return_array[$cache[$field]] = $mod_strings[$value['options']][$this->$field];
4608 $return_array[$cache[$field]] = $this->$field;
4611 // tjy: no need to do this str_replace as the changes in 29994 for ListViewGeneric.tpl for translation handle this now
4612 // }elseif(!empty($value['type']) && $value['type'] == 'multienum'&& empty($value['function'])){
4613 // $return_array[strtoupper($field)] = str_replace('^,^', ', ', $this->$field );
4614 }elseif(!empty($value['custom_module']) && $value['type'] != 'currency'){
4615 // $this->format_field($value);
4616 $return_array[$cache[$field]] = $this->$field;
4618 $return_array[$cache[$field]] = $this->$field;
4620 // handle "Assigned User Name"
4621 if($field == 'assigned_user_name'){
4622 $return_array['ASSIGNED_USER_NAME'] = get_assigned_user_name($this->assigned_user_id);
4626 return $return_array;
4629 * Override this function to set values in the array used to render list view data.
4632 function get_list_view_data()
4634 return $this->get_list_view_array();
4638 * Construct where clause from a list of name-value pairs.
4641 function get_where(&$fields_array)
4643 $where_clause = "WHERE ";
4645 foreach ($fields_array as $name=>$value)
4653 $where_clause .= " AND ";
4656 $where_clause .= "$name = '".$this->db->quote($value,false)."'";
4658 $where_clause .= " AND deleted=0";
4659 return $where_clause;
4664 * Constructs a select query and fetch 1 row using this query, and then process the row
4666 * Internal function, do not override.
4667 * @param array @fields_array array of name value pairs used to construct query.
4668 * @param boolean $encode Optional, default true, encode fetched data.
4669 * @return object Instance of this bean with fetched data.
4671 function retrieve_by_string_fields($fields_array, $encode=true)
4673 $where_clause = $this->get_where($fields_array);
4674 if(isset($this->custom_fields))
4675 $custom_join = $this->custom_fields->getJOIN();
4676 else $custom_join = false;
4679 $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name " . $custom_join['join'];
4683 $query = "SELECT $this->table_name.* FROM $this->table_name ";
4685 $query .= " $where_clause";
4686 $GLOBALS['log']->debug("Retrieve $this->object_name: ".$query);
4687 //requireSingleResult has beeen deprecated.
4688 //$result = $this->db->requireSingleResult($query, true, "Retrieving record $where_clause:");
4689 $result = $this->db->limitQuery($query,0,1,true, "Retrieving record $where_clause:");
4696 if($this->db->getRowCount($result) > 1)
4698 $this->duplicates_found = true;
4700 $row = $this->db->fetchByAssoc($result, -1, $encode);
4705 $this->fetched_row = $row;
4706 $this->fromArray($row);
4707 $this->fill_in_additional_detail_fields();
4712 * This method is called during an import before inserting a bean
4713 * Define an associative array called $special_fields
4714 * the keys are user defined, and don't directly map to the bean's fields
4715 * the value is the method name within that bean that will do extra
4716 * processing for that field. example: 'full_name'=>'get_names_from_full_name'
4719 function process_special_fields()
4721 foreach ($this->special_functions as $func_name)
4723 if ( method_exists($this,$func_name) )
4725 $this->$func_name();
4731 * Override this function to build a where clause based on the search criteria set into bean .
4734 function build_generic_where_clause($value)
4738 function getRelatedFields($module, $id, $fields, $return_array = false){
4739 if(empty($GLOBALS['beanList'][$module]))return '';
4740 $object = $GLOBALS['beanList'][$module];
4741 if ($object == 'aCase') {
4745 VardefManager::loadVardef($module, $object);
4746 if(empty($GLOBALS['dictionary'][$object]['table']))return '';
4747 $table = $GLOBALS['dictionary'][$object]['table'];
4748 $query = 'SELECT id';
4749 foreach($fields as $field=>$alias){
4750 if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields'])){
4751 $query .= ' ,' .db_concat($table, $GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields']) . ' as ' . $alias ;
4752 }else if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]) &&
4753 (empty($GLOBALS['dictionary'][$object]['fields'][$field]['source']) ||
4754 $GLOBALS['dictionary'][$object]['fields'][$field]['source'] != "non-db"))
4756 $query .= ' ,' .$table . '.' . $field . ' as ' . $alias;
4758 if(!$return_array)$this->$alias = '';
4760 if($query == 'SELECT id' || empty($id)){
4765 if(isset($GLOBALS['dictionary'][$object]['fields']['assigned_user_id']))
4767 $query .= " , ". $table . ".assigned_user_id owner";
4770 else if(isset($GLOBALS['dictionary'][$object]['fields']['created_by']))
4772 $query .= " , ". $table . ".created_by owner";
4775 $query .= ' FROM ' . $table . ' WHERE deleted=0 AND id=';
4776 $result = $GLOBALS['db']->query($query . "'$id'" );
4777 $row = $GLOBALS['db']->fetchByAssoc($result);
4781 $owner = (empty($row['owner']))?'':$row['owner'];
4782 foreach($fields as $alias){
4783 $this->$alias = (!empty($row[$alias]))? $row[$alias]: '';
4784 $alias = $alias .'_owner';
4785 $this->$alias = $owner;
4786 $a_mod = $alias .'_mod';
4787 $this->$a_mod = $module;
4794 function &parse_additional_headers(&$list_form, $xTemplateSection)
4799 function assign_display_fields($currentModule)
4802 foreach($this->column_fields as $field)
4804 if(isset($this->field_name_map[$field]) && empty($this->$field))
4806 if($this->field_name_map[$field]['type'] != 'date' && $this->field_name_map[$field]['type'] != 'enum')
4807 $this->$field = $field;
4808 if($this->field_name_map[$field]['type'] == 'date')
4810 $this->$field = $timedate->to_display_date('1980-07-09');
4812 if($this->field_name_map[$field]['type'] == 'enum')
4814 $dom = $this->field_name_map[$field]['options'];
4815 global $current_language, $app_list_strings;
4816 $mod_strings = return_module_language($current_language, $currentModule);
4818 if(isset($mod_strings[$dom]))
4820 $options = $mod_strings[$dom];
4821 foreach($options as $key=>$value)
4823 if(!empty($key) && empty($this->$field ))
4825 $this->$field = $key;
4829 if(isset($app_list_strings[$dom]))
4831 $options = $app_list_strings[$dom];
4832 foreach($options as $key=>$value)
4834 if(!empty($key) && empty($this->$field ))
4836 $this->$field = $key;
4848 * RELATIONSHIP HANDLING
4851 function set_relationship($table, $relate_values, $check_duplicates = true,$do_update=false,$data_values=null)
4855 // make sure there is a date modified
4856 $date_modified = $this->db->convert("'".$GLOBALS['timedate']->nowDb()."'", 'datetime');
4859 if($check_duplicates)
4861 $query = "SELECT * FROM $table ";
4862 $where = "WHERE deleted = '0' ";
4863 foreach($relate_values as $name=>$value)
4865 $where .= " AND $name = '$value' ";
4868 $result = $this->db->query($query, false, "Looking For Duplicate Relationship:" . $query);
4869 $row=$this->db->fetchByAssoc($result);
4872 if(!$check_duplicates || empty($row) )
4874 unset($relate_values['id']);
4875 if ( isset($data_values))
4877 $relate_values = array_merge($relate_values,$data_values);
4879 $query = "INSERT INTO $table (id, ". implode(',', array_keys($relate_values)) . ", date_modified) VALUES ('" . create_guid() . "', " . "'" . implode("', '", $relate_values) . "', ".$date_modified.")" ;
4881 $this->db->query($query, false, "Creating Relationship:" . $query);
4883 else if ($do_update)
4886 foreach($data_values as $key=>$value)
4888 array_push($conds,$key."='".$this->db->quote($value)."'");
4890 $query = "UPDATE $table SET ". implode(',', $conds).",date_modified=".$date_modified." ".$where;
4891 $this->db->query($query, false, "Updating Relationship:" . $query);
4895 function retrieve_relationships($table, $values, $select_id)
4897 $query = "SELECT $select_id FROM $table WHERE deleted = 0 ";
4898 foreach($values as $name=>$value)
4900 $query .= " AND $name = '$value' ";
4902 $query .= " ORDER BY $select_id ";
4903 $result = $this->db->query($query, false, "Retrieving Relationship:" . $query);
4905 while($row = $this->db->fetchByAssoc($result))
4912 // TODO: this function needs adjustment
4913 function loadLayoutDefs()
4915 global $layout_defs;
4916 if(empty( $this->layout_def) && file_exists('modules/'. $this->module_dir . '/layout_defs.php'))
4918 include_once('modules/'. $this->module_dir . '/layout_defs.php');
4919 if(file_exists('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php'))
4921 include_once('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
4923 if ( empty( $layout_defs[get_class($this)]))
4925 echo "\$layout_defs[" . get_class($this) . "]; does not exist";
4928 $this->layout_def = $layout_defs[get_class($this)];
4933 * Trigger custom logic for this module that is defined for the provided hook
4934 * The custom logic file is located under custom/modules/[CURRENT_MODULE]/logic_hooks.php.
4935 * That file should define the $hook_version that should be used.
4936 * It should also define the $hook_array. The $hook_array will be a two dimensional array
4937 * the first dimension is the name of the event, the second dimension is the information needed
4938 * to fire the hook. Each entry in the top level array should be defined on a single line to make it
4939 * easier to automatically replace this file. There should be no contents of this file that are not replacable.
4941 * $hook_array['before_save'][] = Array(1, testtype, 'custom/modules/Leads/test12.php', 'TestClass', 'lead_before_save_1');
4942 * This sample line creates a before_save hook. The hooks are procesed in the order in which they
4943 * are added to the array. The second dimension is an array of:
4944 * processing index (for sorting before exporting the array)
4947 * php file to include
4948 * php class the method is in
4949 * php method to call
4951 * The method signature for version 1 hooks is:
4952 * function NAME(&$bean, $event, $arguments)
4953 * $bean - $this bean passed in by reference.
4954 * $event - The string for the current event (i.e. before_save)
4955 * $arguments - An array of arguments that are specific to the event.
4957 function call_custom_logic($event, $arguments = null)
4959 if(!isset($this->processed) || $this->processed == false){
4960 //add some logic to ensure we do not get into an infinite loop
4961 if(!empty($this->logicHookDepth[$event])) {
4962 if($this->logicHookDepth[$event] > 10)
4965 $this->logicHookDepth[$event] = 0;
4967 //we have to put the increment operator here
4968 //otherwise we may never increase the depth for that event in the case
4969 //where one event will trigger another as in the case of before_save and after_save
4970 //Also keeping the depth per event allow any number of hooks to be called on the bean
4971 //and we only will return if one event gets caught in a loop. We do not increment globally
4972 //for each event called.
4973 $this->logicHookDepth[$event]++;
4975 //method defined in 'include/utils/LogicHook.php'
4977 $logicHook = new LogicHook();
4978 $logicHook->setBean($this);
4979 $logicHook->call_custom_logic($this->module_dir, $event, $arguments);
4984 /* When creating a custom field of type Dropdown, it creates an enum row in the DB.
4985 A typical get_list_view_array() result will have the *KEY* value from that drop-down.
4986 Since custom _dom objects are flat-files included in the $app_list_strings variable,
4987 We need to generate a key-key pair to get the true value like so:
4988 ([module]_cstm->fields_meta_data->$app_list_strings->*VALUE*)*/
4989 function getRealKeyFromCustomFieldAssignedKey($name)
4991 if ($this->custom_fields->avail_fields[$name]['ext1'])
4995 elseif ($this->custom_fields->avail_fields[$name]['ext2'])
4999 elseif ($this->custom_fields->avail_fields[$name]['ext3'])
5005 $GLOBALS['log']->fatal("SUGARBEAN: cannot find Real Key for custom field of type dropdown - cannot return Value.");
5010 return $this->custom_fields->avail_fields[$name][$realKey];
5014 function bean_implements($interface)
5019 * Check whether the user has access to a particular view for the current bean/module
5020 * @param $view string required, the view to determine access for i.e. DetailView, ListView...
5021 * @param $is_owner bool optional, this is part of the ACL check if the current user is an owner they will receive different access
5023 function ACLAccess($view,$is_owner='not_set')
5025 global $current_user;
5026 if(is_admin($current_user)||is_admin_for_module($current_user,$this->getACLCategory()))return true;
5028 if($is_owner == 'not_set')
5031 $is_owner = $this->isOwner($current_user->id);
5034 //if we don't implent acls return true
5035 if(!$this->bean_implements('ACL'))
5037 $view = strtolower($view);
5043 return ACLController::checkAccess($this->module_dir,'list', true);
5046 if( !$is_owner && $not_set && !empty($this->id)){
5047 $class = get_class($this);
5048 $temp = new $class();
5049 if(!empty($this->fetched_row) && !empty($this->fetched_row['id']) && !empty($this->fetched_row['assigned_user_id']) && !empty($this->fetched_row['created_by'])){
5050 $temp->populateFromRow($this->fetched_row);
5052 $temp->retrieve($this->id);
5054 $is_owner = $temp->isOwner($current_user->id);
5056 case 'popupeditview':
5058 return ACLController::checkAccess($this->module_dir,'edit', $is_owner, $this->acltype);
5062 return ACLController::checkAccess($this->module_dir,'view', $is_owner, $this->acltype);
5064 return ACLController::checkAccess($this->module_dir,'delete', $is_owner, $this->acltype);
5066 return ACLController::checkAccess($this->module_dir,'export', $is_owner, $this->acltype);
5068 return ACLController::checkAccess($this->module_dir,'import', true, $this->acltype);
5070 //if it is not one of the above views then it should be implemented on the page level
5074 * Returns true of false if the user_id passed is the owner
5076 * @param GUID $user_id
5079 function isOwner($user_id)
5081 //if we don't have an id we must be the owner as we are creating it
5082 if(!isset($this->id))
5086 //if there is an assigned_user that is the owner
5087 if(isset($this->assigned_user_id))
5089 if($this->assigned_user_id == $user_id) return true;
5094 //other wise if there is a created_by that is the owner
5095 if(isset($this->created_by) && $this->created_by == $user_id)
5103 * Gets there where statement for checking if a user is an owner
5105 * @param GUID $user_id
5108 function getOwnerWhere($user_id)
5110 if(isset($this->field_defs['assigned_user_id']))
5112 return " $this->table_name.assigned_user_id ='$user_id' ";
5114 if(isset($this->field_defs['created_by']))
5116 return " $this->table_name.created_by ='$user_id' ";
5123 * Used in order to manage ListView links and if they should
5124 * links or not based on the ACL permissions of the user
5126 * @return ARRAY of STRINGS
5128 function listviewACLHelper()
5130 $array_assign = array();
5131 if($this->ACLAccess('DetailView'))
5133 $array_assign['MAIN'] = 'a';
5137 $array_assign['MAIN'] = 'span';
5139 return $array_assign;
5143 * returns this bean as an array
5145 * @return array of fields with id, name, access and category
5147 function toArray($dbOnly = false, $stringOnly = false, $upperKeys=false)
5149 static $cache = array();
5152 foreach($this->field_defs as $field=>$data)
5154 if( !$dbOnly || !isset($data['source']) || $data['source'] == 'db')
5155 if(!$stringOnly || is_string($this->$field))
5158 if(!isset($cache[$field])){
5159 $cache[$field] = strtoupper($field);
5161 $arr[$cache[$field]] = $this->$field;
5165 if(isset($this->$field)){
5166 $arr[$field] = $this->$field;
5176 * Converts an array into an acl mapping name value pairs into files
5180 function fromArray($arr)
5182 foreach($arr as $name=>$value)
5184 $this->$name = $value;
5189 * Loads a row of data into instance of a bean. The data is passed as an array to this function
5191 * @param array $arr row of data fetched from the database.
5194 * Internal function do not override.
5196 function loadFromRow($arr)
5198 $this->populateFromRow($arr);
5199 $this->processed_dates_times = array();
5200 $this->check_date_relationships_load();
5202 $this->fill_in_additional_list_fields();
5204 if($this->hasCustomFields())$this->custom_fields->fill_relationships();
5205 $this->call_custom_logic("process_record");
5208 function hasCustomFields(){
5209 return !empty($GLOBALS['dictionary'][$this->object_name]['custom_fields']);
5213 * Ensure that fields within order by clauses are properly qualified with
5214 * their tablename. This qualification is a requirement for sql server support.
5216 * @param string $order_by original order by from the query
5217 * @param string $qualify prefix for columns in the order by list.
5220 * Internal function do not override.
5222 function create_qualified_order_by( $order_by, $qualify)
5223 { // if the column is empty, but the sort order is defined, the value will throw an error, so do not proceed if no order by is given
5224 if (empty($order_by))
5228 $order_by_clause = " ORDER BY ";
5229 $tmp = explode(",", $order_by);
5231 foreach ( $tmp as $stmp)
5233 $stmp = (substr_count($stmp, ".") > 0?trim($stmp):"$qualify." . trim($stmp));
5234 $order_by_clause .= $comma . $stmp;
5237 return $order_by_clause;
5241 * Combined the contents of street field 2 thru 4 into the main field
5243 * @param string $street_field
5246 function add_address_streets(
5250 $street_field_2 = $street_field.'_2';
5251 $street_field_3 = $street_field.'_3';
5252 $street_field_4 = $street_field.'_4';
5253 if ( isset($this->$street_field_2)) {
5254 $this->$street_field .= "\n". $this->$street_field_2;
5255 unset($this->$street_field_2);
5257 if ( isset($this->$street_field_3)) {
5258 $this->$street_field .= "\n". $this->$street_field_3;
5259 unset($this->$street_field_3);
5261 if ( isset($this->$street_field_4)) {
5262 $this->$street_field .= "\n". $this->$street_field_4;
5263 unset($this->$street_field_4);
5265 if ( isset($this->$street_field)) {
5266 $this->$street_field = trim($this->$street_field, "\n");
5270 * Encrpyt and base64 encode an 'encrypt' field type in the bean using Blowfish. The default system key is stored in cache/Blowfish/{keytype}
5271 * @param STRING value -plain text value of the bean field.
5274 function encrpyt_before_save($value)
5276 require_once("include/utils/encryption_utils.php");
5277 return blowfishEncode(blowfishGetKey('encrypt_field'),$value);
5281 * Decode and decrypt a base 64 encoded string with field type 'encrypt' in this bean using Blowfish.
5282 * @param STRING value - an encrypted and base 64 encoded string.
5285 function decrypt_after_retrieve($value)
5287 require_once("include/utils/encryption_utils.php");
5288 return blowfishDecode(blowfishGetKey('encrypt_field'), $value);
5292 * Moved from save() method, functionality is the same, but this is intended to handle
5293 * Optimistic locking functionality.
5295 private function _checkOptimisticLocking($action, $isUpdate){
5296 if($this->optimistic_lock && !isset($_SESSION['o_lock_fs'])){
5297 if(isset($_SESSION['o_lock_id']) && $_SESSION['o_lock_id'] == $this->id && $_SESSION['o_lock_on'] == $this->object_name)
5299 if($action == 'Save' && $isUpdate && isset($this->modified_user_id) && $this->has_been_modified_since($_SESSION['o_lock_dm'], $this->modified_user_id))
5301 $_SESSION['o_lock_class'] = get_class($this);
5302 $_SESSION['o_lock_module'] = $this->module_dir;
5303 $_SESSION['o_lock_object'] = $this->toArray();
5304 $saveform = "<form name='save' id='save' method='POST'>";
5305 foreach($_POST as $key=>$arg)
5307 $saveform .= "<input type='hidden' name='". addslashes($key) ."' value='". addslashes($arg) ."'>";
5309 $saveform .= "</form><script>document.getElementById('save').submit();</script>";
5310 $_SESSION['o_lock_save'] = $saveform;
5311 header('Location: index.php?module=OptimisticLock&action=LockResolve');
5316 unset ($_SESSION['o_lock_object']);
5317 unset ($_SESSION['o_lock_id']);
5318 unset ($_SESSION['o_lock_dm']);
5324 if(isset($_SESSION['o_lock_object'])) { unset ($_SESSION['o_lock_object']); }
5325 if(isset($_SESSION['o_lock_id'])) { unset ($_SESSION['o_lock_id']); }
5326 if(isset($_SESSION['o_lock_dm'])) { unset ($_SESSION['o_lock_dm']); }
5327 if(isset($_SESSION['o_lock_fs'])) { unset ($_SESSION['o_lock_fs']); }
5328 if(isset($_SESSION['o_lock_save'])) { unset ($_SESSION['o_lock_save']); }
5333 * Send assignment notifications and invites for meetings and calls
5335 private function _sendNotifications($check_notify){
5336 if($check_notify || (isset($this->notify_inworkflow) && $this->notify_inworkflow == true)){ // cn: bug 5795 - no invites sent to Contacts, and also bug 25995, in workflow, it will set the notify_on_save=true.
5338 $admin = new Administration();
5339 $admin->retrieveSettings();
5340 $sendNotifications = false;
5342 if ($admin->settings['notify_on'])
5344 $GLOBALS['log']->info("Notifications: user assignment has changed, checking if user receives notifications");
5345 $sendNotifications = true;
5347 elseif(isset($_REQUEST['send_invites']) && $_REQUEST['send_invites'] == 1)
5349 // cn: bug 5795 Send Invites failing for Contacts
5350 $sendNotifications = true;
5354 $GLOBALS['log']->info("Notifications: not sending e-mail, notify_on is set to OFF");
5358 if($sendNotifications == true)
5360 $notify_list = $this->get_notification_recipients();
5361 foreach ($notify_list as $notify_user)
5363 $this->send_assignment_notifications($notify_user, $admin);
5371 * Called from ImportFieldSanitize::relate(), when creating a new bean in a related module. Will
5372 * copies fields over from the current bean into the related. Designed to be overriden in child classes.
5374 * @param SugarBean $newbean newly created related bean
5376 public function populateRelatedBean(
5383 * Called during the import process before a bean save, to handle any needed pre-save logic when
5384 * importing a record
5386 public function beforeImportSave()
5391 * Called during the import process after a bean save, to handle any needed post-save logic when
5392 * importing a record
5394 public function afterImportSave()
5399 * This function is designed to cache references to field arrays that were previously stored in the
5400 * bean files and have since been moved to seperate files. Was previously in include/CacheHandler.php
5403 * @param $module_dir string the module directory
5404 * @param $module string the name of the module
5405 * @param $key string the type of field array we are referencing, i.e. list_fields, column_fields, required_fields
5407 private function _loadCachedArray(
5413 static $moduleDefs = array();
5415 $fileName = 'field_arrays.php';
5417 $cache_key = "load_cached_array.$module_dir.$module.$key";
5418 $result = sugar_cache_retrieve($cache_key);
5421 // Use SugarCache::EXTERNAL_CACHE_NULL_VALUE to store null values in the cache.
5422 if($result == SugarCache::EXTERNAL_CACHE_NULL_VALUE)
5430 if(file_exists('modules/'.$module_dir.'/'.$fileName))
5432 // If the data was not loaded, try loading again....
5433 if(!isset($moduleDefs[$module]))
5435 include('modules/'.$module_dir.'/'.$fileName);
5436 $moduleDefs[$module] = $fields_array;
5438 // Now that we have tried loading, make sure it was loaded
5439 if(empty($moduleDefs[$module]) || empty($moduleDefs[$module][$module][$key]))
5441 // It was not loaded.... Fail. Cache null to prevent future repeats of this calculation
5442 sugar_cache_put($cache_key, SugarCache::EXTERNAL_CACHE_NULL_VALUE);
5446 // It has been loaded, cache the result.
5447 sugar_cache_put($cache_key, $moduleDefs[$module][$module][$key]);
5448 return $moduleDefs[$module][$module][$key];
5451 // It was not loaded.... Fail. Cache null to prevent future repeats of this calculation
5452 sugar_cache_put($cache_key, SugarCache::EXTERNAL_CACHE_NULL_VALUE);
5457 * Returns the ACL category for this module; defaults to the SugarBean::$acl_category if defined
5458 * otherwise it is SugarBean::$module_dir
5462 public function getACLCategory()
5464 return !empty($this->acl_category)?$this->acl_category:$this->module_dir;
5468 * Returns the query used for the export functionality for a module. Override this method if you wish
5469 * to have a custom query to pull this data together instead
5471 * @param string $order_by
5472 * @param string $where
5473 * @return string SQL query
5475 public function create_export_query($order_by, $where)
5477 return $this->create_new_list_query($order_by, $where, array(), array(), 0, '', false, $this, true);