adamjakab / SuiteCRM

include/MVC/View/views/view.metadata.php

<?php

/*********************************************************************************
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.

 * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
 * Copyright (C) 2011 - 2014 Salesagility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for  technical reasons, the Appropriate Legal Notices must
 * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 ********************************************************************************/


require_once('include/DetailView/DetailView2.php');

class ViewMetadata extends SugarView{
	var $type ='detail';
	var $dv;
	
	
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	function displayCheckBoxes($name,$values, $selected =array(), $attr=''){
 		echo "<div $attr style='overflow:auto;float:left;width:200px;height:200px' >";
		foreach($values as $value){
		 	$checked = in_array($value, $selected)? " checked=checked ": " ";
			echo "<div style='padding:2px'><input type='checkbox' name='$name' value='$value' $checked> $value</div>";
		}
		echo "</div>";
 	}
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	function displaySelect($name,$values, $selected ='', $attr=''){
 		echo "<select name='$name' $attr>";
		foreach($values as $value){
		 	$checked = $value == $selected? " selected=selected ": " ";
			echo "<option value='$value' $checked> $value</option>";
		}
		echo "</select>";
 	}
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

There is some trailing whitespace on this line which should be avoided as per coding-style.

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	 function displayTextBoxes($values, $attr=''){
 		echo "<div $attr style='overflow:auto;float:left;width:400px;height:200px' >";
		foreach($values as $value){
			$postvalue = !empty($_POST[$value])? $_POST[$value]: '';
			echo "<div style='padding:2px;width:150px;float:left'>$value</div>  <input type='text' name='$value' value='$postvalue'> ";
		}
		echo "</div>";
 	}
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

There is some trailing whitespace on this line which should be avoided as per coding-style.

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	function printValue($value, $depth=0){
 		echo "<pre>";
 		print_r($value);
 		echo "</pre>";
 		
 	}
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

