Changeset 10079

Timestamp:

07/03/08 03:24:38 (2 years ago)

Author:

Leon.van.der.Ree

Message:

MAJOR REWRITE FOR GENERATOR CODE
rewritten lots of methods and removed some hacks
fixes for (foreign-key)PHP-names and custom-method-PHP-names
changed code for getI18NString-method
NEW CAPABILITY to handle multiple ForeignKeys? to a same table

Files:

• plugins/sfExtjsThemePlugin/data/generator/sfPropelAdmin/extjs/template/templates/_json_td_edit.php (modified) (2 diffs)
• plugins/sfExtjsThemePlugin/data/generator/sfPropelAdmin/extjs/template/templates/_json_td_list.php (modified) (3 diffs)
• plugins/sfExtjsThemePlugin/lib/sfAdminCustomGenerator.php (modified) (18 diffs)
• plugins/sfExtjsThemePlugin/lib/sfExtjsPropelAdminGenerator.php (modified) (18 diffs)

plugins/sfExtjsThemePlugin/data/generator/sfPropelAdmin/extjs/template/templates/_json_td_edit.php

@@ -2 +2 @@
-{
-<?php
-
+(don't know it it is wanted though, since we can now use hides to hide fields which can be made visible from the column-header-menu)
-  $hs = $this->getParameterValue('edit.hide', array());
-
@@ -44 +44 @@
-  }
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
+
-  $hs[] = $columnName;
-

plugins/sfExtjsThemePlugin/data/generator/sfPropelAdmin/extjs/template/templates/_json_td_list.php

@@ -2 +2 @@
-{
-<?php
-, only set, never checked!
+... only set, never checked!!!(don't know it it is wanted though, since we can now use hides to hide fields which can be made visible from the column-header-menu)
-$hs = $this->getParameterValue('list.hide', array());
-
@@ -15 +15 @@
-foreach ($columns as $columnName => $column) :
-  if ($column->key == '*') continue;
-  $columnName = $column->key;
-
-Name
+->key
-?>
-<?php if ($credentials): $credentials = str_replace("\n", ' ', var_export($credentials, true)) ?>
@@ -29 +28 @@
-  }
-
-  // This 'fix' will require you to have your partials be non-foreign, which actually is bad.
-  if ( (!$column->isPartial()) && (!$column->isComponent()) )
-  {
-    // TODO: this is a hack! this should be fixed by letting getColumnAjaxTag take the relative $columnName into account, something like $this->getColumnAjaxTag($column, $checkName or $columnName)
-    // Due to this hack the column looses all info (like type, length, etc and keys (like isPartial, isLink, isComponent )
-    $column = $this->getAdminColumnForField($columnName);
-  }
-
-  // unfortunately we cannot use the '/' to distinquish the class and the field, because the name is used as variable in _list_ajax_layout.php
-Ajax
+List
-
-  //don't add it twice

plugins/sfExtjsThemePlugin/lib/sfAdminCustomGenerator.php

@@ -10 +10 @@
- *   filter_header_map: {client_name: client_id}
- *   batch_actions:
-   
- 
+
+
- */
-class sfAdminCustomGenerator extends sfExtjsPropelCrudGenerator
@@ -54 +54 @@
-    elseif ($type == CreoleTypes::FLOAT || $type == CreoleTypes::DOUBLE || $type == CreoleTypes::DECIMAL || $type == CreoleTypes::NUMERIC || $type == CreoleTypes::REAL )
-    {
- 
- 
- 
- } 
-
-
+  
+  
+  
+  }
+
+
-    // user sets a specific tag to use
-    if ($inputType = $this->getParameterValue('edit.fields.'.$column->getName().'.type'))
@@ -76 +76 @@
-    return parent::getCrudColumnEditTag($column, $params);
-  }
-
-
-
-
-
-
+
+
+
-   *
-
-
-
-
+
+
+
+
+
+
+
-    $options = isset($params['params']) ? sfToolkit::stringToArray($params['params']) : array();
-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
- 
-
- 
-
- 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-
@@ -115 +115 @@
-    return $this->getColumnHelper(parent::getColumnListTag($column, $params), $column, $params);
-  }
-
+
-  /**
-   * Checks and adds helper for column values
@@ -135 +135 @@
-        $helperparams = ', array('.$valuepairs.')';
-      }
-
+
-      return $helper.'('.$value.$helperparams.')';
-    }
@@ -143 +143 @@
-    }
-  }
-
+
-
-  /**
@@ -152 +152 @@
-  public function getColumnFilterColumn($column)
-  {
- 
+  
-    $filtercolumn  = $column->getName();
-
@@ -162 +162 @@
-    }
-
- 
+
-    if ($filters = $this->getParameterValue('list.filters') and in_array($filtercolumn, $filters)!=false)
-    {
-      // Return the connected admin field
-      list($field, $flags) = $this->splitFlag($filtercolumn);
-$flags);
- 
-
-
+null, $flags); //OBSOLETE ARGUMENNTS
+
+
+
-  /**
-   * Implements custom filtertypes
@@ -180 +180 @@
-    $user_params = is_array($user_params) ? $user_params : sfToolkit::stringToArray($user_params);
-    $params      = $user_params ? array_merge($params, $user_params) : $params;
-
+
-    // Check for / in field name
-    if (strpos($column->getName(),'::')!==false)
-    {
- 
+  
-    }
-
-    // user sets a specific tag to use
- 
+
-      !$column->isComponent() and
-      !$column->isPartial()
@@ -196 +196 @@
-      $unquotedName = 'filters['.$column->getName().']';
-      $name = "'$unquotedName'";
-
+
-      $size = ($column->getSize() < 15 ? $column->getSize() : 15);
-      $params = $this->getObjectTagParams($params, array('size' => $size));
@@ -203 +203 @@
-    }
-    // many-to-many, indicated by the presence of param through_class
- 
+
-    {
-      $options1 = "_get_options_from_objects(sfPropelManyToMany::getAllObjects(new " . $this->getClassName(). ", '" . $params['through_class'] . "', NULL, '" . ($params['peer_method'] ? $params['peer_method'] : 'doSelect') . "')";
@@ -220 +220 @@
-   * @param object column $column
-   * @param boolean $developed (optional) writes out function with current class
- 
+
-   */
-  function getColumnGetter($column, $developed = false, $prefix = '')
@@ -235 +235 @@
-    }
-  }
-
+
-  /**
-   * Build function to set column value
-   * @param object column $column
-   * @param boolean $developed (optional) writes out function with current class
- 
+
-   */
-  function getColumnSetter($column, $developed = false, $prefix = '')
@@ -255 +255 @@
-    }
-  }
-
+
-  function getColumnConstant($column)
-  {
@@ -266 +266 @@
-      if ($nameParts[$namePartsCount]=='')
-        sfContext::getInstance()->getLogger()->error('Can not use __toString method with '.$name.' In getColumnConstant');
-
+
-      return $nameParts[$namePartsCount-1].'Peer::'.strtoupper($nameParts[$namePartsCount]);
-    }
-    else
-    {
- 
+  
-    }
-  }
@@ -281 +281 @@
-   * If fieldname is empty after the /, the __toString method is called.
-   * Produces a string like:
- 
+
-   * @param string $phpName column name to process
-   * @param string $method (optional) function prefix
-   */
-
+=''
-  {
-    // Detect if there is / or :: indicating foreign model peer class
@@ -292 +292 @@
-      list($peer, $PhpName) = explode('::', $PhpName,2);
-      $PhpNameExploded = explode('::', $PhpName);
-
- 
+
+
-      if ($PhpName == '')
-      {
@@ -322 +322 @@
-    }
-  }
-
+
-// For debugging purposes only
-//  public function getColumns($paramName, $category = 'NONE')

