init

modules/ModuleBuilder/parsers/views/AbstractMetaDataParser.php

@@ -0,0 +1,127 @@
+<?php
+if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
+/*********************************************************************************
+ * SugarCRM is a customer relationship management program developed by
+ * SugarCRM, Inc. Copyright (C) 2004-2010 SugarCRM Inc.
+ * 
+ * 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. If the display of the logo is not reasonably feasible for
+ * technical reasons, the Appropriate Legal Notices must display the words
+ * "Powered by SugarCRM".
+ ********************************************************************************/
+
+abstract class AbstractMetaDataParser
+{
+
+	//Make these properties public for now until we can create some usefull accessors
+	public $_fielddefs ;
+	public $_viewdefs ;
+	protected $_moduleName ;
+    protected $implementation ; // the DeployedMetaDataImplementation or UndeployedMetaDataImplementation object to handle the reading and writing of files and field data
+
+    function getLayoutAsArray ()
+    {
+        $viewdefs = $this->_panels ;
+    }
+
+    function getLanguage ()
+    {
+        return $this->implementation->getLanguage () ;
+    }
+
+    function getHistory ()
+    {
+        return $this->implementation->getHistory () ;
+    }
+    
+    function removeField ($fieldName)
+    {
+    	return false;
+    }
+
+    /*
+     * Is this field something we wish to show in Studio/ModuleBuilder layout editors?
+     * @param array $def    Field definition in the standard SugarBean field definition format - name, vname, type and so on
+     * @return boolean      True if ok to show, false otherwise
+     */
+    static function validField ( $def, $view = "")
+    {
+        //Studio invisible fields should always be hidden
+        if (isset ($def[ 'studio' ] ) )
+        {
+            if (is_array($def [ 'studio' ]))
+            {
+                if (!empty($view) && isset($def [ 'studio' ][$view]))
+                   return $def [ 'studio' ][$view] !== false && $def [ 'studio' ][$view] != 'false' && $def [ 'studio' ][$view] != 'hidden';
+                if (isset($def [ 'studio' ]['visible']))
+                   return $def [ 'studio' ]['visible'];
+            } else {
+                return ($def [ 'studio' ] != 'false' && $def [ 'studio' ] != 'hidden' && $def [ 'studio' ] !== false) ;
+			}
+        }
+
+        // bug 19656: this test changed after 5.0.0b - we now remove all ID type fields - whether set as type, or dbtype, from the fielddefs
+        return 
+		( 
+		  ( 
+		    (empty ( $def [ 'source' ] ) || $def [ 'source' ] == 'db' || $def [ 'source' ] == 'custom_fields') 
+			&& isset($def [ 'type' ]) && $def [ 'type' ] != 'id' && $def [ 'type' ] != 'parent_type'
+			&& (empty ( $def [ 'dbType' ] ) || $def [ 'dbType' ] != 'id') 
+			&& ( isset ( $def [ 'name' ] ) && strcmp ( $def [ 'name' ] , 'deleted' ) != 0 ) 
+		  ) // db and custom fields that aren't ID fields
+          ||
+		  // exclude fields named *_name regardless of their type...just convention
+          (isset ( $def [ 'name' ] ) && substr ( $def [ 'name' ], -5 ) === '_name' ) ) ;
+    }
+
+	protected function _standardizeFieldLabels ( &$fielddefs )
+	{
+		foreach ( $fielddefs as $key => $def )
+		{
+			if ( !isset ($def [ 'label' ] ) )
+			{
+				$fielddefs [ $key ] [ 'label'] = ( isset ( $def [ 'vname' ] ) ) ? $def [ 'vname' ] : $key ;
+			}
+		}
+	}
+
+	abstract static function _trimFieldDefs ( $def ) ;
+	
+	public function getRequiredFields(){
+	    $fieldDefs = $this->implementation->getFielddefs();
+	    $newAry = array();
+	    foreach($fieldDefs as $field){
+	        if(isset($field['required']) && $field['required'] && isset($field['name'])){
+	            array_push($newAry , '"'.$field['name'].'"');
+            }
+        }
+        return $newAry;
+	}
+
+}
+?>