 	function display(){
 		$do = !empty($_REQUEST['do'])?$_REQUEST['do']:'';
 		echo "<form method='post'>";
 		echo "<div><h2>I want to learn about ";
 		
 		$this->displaySelect('do', array('Nothing', 'Modules','Fields', 'Field Attributes', 'Relationships'), $do, 'onchange="toggleLearn(this.value)"');
 		echo "<input type='submit' value='Learn' class='button'></h2></div>";
		$modules = !empty($_REQUEST['modules'])?$_REQUEST['modules']:array();
		if(empty($modules) && !empty($_REQUEST['module']) && $_REQUEST['module'] != 'Home'){
			$modules = array(	$_REQUEST['module']);
		}
 		$this->displayCheckBoxes('modules[]', VardefBrowser::getModules(), $modules, ' id="_modules" ');
 		$attributes = !empty($_REQUEST['attributes'])?$_REQUEST['attributes']:array();
 		$allAttributes = array_keys(VardefBrowser::findFieldAttributes());
 		sort($allAttributes);
 		$this->displayCheckBoxes('attributes[]', $allAttributes, $attributes, ' id="_attributes" ');
 		$this->displayTextBoxes($allAttributes, ' id="_fields" ');
 		echo "</form>";
 		 		echo <<<EOQ
 		<script>
 			function toggleLearn(value){
 				document.getElementById('_modules').style.display = 'None';	
 				document.getElementById('_attributes').style.display = 'None';	
 				document.getElementById('_fields').style.display = 'None';	
 				if(value == 'Modules' || value == 'Relationships'){
 					document.getElementById('_modules').style.display = '';	
 				}
 				if(value == 'Fields'){
 					document.getElementById('_modules').style.display = '';
 					document.getElementById('_fields').style.display = '';
 				}	
 				if(value == 'Field Attributes'){
 					document.getElementById('_modules').style.display = '';
 					document.getElementById('_attributes').style.display = '';
 				}	
 			}
 			toggleLearn('$do');
 			
 		</script>
 		
EOQ;
 		echo "<div width='100%'></div><div><div style='float:left'>";
 		switch ($do){
 			case 'Modules':
 				$this->printValue(VardefBrowser::findVardefs( $modules));	
 				break;
 			case 'Field Attributes':
 				$this->printValue(VardefBrowser::findFieldAttributes($attributes, $modules));
 				break;
 			case 'Fields':
 				$searchFor = array();
 				foreach($allAttributes as $at){
 					if(!empty($_POST[$at])){
 						$searchFor[$at] = $_POST[$at];
 					}	
 				}
 				
 				$this->printValue(VardefBrowser::findFieldsWithAttributes($searchFor, $modules));
 				break;
 			default:
 				echo <<<EOQ
 				<div style='border:1px solid;width:100%;text-align:center;-moz-border-radius: 5px;border-radius: 5px;'>
 					<h2 style='text-decoration: line-through'>All you ever wanted to know about Vardefs in 30 minutes</h2>
 					<h2 style='text-decoration: line-through'>All you ever wanted to know about Vardef Fields and Relationships in 30 minutes</h1>
 					<h2 style='text-decoration: line-through'>All you ever wanted to know about Vardef Fields in 30 minutes</h2>
 					<h2 >Something about Vardefs in 30 minutes</h2>
 				</div>
 				
 				<div style='border:1px solid;width:100%;-moz-border-radius: 5px;border-radius: 5px;'>
 					<h4>What you need to know</h4>
 					<pre>
Vardefs are where we define information about the fields for a module. 
 					
It also specifies 75% of the information on relationships. 
 					
There are also special attributes that can enable additional functionality for a module. 
 					
It's broken down into:
	<b>fields:</b> The fields of a module (most of these are stored in the database)
	
	<b>indices:</b> The indicies on the database
	
	<b>relationships:</b> The relationships for this module
	
	<b>templates:</b> the functionality/fields this module inherits from SugarObjects(located in include/SugarObjects). 
		In a vardef these are specified by the third argument in VardefManager::createVardef
		For Example - <b>VardefManager::createVardef('Contacts','Contact', array('default', 'assignable','team_security','person'));</b>
		would add the fields for team security to contacts and make it an object that can be assigned to users.
		The 'person' value would indicate that that Contacts subclasses Person and gains all the fields/attributes that 'Person' 
		would get. Since person extends basic it would also gain all the fields/attributes of basic as well.
					  
					 
		The SugarObjects that a module can extend are <b>'basic', 'company', 'file', 'issue', 'person'</b>. 
		These are the same objects you can build off of in ModuleBuilder. 
		Adding a new SugarObject to include/SugarObjects/templates is the way 
		to add modules to ModuleBuilder
					 
		Besides extending base objects, a module can also implement functionality defined in SugarObjects. 
		You can currenty implement <b>'assignable' and 'team_security'</b>. 
		
		
	<b>attributes:</b>
		<b>[table] (string) (required)</b> The database table where this module stores it's data - any custom fields will be stored in a new table 
			with '_cstm' appended to the table name. The field id_c in the custom table will be the same value as id in the primary table
			allowing us to join the two tables together. 
		
		<b>[comment] (string) (optional)</b> is a description of the module
		
		<b>[unified_search] (bool)(optional)</b> is global search (the search in the upper right corner on the screen) available for this module
		
		<b>[unified_search_default_enabled] (bool)(optional)</b> is this module available by default in global search
		
		<b>[optimistic_locking] (bool) (optional)</b> optimistic locking is the concept that on save if the record modifiy time (date_modified)
			 is newer than the the modify time of the record when it was loaded to edit (this time is stored in the session). 
		
		<b>[favorites] (bool) (optional)</b> should favorites be enabled for this module. Favorites are indicated by the stars next to a record 
			on lists and deail views. It makes it easier for users to indicate what is important to them right now. It also allows them to filter
			by favorites.  
			
		<b>[duplicate_merge] (bool) (optional)</b> is systematic merging allowed between records of this module or not. This option is available from 
			the menu on list views. A user needs to select 2 records on the list view using the checkboxes, and then they can select merge from the actions
			menu.
			
		<b>[audited] (bool) (optional)</b> auditing allows for the tracking of any changes to specified fields. In order to enable auditing you need to enable
			it at both the module level and the field level. It will create an audit table for the module with the '_audit' appended to the table name.
			
		<b>[custom_fields] (bool) (automatic) </b> if the module has custom fields this will be set to true
		
			
		
		
		
					 
					 

					  
					
					
					</pre>
 				</div>
 				
 				<div>
 				
 				</div>
 				
EOQ;
 					
 			
 		}
 		echo "</div><div style='float:right'>Help Text</div></div>";
 		
 		
 		//$this->printValue(VardefBrowser::findFieldsWithAttributes(array('type'=>'id'), $modules));
 		
 	

There is some trailing whitespace on this line which should be avoided as per coding-style.

 		
 		
 		
 	}

}

