modules/ModuleBuilder/parsers/views/GridLayoutMetaDataParser.php

   1 <?php
   2 if (! defined ( 'sugarEntry' ) || ! sugarEntry)
   3     die ( 'Not A Valid Entry Point' ) ;
   4 /*********************************************************************************
   5  * SugarCRM is a customer relationship management program developed by
   6  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Affero General Public License version 3 as published by the
  10  * Free Software Foundation with the addition of the following permission added
  11  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License along with
  21  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301 USA.
  24  *
  25  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27  *
  28  * The interactive user interfaces in modified source and object code versions
  29  * of this program must display Appropriate Legal Notices, as required under
  30  * Section 5 of the GNU Affero General Public License version 3.
  31  *
  32  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33  * these Appropriate Legal Notices must retain the display of the "Powered by
  34  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  35  * technical reasons, the Appropriate Legal Notices must display the words
  36  * "Powered by SugarCRM".
  37  ********************************************************************************/
  38
  39
  40 require_once 'modules/ModuleBuilder/parsers/views/AbstractMetaDataParser.php' ;
  41 require_once 'modules/ModuleBuilder/parsers/views/MetaDataParserInterface.php' ;
  42 require_once 'modules/ModuleBuilder/parsers/constants.php' ;
  43
  44 class GridLayoutMetaDataParser extends AbstractMetaDataParser implements MetaDataParserInterface
  45 {
  46
  47     static $variableMap = array (
  48         MB_EDITVIEW => 'EditView' ,
  49         MB_DETAILVIEW => 'DetailView' ,
  50         MB_QUICKCREATE => 'QuickCreate',
  51         ) ;
  52
  53         protected $FILLER ;
  54
  55     /*
  56      * Constructor
  57      * @param string view           The view type, that is, editview, searchview etc
  58      * @param string moduleName     The name of the module to which this view belongs
  59      * @param string packageName    If not empty, the name of the package to which this view belongs
  60      */
  61     function __construct ($view , $moduleName , $packageName = '')
  62     {
  63         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->__construct( {$view} , {$moduleName} , {$packageName} )" ) ;
  64
  65         $view = strtolower ( $view ) ;
  66
  67         // BEGIN ASSERTIONS
  68         if (! isset ( self::$variableMap [ $view ] ) )
  69             sugar_die ( get_class ( $this ) . ": View $view is not supported" ) ;
  70         // END ASSERTIONS
  71
  72                 $this->FILLER = array ( 'name' => MBConstants::$FILLER['name'] , 'label' => translate ( MBConstants::$FILLER['label'] ) ) ;
  73
  74         $this->_moduleName = $moduleName ;
  75         $this->_view = $view ;
  76
  77         if (empty ( $packageName ))
  78         {
  79             require_once 'modules/ModuleBuilder/parsers/views/DeployedMetaDataImplementation.php' ;
  80             $this->implementation = new DeployedMetaDataImplementation ( $view, $moduleName, self::$variableMap ) ;
  81         } else
  82         {
  83             require_once 'modules/ModuleBuilder/parsers/views/UndeployedMetaDataImplementation.php' ;
  84             $this->implementation = new UndeployedMetaDataImplementation ( $view, $moduleName, $packageName ) ;
  85         }
  86
  87         $viewdefs = $this->implementation->getViewdefs () ;
  88
  89         if (! isset ( $viewdefs [ self::$variableMap [ $view ] ] ))
  90             sugar_die ( get_class ( $this ) . ": missing variable " . self::$variableMap [ $view ] . " in layout definition" ) ;
  91
  92         $viewdefs = $viewdefs [ self::$variableMap [ $view ] ] ;
  93         if (! isset ( $viewdefs [ 'templateMeta' ] ))
  94             sugar_die ( get_class ( $this ) . ": missing templateMeta section in layout definition (case sensitive)" ) ;
  95
  96         if (! isset ( $viewdefs [ 'panels' ] ))
  97             sugar_die ( get_class ( $this ) . ": missing panels section in layout definition (case sensitive)" ) ;
  98
  99         $this->_viewdefs = $viewdefs ;
 100         if ($this->getMaxColumns () < 1)
 101             sugar_die ( get_class ( $this ) . ": maxColumns=" . $this->getMaxColumns () . " - must be greater than 0!" ) ;
 102
 103         $this->_fielddefs =  $this->implementation->getFielddefs() ;
 104         $this->_standardizeFieldLabels( $this->_fielddefs );
 105         $this->_viewdefs [ 'panels' ] = $this->_convertFromCanonicalForm ( $this->_viewdefs [ 'panels' ] , $this->_fielddefs ) ; // put into our internal format
 106         $this->_originalViewDef = $this->getFieldsFromLayout($this->implementation->getOriginalViewdefs ());
 107     }
 108
 109     /*
 110      * Save a draft layout
 111      */
 112     function writeWorkingFile ($populate = true)
 113     {
 114         if ($populate)
 115             $this->_populateFromRequest ( $this->_fielddefs ) ;
 116
 117         $viewdefs = $this->_viewdefs ;
 118         $viewdefs [ 'panels' ] = $this->_convertToCanonicalForm ( $this->_viewdefs [ 'panels' ] , $this->_fielddefs ) ;
 119         $this->implementation->save ( array ( self::$variableMap [ $this->_view ] => $viewdefs ) ) ;
 120     }
 121
 122     /*
 123      * Deploy the layout
 124      * @param boolean $populate If true (default), then update the layout first with new layout information from the $_REQUEST array
 125      */
 126     function handleSave ($populate = true)
 127     {
 128         $GLOBALS [ 'log' ]->info ( get_class ( $this ) . "->handleSave()" ) ;
 129
 130         if ($populate)
 131             $this->_populateFromRequest ( $this->_fielddefs ) ;
 132
 133         $viewdefs = $this->_viewdefs ;
 134         $viewdefs [ 'panels' ] = $this->_convertToCanonicalForm ( $this->_viewdefs [ 'panels' ] , $this->_fielddefs ) ;
 135         $this->implementation->deploy ( array ( self::$variableMap [ $this->_view ] => $viewdefs ) ) ;
 136     }
 137
 138     /*
 139      * Return the layout, padded out with (empty) and (filler) fields ready for display
 140      */
 141     function getLayout ()
 142     {
 143         $viewdefs = array () ;
 144         $fielddefs = $this->_fielddefs;
 145         $fielddefs [ $this->FILLER [ 'name' ] ] = $this->FILLER ;
 146         $fielddefs [ MBConstants::$EMPTY [ 'name' ] ] = MBConstants::$EMPTY ;
 147
 148                 foreach ( $this->_viewdefs [ 'panels' ] as $panelID => $panel )
 149         {
 150             foreach ( $panel as $rowID => $row )
 151             {
 152                 foreach ( $row as $colID => $fieldname )
 153                 {
 154                         if (isset ($this->_fielddefs [ $fieldname ]))
 155                                         {
 156                                                 $viewdefs [ $panelID ] [ $rowID ] [ $colID ] = self::_trimFieldDefs( $this->_fielddefs [ $fieldname ] ) ;
 157                                         }
 158                                         else if (isset($this->_originalViewDef [ $fieldname ]) && is_array($this->_originalViewDef [ $fieldname ]))
 159                                         {
 160                                                 $viewdefs [ $panelID ] [ $rowID ] [ $colID ] = self::_trimFieldDefs( $this->_originalViewDef [ $fieldname ] ) ;
 161                                         }
 162                                         else
 163                                         {
 164                                                 $viewdefs [ $panelID ] [ $rowID ] [ $colID ] = array("name" => $fieldname, "label" => $fieldname);
 165                                         }
 166                 }
 167             }
 168         }
 169         return $viewdefs ;
 170     }
 171
 172     function getMaxColumns ()
 173     {
 174         if (!empty( $this->_viewdefs) && isset($this->_viewdefs [ 'templateMeta' ] [ 'maxColumns' ]))
 175                 {
 176                         return $this->_viewdefs [ 'templateMeta' ] [ 'maxColumns' ] ;
 177                 }else
 178                 {
 179                         return 2;
 180                 }
 181     }
 182
 183     function getAvailableFields ()
 184     {
 185
 186         // Obtain the full list of valid fields in this module
 187         $availableFields = array () ;
 188         foreach ( $this->_fielddefs as $key => $def )
 189         {
 190             if ( GridLayoutMetaDataParser::validField ( $def,  $this->_view ) || isset($this->_originalViewDef[$key]) )
 191             {
 192                 //If the field original label existing, we should use the original label instead the label in its fielddefs.
 193                 if(isset($this->_originalViewDef[$key]) && is_array($this->_originalViewDef[$key]) && isset($this->_originalViewDef[$key]['label'])){
 194                     $availableFields [ $key ] = array ( 'name' => $key , 'label' => $this->_originalViewDef[$key]['label']) ;
 195                 }else{
 196                     $availableFields [ $key ] = array ( 'name' => $key , 'label' => isset($def [ 'label' ]) ? $def [ 'label' ] : $def['vname'] ) ; // layouts use 'label' not 'vname' for the label entry
 197             }
 198             }
 199
 200         }
 201
 202                 // Available fields are those that are in the Model and the original layout definition, but not already shown in the View
 203         // So, because the formats of the two are different we brute force loop through View and unset the fields we find in a copy of Model
 204         if (! empty ( $this->_viewdefs ))
 205         {
 206             foreach ( $this->_viewdefs [ 'panels' ] as $panel )
 207             {
 208                 foreach ( $panel as $row )
 209                 {
 210                     foreach ( $row as $field )
 211                     {
 212                         unset ( $availableFields [ $field ] ) ;
 213                     }
 214                 }
 215             }
 216         }
 217
 218         return $availableFields ;
 219     }
 220
 221     function getPanelDependency ( $panelID )
 222     {
 223         if ( ! isset ( $this->_viewdefs [ 'templateMeta' ][ 'dependency' ] ) && ! isset ( $this->_viewdefs [ 'templateMeta' ][ 'dependency' ] [ $panelID ] ) )
 224                 return false;
 225
 226         return $this->_viewdefs  [ 'templateMeta' ][ 'dependency' ] [ $panelID ] ;
 227     }
 228
 229     /*
 230      * Add a new field to the layout
 231      * If $panelID is passed in, attempt to add to that panel, otherwise add to the first panel
 232      * The field is added in place of the first empty (not filler) slot after the last field in the panel; if that row is full, then a new row will be added to the end of the panel
 233      * and the field added to the start of it.
 234      * @param array $def Set of properties for the field, in same format as in the viewdefs
 235      * @param string $panelID Identifier of the panel to add the field to; empty or false if we should use the first panel
 236      */
 237     function addField ( $def , $panelID = FALSE)
 238     {
 239
 240         if (count ( $this->_viewdefs [ 'panels' ] ) == 0)
 241         {
 242             $GLOBALS [ 'log' ]->error ( get_class ( $this ) . "->addField(): _viewdefs empty for module {$this->_moduleName} and view {$this->_view}" ) ;
 243         }
 244
 245         // if a panelID was not provided, use the first available panel in the list
 246         if (! $panelID)
 247         {
 248             $panels = array_keys ( $this->_viewdefs [ 'panels' ] ) ;
 249             list ( $dummy, $panelID ) = each ( $panels ) ;
 250         }
 251
 252         if (isset ( $this->_viewdefs [ 'panels' ] [ $panelID ] ))
 253         {
 254
 255             $panel = $this->_viewdefs [ 'panels' ] [ $panelID ] ;
 256             $lastrow = count ( $panel ) - 1 ; // index starts at 0
 257             $maxColumns = $this->getMaxColumns () ;
 258             $lastRowDef = $this->_viewdefs [ 'panels' ] [ $panelID ] [ $lastrow ];
 259             for ( $column = 0 ; $column < $maxColumns ; $column ++ )
 260             {
 261                 if (! isset ( $lastRowDef [ $column ] )
 262                         || (is_array( $lastRowDef [ $column ]) && $lastRowDef [ $column ][ 'name' ] == '(empty)')
 263                         || (is_string( $lastRowDef [ $column ]) && $lastRowDef [ $column ] == '(empty)')
 264                 ){
 265                     break ;
 266                 }
 267             }
 268
 269             // if we're on the last column of the last row, start a new row
 270             if ($column >= $maxColumns)
 271             {
 272                 $lastrow ++ ;
 273                 $this->_viewdefs [ 'panels' ] [ $panelID ] [ $lastrow ] = array ( ) ;
 274                 $column = 0 ;
 275             }
 276
 277             $this->_viewdefs [ 'panels' ] [ $panelID ] [ $lastrow ] [ $column ] = $def [ 'name' ] ;
 278             // now update the fielddefs
 279             if (isset($this->_fielddefs [ $def [ 'name' ] ]))
 280             {
 281                 $this->_fielddefs [ $def [ 'name' ] ] = array_merge ( $this->_fielddefs [ $def [ 'name' ] ] , $def ) ;
 282             } else
 283             {
 284                 $this->_fielddefs [ $def [ 'name' ] ] = $def;
 285             }
 286         }
 287         return true ;
 288     }
 289
 290     /*
 291      * Remove all instances of a field from the layout, and replace by (filler)
 292      * Filler because we attempt to preserve the customized layout as much as possible - replacing by (empty) would mean that the positions or sizes of adjacent fields may change
 293      * If the last row of a panel only consists of (filler) after removing the fields, then remove the row also. This undoes the standard addField() scenario;
 294      * If the fields had been moved around in the layout however then this will not completely undo any addField()
 295      * @param string $fieldName Name of the field to remove
 296      * @return boolean True if the field was removed; false otherwise
 297      */
 298     function removeField ($fieldName)
 299     {
 300         $GLOBALS [ 'log' ]->info ( get_class ( $this ) . "->removeField($fieldName)" ) ;
 301
 302         $result = false ;
 303         reset ( $this->_viewdefs ) ;
 304         $firstPanel = each ( $this->_viewdefs [ 'panels' ] ) ;
 305         $firstPanelID = $firstPanel [ 'key' ] ;
 306
 307         foreach ( $this->_viewdefs [ 'panels' ] as $panelID => $panel )
 308         {
 309             $lastRowTouched = false ;
 310             $lastRowID = count ( $this->_viewdefs [ 'panels' ] [ $panelID ] ) - 1 ; // zero offset
 311
 312             foreach ( $panel as $rowID => $row )
 313             {
 314
 315                 foreach ( $row as $colID => $field )
 316                     if ($field == $fieldName)
 317                     {
 318                         $lastRowTouched = $rowID ;
 319                         $this->_viewdefs [ 'panels' ] [ $panelID ] [ $rowID ] [ $colID ] = $this->FILLER [ 'name' ];
 320                     }
 321
 322             }
 323
 324             // if we removed a field from the last row of this panel, tidy up if the last row now consists only of (empty) or (filler)
 325
 326             if ( $lastRowTouched ==  $lastRowID )
 327             {
 328                 $lastRow = $this->_viewdefs [ 'panels' ] [ $panelID ] [ $lastRowID ] ; // can't use 'end' for this as we need the key as well as the value...
 329
 330                 $empty = true ;
 331
 332                 foreach ( $lastRow as $colID => $field )
 333                     $empty &=  $field == MBConstants::$EMPTY ['name' ] || $field == $this->FILLER [ 'name' ]  ;
 334
 335                 if ($empty)
 336                 {
 337                     unset ( $this->_viewdefs [ 'panels' ] [ $panelID ] [ $lastRowID ] ) ;
 338                     // if the row was the only one in the panel, and the panel is not the first (default) panel, then remove the panel also
 339                                         if ( count ( $this->_viewdefs [ 'panels' ] [ $panelID ] ) == 0 && $panelID != $firstPanelID )
 340                                                 unset ( $this->_viewdefs [ 'panels' ] [ $panelID ] ) ;
 341                 }
 342
 343             }
 344
 345             $result |= ($lastRowTouched !== false ); // explicitly compare to false as row 0 will otherwise evaluate as false
 346         }
 347
 348         return $result ;
 349
 350     }
 351
 352     function setPanelDependency ( $panelID , $dependency )
 353     {
 354         // only accept dependencies for pre-existing panels
 355         if ( ! isset ( $this->_viewdefs [ 'panels' ] [ $panelID ] ) )
 356                 return false;
 357
 358         $this->_viewdefs  [ 'templateMeta' ] [ 'dependency' ] [ $panelID ] = $dependency ;
 359         return true ;
 360     }
 361
 362     /*
 363      * Return an integer value for the next unused panel identifier, such that it and any larger numbers are guaranteed to be unused already in the layout
 364      * Necessary when adding new panels to a layout
 365      * @return integer First unique panel ID suffix
 366      */
 367     function getFirstNewPanelId ()
 368     {
 369         $firstNewPanelId = 0 ;
 370         foreach ( $this->_viewdefs [ 'panels' ] as $panelID => $panel )
 371         {
 372             // strip out all but the numerics from the panelID - can't just use a cast as numbers may not be first in the string
 373             for ( $i = 0, $result = '' ; $i < strlen ( $panelID ) ; $i ++ )
 374             {
 375                 if (is_numeric ( $panelID [ $i ] ))
 376                 {
 377                     $result .= $panelID [ $i ] ;
 378                 }
 379             }
 380
 381             $firstNewPanelId = max ( ( int ) $result, $firstNewPanelId ) ;
 382         }
 383         return $firstNewPanelId + 1 ;
 384     }
 385
 386     /*
 387      * Load the panel layout from the submitted form and update the _viewdefs
 388      */
 389     protected function _populateFromRequest ( &$fielddefs )
 390     {
 391         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->populateFromRequest()" ) ;
 392         $i = 1 ;
 393
 394         // set up the map of panel# (as provided in the _REQUEST) to panel ID (as used in $this->_viewdefs['panels'])
 395         $i = 1 ;
 396         foreach ( $this->_viewdefs [ 'panels' ] as $panelID => $panel )
 397         {
 398             $panelMap [ $i ++ ] = $panelID ;
 399         }
 400
 401         foreach ( $_REQUEST as $key => $displayLabel )
 402         {
 403             $components = explode ( '-', $key ) ;
 404             if ($components [ 0 ] == 'panel' && $components [ 2 ] == 'label')
 405             {
 406                 $panelMap [ $components [ '1' ] ] = $displayLabel ;
 407             }
 408         }
 409
 410         $this->_viewdefs [ 'panels' ] = array () ; // because the new field properties should replace the old fields, not be merged
 411
 412         // run through the $_REQUEST twice - first to obtain the fieldnames, the second to update the field properties
 413         for ( $pass=1 ; $pass<=2 ; $pass++ )
 414         {
 415                 foreach ( $_REQUEST as $slot => $value )
 416                 {
 417                 $slotComponents = explode ( '-', $slot ) ; // [0] = 'slot', [1] = panel #, [2] = slot #, [3] = property name
 418
 419                 if ($slotComponents [ 0 ] == 'slot')
 420                 {
 421                         $slotNumber = $slotComponents [ '2' ] ;
 422                         $panelID = $panelMap [ $slotComponents [ '1' ] ] ;
 423                         $rowID = floor ( $slotNumber / $this->getMaxColumns () ) ;
 424                         $colID = $slotNumber - ($rowID * $this->getMaxColumns ()) ;
 425                         $property = $slotComponents [ '3' ] ;
 426
 427                         //If this field has a custom definition, copy that over
 428                         if ( $pass == 1 )
 429                         {
 430                                 if ( $property == 'name' )
 431                                 $this->_viewdefs [ 'panels' ] [ $panelID ] [ $rowID ] [ $colID ] = $value ;
 432                         } else
 433                         {
 434                                 // update fielddefs for this property in the provided position
 435                                 if ( isset ( $this->_viewdefs [ 'panels' ] [ $panelID ] [ $rowID ] [ $colID ] ) )
 436                                 {
 437                                         $fieldname = $this->_viewdefs [ 'panels' ] [ $panelID ] [ $rowID ] [ $colID ] ;
 438                                                         $fielddefs [ $fieldname ] [ $property ] = $value ;
 439                                 }
 440                         }
 441                 }
 442
 443                 }
 444         }
 445
 446         //Set the tabs setting
 447         if (isset($_REQUEST['panels_as_tabs']))
 448         {
 449                 if ($_REQUEST['panels_as_tabs'] == false || $_REQUEST['panels_as_tabs'] == "false")
 450                    $this->setUseTabs( false );
 451                 else
 452                    $this->setUseTabs( true );
 453         }
 454
 455         //bug: 38232 - Set the sync detail and editview settings
 456         if (isset($_REQUEST['sync_detail_and_edit']))
 457         {
 458                 if ($_REQUEST['sync_detail_and_edit'] == false || $_REQUEST['sync_detail_and_edit'] == "false")
 459                    $this->setSyncDetailEditViews( false );
 460                 else
 461                    $this->setSyncDetailEditViews( true );
 462         }
 463
 464         $GLOBALS [ 'log' ]->debug ( print_r ( $this->_viewdefs [ 'panels' ], true ) ) ;
 465
 466     }
 467
 468     /*  Convert our internal format back to the standard Canonical MetaData layout
 469      *  First non-(empty) field goes in at column 0; all other (empty)'s removed
 470      *  Studio required fields are also added to the layout.
 471      *  Do this AFTER reading in all the $_REQUEST parameters as can't guarantee the order of those, and we need to operate on complete rows
 472      */
 473     protected function _convertToCanonicalForm ( $panels , $fielddefs )
 474     {
 475         $previousViewDef = $this->getFieldsFromLayout($this->implementation->getViewdefs ());
 476         $oldDefs = $this->implementation->getViewdefs ();
 477         $currentFields = $this->getFieldsFromLayout($this->_viewdefs);
 478         foreach($fielddefs as $field => $def)
 479         {
 480                 if (self::fieldIsRequired($def) && !isset($currentFields[$field]))
 481                 {
 482                 //Use the previous viewdef if this field was on it.
 483                 if (isset($previousViewDef[$field]))
 484                 {
 485                     $def = $previousViewDef[$field];
 486                 }
 487                 //next see if the field was on the original layout.
 488                 else if (isset ($this->_originalViewDef [ $field ]))
 489                 {
 490                     $def = $this->_originalViewDef [ $field ] ;
 491                 }
 492                 //Otherwise make up a viewdef for it from field_defs
 493                 else
 494                 {
 495                     $def =  self::_trimFieldDefs( $def ) ;
 496                 }
 497                 $this->addField($def);
 498                 }
 499         }
 500
 501         foreach ( $panels as $panelID => $panel )
 502         {
 503             // remove all (empty)s
 504             foreach ( $panel as $rowID => $row )
 505             {
 506                 $startOfRow = true ;
 507                 $offset = 0 ;
 508                 foreach ( $row as $colID => $fieldname )
 509                 {
 510                     if ($fieldname == MBConstants::$EMPTY[ 'name' ])
 511                     {
 512                         // if a leading (empty) then remove (by noting that remaining fields need to be shuffled along)
 513                         if ($startOfRow)
 514                         {
 515                             $offset ++ ;
 516                         }
 517                         unset ( $row [ $colID ] ) ;
 518                     } else
 519                     {
 520                         $startOfRow = false ;
 521                     }
 522                 }
 523
 524                 // reindex to remove leading (empty)s and replace fieldnames by full definition from fielddefs
 525                 $newRow = array ( ) ;
 526                 foreach ( $row as $colID => $fieldname )
 527                 {
 528                         if ($fieldname == null)
 529                            continue;
 530
 531                     //Backwards compatibility and a safeguard against multiple calls to _convertToCanonicalForm
 532                            if(is_array($fieldname))
 533                     {
 534                         $newRow [ $colID - $offset ] = $fieldname;
 535                         continue;
 536                     }
 537
 538                         //Replace (filler) with the empty string
 539                         if ($fieldname == $this->FILLER[ 'name' ]) {
 540                         $newRow [ $colID - $offset ] = '' ;
 541                     }
 542                     //Use the previous viewdef if this field was on it.
 543                                         else if (isset($previousViewDef[$fieldname]))
 544                         {
 545                                  $newRow [ $colID - $offset ] = $previousViewDef[$fieldname];
 546                         //We should copy over the tabindex if it is set.
 547                         if (isset ($fielddefs [ $fieldname ]) && !empty($fielddefs [ $fieldname ]['tabindex']))
 548                             $newRow [ $colID - $offset ]['tabindex'] = $fielddefs [ $fieldname ]['tabindex'];
 549                         }
 550                     //next see if the field was on the original layout.
 551                     else if (isset ($this->_originalViewDef [ $fieldname ]))
 552                     {
 553                         $newRow [ $colID - $offset ] = $this->_originalViewDef [ $fieldname ] ;
 554                         //We should copy over the tabindex if it is set.
 555                         if (isset ($fielddefs [ $fieldname ]) && !empty($fielddefs [ $fieldname ]['tabindex']))
 556                             $newRow [ $colID - $offset ]['tabindex'] = $fielddefs [ $fieldname ]['tabindex'];
 557                     }
 558                         //Otherwise make up a viewdef for it from field_defs
 559                         else if (isset ($fielddefs [ $fieldname ]))
 560                         {
 561                                 $newRow [ $colID - $offset ] =  self::_trimFieldDefs( $fielddefs [ $fieldname ] ) ;
 562
 563                         }
 564                         //No additional info on this field can be found, jsut use the name;
 565                         else
 566                         {
 567                         $newRow [ $colID - $offset ] = $fieldname;
 568                         }
 569                 }
 570                 $panels [ $panelID ] [ $rowID ] = $newRow ;
 571             }
 572         }
 573
 574         return $panels ;
 575     }
 576
 577     /*
 578      * Convert from the standard MetaData format to our internal format
 579      * Replace NULL with (filler) and missing entries with (empty)
 580      */
 581     protected function _convertFromCanonicalForm ( $panels , $fielddefs )
 582     {
 583         if (empty ( $panels ))
 584             return ;
 585
 586         // Fix for a flexibility in the format of the panel sections - if only one panel, then we don't have a panel level defined,
 587                 // it goes straight into rows
 588         // See EditView2 for similar treatment
 589         if (! empty ( $panels ) && count ( $panels ) > 0)
 590         {
 591             $keys = array_keys ( $panels ) ;
 592             if (is_numeric ( $keys [ 0 ] ))
 593             {
 594                 $defaultPanel = $panels ;
 595                 unset ( $panels ) ; //blow away current value
 596                 $panels [ 'default' ] = $defaultPanel ;
 597             }
 598         }
 599
 600         $newPanels = array ( ) ;
 601
 602         // replace '' with (filler)
 603         foreach ( $panels as $panelID => $panel )
 604         {
 605             foreach ( $panel as $rowID => $row )
 606             {
 607                 $cols = 0;
 608                 foreach ( $row as $colID => $col )
 609                 {
 610                     if ( ! empty ( $col ) )
 611                     {
 612                         if ( is_string ( $col ))
 613                         {
 614                             $fieldname = $col ;
 615                         } else if (! empty ( $col [ 'name' ] ))
 616                         {
 617                             $fieldname = $col [ 'name' ] ;
 618                         }
 619                     } else
 620                     {
 621                         $fieldname = $this->FILLER['name'] ;
 622                     }
 623
 624                     $newPanels [ $panelID ] [ $rowID ] [ $cols ] = $fieldname ;
 625                     $cols++;
 626                 }
 627             }
 628         }
 629
 630         // replace missing fields with (empty)
 631         foreach ( $newPanels as $panelID => $panel )
 632         {
 633             $column = 0 ;
 634             foreach ( $panel as $rowID => $row )
 635             {
 636                 // pad between fields on a row
 637                 foreach ( $row as $colID => $col )
 638                 {
 639                     for ( $i = $column + 1 ; $i < $colID ; $i ++ )
 640                     {
 641                         $row [ $i ] = MBConstants::$EMPTY ['name'];
 642                     }
 643                     $column = $colID ;
 644                 }
 645                 // now pad out to the end of the row
 646                 if (($column + 1) < $this->getMaxColumns ())
 647                 { // last column is maxColumns-1
 648                     for ( $i = $column + 1 ; $i < $this->getMaxColumns () ; $i ++ )
 649                     {
 650                         $row [ $i ] = MBConstants::$EMPTY ['name'] ;
 651                     }
 652                 }
 653                 ksort ( $row ) ;
 654                 $newPanels [ $panelID ] [ $rowID ] = $row ;
 655             }
 656         }
 657
 658         return $newPanels ;
 659     }
 660
 661     protected function getFieldsFromLayout($viewdef) {
 662         if (isset($viewdef['panels']))
 663         {
 664                 $panels = $viewdef['panels'];
 665         } else {
 666         $panels = $viewdef[self::$variableMap [ $this->_view ] ]['panels'];
 667         }
 668
 669         $ret = array();
 670         if (is_array($panels))
 671         {
 672                 foreach ( $panels as $rows) {
 673                     foreach ($rows as $fields) {
 674                         //wireless layouts have one less level of depth
 675                         if (is_array($fields) && isset($fields['name'])) {
 676                                 $ret[$fields['name']] = $fields;
 677                                 continue;
 678                         }
 679                         if (!is_array($fields)) {
 680                                 $ret[$fields] = $fields;
 681                                 continue;
 682                         }
 683                         foreach ($fields as $field) {
 684                             if (is_array($field) && !empty($field['name']))
 685                             {
 686                                 $ret[$field['name']] = $field;
 687                             }
 688                             else if(!is_array($field)){
 689                             $ret[$field] = $field;
 690                         }
 691                         }
 692                     }
 693                 }
 694         }
 695         return $ret;
 696     }
 697
 698     protected function fieldIsRequired($def)
 699     {
 700         if (isset($def['studio']))
 701         {
 702                 if (is_array($def['studio']))
 703                 {
 704                         if (!empty($def['studio'][$this->_view]) && $def['studio'][$this->_view] == "required")
 705                         {
 706                                 return true;
 707     }
 708                         else if (!empty($def['studio']['required']) && $def['studio']['required'] == true)
 709                         {
 710                                 return true;
 711                         }
 712                 }
 713                 else if ($def['studio'] == "required" ){
 714                   return true;
 715                 }
 716     }
 717         return false;
 718     }
 719
 720     static function _trimFieldDefs ( $def )
 721         {
 722                 $ret = array_intersect_key ( $def ,
 723             array ( 'studio' => true , 'name' => true , 'label' => true , 'displayParams' => true , 'comment' => true ,
 724                     'customCode' => true , 'customLabel' => true , 'tabIndex' => true , 'hideLabel' => true) ) ;
 725         if (!empty($def['vname']) && empty($def['label']))
 726             $ret['label'] = $def['vname'];
 727                 return $ret;
 728         }
 729
 730         public function getUseTabs(){
 731         if (isset($this->_viewdefs  [ 'templateMeta' ]['useTabs']))
 732            return $this->_viewdefs  [ 'templateMeta' ]['useTabs'];
 733
 734         return false;
 735     }
 736
 737     public function setUseTabs($useTabs){
 738         $this->_viewdefs  [ 'templateMeta' ]['useTabs'] = $useTabs;
 739     }
 740
 741     /**
 742      * Return whether the Detail & EditView should be in sync.
 743      */
 744         public function getSyncDetailEditViews(){
 745         if (isset($this->_viewdefs  [ 'templateMeta' ]['syncDetailEditViews']))
 746            return $this->_viewdefs  [ 'templateMeta' ]['syncDetailEditViews'];
 747
 748         return false;
 749     }
 750
 751     /**
 752      * Sync DetailView & EditView. This should only be set on the EditView
 753      * @param bool $syncViews
 754      */
 755     public function setSyncDetailEditViews($syncDetailEditViews){
 756         $this->_viewdefs  [ 'templateMeta' ]['syncDetailEditViews'] = $syncDetailEditViews;
 757     }
 758
 759     /**
 760      * Getter function to get the implementation method which is a private variable
 761      * @return DeployedMetaDataImplementation
 762      */
 763     public function getImplementation(){
 764         return $this->implementation;
 765     }
 766
 767     /**
 768      * Public access to _convertFromCanonicalForm
 769      * @param  $panels
 770      * @param  $fielddefs
 771      * @return array
 772      */
 773     public function convertFromCanonicalForm ( $panels , $fielddefs )
 774     {
 775         return $this->_convertFromCanonicalForm ( $panels , $fielddefs );
 776     }
 777
 778      /**
 779      * Public access to _convertToCanonicalForm
 780      * @param  $panels
 781      * @param  $fielddefs
 782      * @return array
 783      */
 784     public function convertToCanonicalForm ( $panels , $fielddefs )
 785     {
 786         return $this->_convertToCanonicalForm ( $panels , $fielddefs );
 787     }
 788
 789
 790     /**
 791      * @return Array list of fields in this module that have the calculated property
 792      */
 793     public function getCalculatedFields() {
 794         $ret = array();
 795         foreach ($this->_fielddefs as $field => $def)
 796         {
 797             if(!empty($def['calculated']) && !empty($def['formula']))
 798             {
 799                 $ret[] = $field;
 800             }
 801         }
 802
 803         return $ret;
 804     }
 805 }
 806
 807 ?>