plugins/sfExtjsThemePlugin/lib/sfExtjsPropelAdminGenerator.php

@@ -69 +69 @@
-    // find %%xx%% strings
-    preg_match_all('/%%([^%]+)%%/', $value, $matches, PREG_PATTERN_ORDER);
-this->params['tmp']['display']
+fields
-    foreach ($matches[1] as $name)
-    {
-this->params['tmp']['display']
+fields
-    }
-
-    $i = 0;
-    $vars = array();
-
-
+
+
+
+
+
+
-      if ($column->isLink())
-      {
@@ -517 +521 @@
-
-    //check if primary key has been defined, else set it
+    //WE DON'T HANDLE MULTIPLE PRIMARY KEYS!
-    if (!isset($groupedColumns['pk']) || ($groupedColumns['pk'] == array()) || ($groupedColumns['pk'] == null))
-    {
@@ -535 +540 @@
-    foreach ($columnNames as $columnName)
-    {
+      // get its group (for fieldsets)
-      $group = 'NONE';
-      if (false !== strpos($columnName, '\\'))
@@ -541 +547 @@
-      }
-
+      //get flags (should make no difference if you placed flags in front, or in between (for foreign-fields)
-      list($columnName, $flags) = $this->splitFlag($columnName);
-
-
-
-
+
-      if (false !== strpos($columnName, '/'))
-      {
-
-
-
-
-
+
-
-        // Add invisible foreign-key
-
-
-
+
+
+
+
+
+
+
-        //add an option to show this field should be visible
-
-
-
+
+
+
+
-
-        // check if related groupedColumn hierarchy is already defined, if not define it.
@@ -570 +576 @@
-        }
-
- //TODO: don't know if this is desired! if so, why?
+, so they can be propogated to end-field
-        $flagPrefix = '';
-        foreach ($flags as $flag)
@@ -579 +585 @@
-        /*
-         * add foreign column recursively (so it can for instance handle productgroup/product/name and beyond)
+         *
+         * provide:
+         *  - stripped fieldname (propogated group and flags)
+         *  - relative peername
+         *  - stepped in hierarchy (related)
+         *  - increased counter for display-order
-         */
-        $groupedColumns['related'][$foreignKey] = $this->setupGroupedColumns($group.'\\'.$flagPrefix.$relatedColumnName, $relatedPeerName, $related, $i++);  //$relatedTableName
-
-      }
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        // else you cannot see a column multiple times in your grid (if someone happened to want that)
-        $column->visible = true;
-        //add an option to show this field should be visible
-        $column->key = $columnUnderscore;
-        $column->index = $i++;
-        $groupedColumns['columns'][$group][] = $column;
-      }
-
-
+ // process next column
-
-    return $groupedColumns;
@@ -802 +820 @@
-      $column = $groupedColumns['pk'];
-      $column->key = $prefix.$pkName;
+
+      $phpName = $this->getPhpNameForField($column->key);
+      $column->setPhpName($phpName);
+
-      $columnList[] = $column;
-    }
@@ -815 +837 @@
-      foreach ($columnsFromGroup as $columnName => $column)
-      {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-          $columnList[] = $newColumn;
-        }
@@ -957 +981 @@
-   * @return string HTML code
-   */
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    $type = $column->getCreoleType();
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-
@@ -1381 +1456 @@
-  }
-
-
-
-
-
-
-
-
-
-
+
+
-    $fields = explode('/', $field);
-
@@ -1397 +1465 @@
-      $lastPeerClassName = $peerName;
-    }
+
-    $phpName = "";
-
-    if ((!in_array('_', $flags)) && ($field!='*'))// no-partial or row expander
-    {
@@ -1421 +1489 @@
-          }
-
+          // if column not found, it is a partial or a customMethod
-          if (!$found)
-          {
-//            throw new sfConfigurationException(sprintf('Illegal field-name provided, you should provide:<br> [foreignkey-field(s)/]fieldname<br>&nbsp;<br>E.G. city_id/country_id/name<br>to get the country-name for the city of this module (if this module contains a foreign-key city_id to a city table<br>&nbsp<br>Stopped while parcing: "<i>%s</i>" of "%s"', $fields[$i], $field));
-            // not a "real" column, but we generate one here
-            $flagPrefix = '';
@@ -1430 +1498 @@
-              $flagPrefix .= $flag;
-            }
-f
+currentF
-
-            $tableMap = call_user_func(array($lastPeerClassName, 'getTableMap'));
-            $column = new ColumnMap($name, $tableMap);
-
-
-
-
+
+
+
-          }
-        }
-
+        // if not last field, return table getter
-        if ($i != count($fields) - 1)
-        {
@@ -1446 +1514 @@
-          $relatedTable = $this->getMap()->getDatabaseMap()->getTable($relatedTableName);
-
-
+
+
+
+
+
+
+
+
-
-          $lastPeerClassName = $relatedTable->getPhpName().'Peer';
-        }
+        //if last field return column getter
-        else
-        {
@@ -1461 +1537 @@
-    }
-
+    return $phpName;
+  }
+
+
+  /** This method overwrites the original method so it can handle foreign-field by providing a peerName
+   */
+  public function getAdminColumnForField($field, $peerName = null, $flags = array())
+  {
+    $fields = explode('/', $field);
+
+    $lastPeerClassName = $this->getPeerClassName();
+    if ($peerName)
+    {
+      $lastPeerClassName = $peerName;
+    }
+
+    $phpName = "";
+    if ((!in_array('_', $flags)) && ($field!='*'))// no-partial or row expander
+    {
+      //get PHP-name for (all) foreign tables (from foreign-key)
+      for ($i = 0; $i < count($fields); $i++)
+      {
+        $currentField = $fields[$i];
+        list($currentField, $currentFlags) = $this->splitFlag($currentField);
+
+        if (!in_array('_', $currentFlags)) // no-partial
+        {
+          $tableMap = call_user_func(array($lastPeerClassName, 'getTableMap'));
+          // search the matching column for this key
+          $found = false;
+          foreach ($tableMap->getColumns() as $column)
+          {
+            if ($column->getColumnName() == strtoupper($currentField)) // TODO not tested if strtoupper is always correct, maybe both strtoupper...
+            {
+              $found = true;
+              break;
+            }
+          }
+
+          // if column not found, it is a partial or a customMethod
+          if (!$found)
+          {
+            // not a "real" column, but we generate one here
+            $name = strtoupper($currentField);
+
+            $tableMap = call_user_func(array($lastPeerClassName, 'getTableMap'));
+            $column = new ColumnMap($name, $tableMap);
+          }
+        }
+
+        // if not last field, return table getter
+        if ($i != count($fields) - 1)
+        {
+          $relatedTableName = $column->getRelatedTableName();
+          $relatedTable = $this->getMap()->getDatabaseMap()->getTable($relatedTableName);
+
+          $lastPeerClassName = $relatedTable->getPhpName().'Peer';
+        }
+      }
+    }
+
+    $phpName = $this->getPhpNameForField($field, $peerName, $flags);
+
-    return new sfExtjsAdminColumn($phpName, $this->getColumnForPhpName($phpName, $lastPeerClassName, $field, $flags), $flags);
-  }
@@ -1468 +1607 @@
-   * returns a column phpName or null if none was found
-   */
-p
+fullP
-  {
-    //strip
-fields = explode('::', $p
-fields[count($field
+phpNames = explode('::', $fullP
+phpNames[count($phpName
-
-    if ($peerName == null)
-    {
-      $peerName = $this->getPeerClassName();
-
-
-if (count($fields)>1)
-{
-$className = $fields[count($fields) - 2]
-$peerName = $className."Peer";
+
+
+  {
+    $className = $phpNames[count($phpNames) - 2];
+  $peerName = $className."Peer"
+}
-    }
-
@@ -1587 +1726 @@
-  }
-
+  /**
+   * Determine if this column is a foreign key that refers to the
+   * same table as another foreign key column in this table.
+   */
+  // METHOD below should be used FROM COLUMN.PHP (/symfony/lib/vendor/propel-generator/classes/propel/engine/database/model/Column.php)
+  public function isMultipleFK($column)
+  {
+    // test if this column is a foreign-key
+    if ($relatedTableName = $column->getRelatedTableName()) {
+
+      //this columnName
+      $columnName = $column->getColumnName();
+
+      $parentTable = $column->getTable();
+      $otherColumns = $parentTable->getColumns();
+
+      // TODO this should be a method of the TableMap
+      foreach ($otherColumns as $otherColumn) {
+        if ($otherColumn == $column) continue; // I said otherColumns, not this column
+
+        // test if this column is the only FK to its relatedTable
+        if ($otherColumn->getRelatedTableName() == $relatedTableName) return true;
+      }
+    }
+
+    // No multiple foreign keys.
+    return false;
+  }
-}
-
@@ -1620 +1787 @@
-  }
-
+  /**
+   * return the internal column
+   *
+   * @return ColumnMap
+   */
+  public function getColumn()
+  {
+    return $this->column;
+  }
+
+  /**
+   * Sets(/changes) the phpName after construction
+   *
+   * @param string $phpName
+   */
+  public function setPhpName($phpName)
+  {
+    $this->phpName = $phpName;
+  }
-
-}