class VardefBrowser{

PSR1 recommends that each class should be in its own file to aid autoloaders.

	function __construct(){
		
	}
	
	static function getModules(){
		$modules = array();
		foreach($GLOBALS['beanList'] as $module=>$object){
			$object = BeanFactory::getObjectName($module);
			VardefManager::loadVardef($module, $object);
			if(empty($GLOBALS['dictionary'][$object]['fields'] ))continue;
			$modules[] = $module;
		}
		sort($modules);
		return $modules;
	
		
	}
	
	static function findFieldsWithAttributes($attributes, $modules=null){
		$fields = array();
		if(empty($modules))$modules = VardefBrowser::getModules();
		foreach($modules as $module){
			if(!empty($GLOBALS['beanList'][$module])){
				$object = $GLOBALS['beanList'][$module];
				if($object == 'aCase')$object = 'Case';
				VardefManager::loadVardef($module, $object);
				if(empty($GLOBALS['dictionary'][$object]['fields'] ))continue;
				foreach($GLOBALS['dictionary'][$object]['fields'] as $name=>$def){
					$match = true;
					foreach($attributes as $k=>$v){
						$alt = false;
						if($k == 'type'){
							$alt = 'dbType';	
						}
						if($v == 'true' && !empty($def[$k])){
							continue;
						}
						if((empty($def[$k]) || $def[$k] != $v) && (empty($alt) || empty($def[$alt]) || $def[$alt] != $v )){
							$match = false;	
						}
					}
					if($match){
						$fields[$module][$object][$name] = $def;
					}
					
				}
				
			}	
		}
		return $fields;			
	}
	
		static function findVardefs($modules=null){
			$defs = array();
			if(empty($modules))$modules = VardefBrowser::getModules();
			foreach($modules as $module){
				if(!empty($GLOBALS['beanList'][$module])){
					$object = $GLOBALS['beanList'][$module];
					if($object == 'aCase')$object = 'Case';
					VardefManager::loadVardef($module, $object);
					if(empty($GLOBALS['dictionary'][$object]['fields'] ))continue;
					$defs[$module][$object] = $GLOBALS['dictionary'][$object];
				}
			}
			return $defs;
		}
	
	
		static function findFieldAttributes($attributes=array(), $modules=null, $byModule=false, $byType=false){
		$fields = array();
		if(empty($modules))$modules = VardefBrowser::getModules();
		foreach($modules as $module){
			if(!empty($GLOBALS['beanList'][$module])){
				$object = $GLOBALS['beanList'][$module];
				if($object == 'aCase')$object = 'Case';
				VardefManager::loadVardef($module, $object);
				if(empty($GLOBALS['dictionary'][$object]['fields'] ))continue;
				foreach($GLOBALS['dictionary'][$object]['fields'] as $name=>$def){
					$fieldAttributes = (!empty($attributes))? $attributes:array_keys($def);
					foreach($fieldAttributes as $k){
						if(isset($def[$k])){
							$v  = var_export($def[$k], true);
							$key = is_array($def[$k])?null:$def[$k];
							if($k == 'type'){
								if(isset($def['dbType'])){
									$v = var_export($def['dbType'], true);	
								}	
							}
							if($byModule){
								$fields[$module][$object][$def['type']][$k][$key] = $v;
							}else{
								if($byType){
									$fields[$def['type']][$k][$key] = $v;	
								}else{
									if(!is_array($def[$k])){
										if(isset($fields[$k][$key])){
											$fields[$k][$key]['refs']++;
										}else{
											$fields[$k][$key] = array('attribute'=>$v, 'refs'=>1);		
										}
									}else{
										$fields[$k]['_array'][] = $def[$k];	

									}
								}
							}
							
							
						}
						
					}
					
					
				
				}
				
			}	
		}
		return $fields;			
	}
	
	

}