Changeset 5995

Timestamp:

11/13/07 16:50:03 (1 year ago)

Author:

fabien

Message:

added method to sfWidgetFormSchema to manage help messages + added a way to format help messages in formatter classes

Files:

• trunk/lib/widget/sfWidgetFormSchema.class.php (modified) (5 diffs)
• trunk/lib/widget/sfWidgetFormSchemaFormatter.class.php (modified) (4 diffs)
• trunk/lib/widget/sfWidgetFormSchemaFormatterList.class.php (modified) (1 diff)
• trunk/lib/widget/sfWidgetFormSchemaFormatterTable.class.php (modified) (1 diff)

trunk/lib/widget/sfWidgetFormSchema.class.php

@@ -32 +32 @@
-    $labels         = array(),
-    $fields         = array(),
-
+
+
-
-  /**
@@ -51 +52 @@
-   * @param array An array of options
-   * @param array An array of HTML labels
+   * @param array An array of help texts
-   *
-   * @see sfWidgetForm
-   */
-
+, $helps = array()
-  {
-    if (is_array($fields))
@@ -186 +188 @@
-   *
-   * @param string The field name
-gin
+ing
-   */
-  public function setLabel($name, $value)
@@ -203 +205 @@
-  {
-    return array_key_exists($name, $this->labels) ? $this->labels[$name] : '';
+  }
+
+  /**
+   * Sets the help texts to render for each field.
+   *
+   * @param array An array of help texts
+   */
+  public function setHelps($helps)
+  {
+    $this->helps = $helps;
+  }
+
+  /**
+   * Sets the help texts.
+   *
+   * @return array An array of help texts
+   */
+  public function getHelps()
+  {
+    return $this->helps;
+  }
+
+  /**
+   * Sets a help text.
+   *
+   * @param string The field name
+   * @param string The help text
+   */
+  public function setHelp($name, $help)
+  {
+    $this->helps[$name] = $help;
+  }
+
+  /**
+   * Gets a text help by field name.
+   *
+   * @param  string The field name
+   *
+   * @return string The help text or an empty string if it is not defined
+   */
+  public function getHelp($name)
+  {
+    return array_key_exists($name, $this->helps) ? $this->helps[$name] : '';
-  }
-
@@ -309 +354 @@
-        $error = $widget instanceof sfWidgetFormSchema ? array() : $error;
-
-
+, $this->getHelp($name)
-      }
-    }

trunk/lib/widget/sfWidgetFormSchemaFormatter.class.php

@@ -10 +10 @@
-
-/**
-
+sfWidgetFormSchemaFormatter allows to format a form schema with HTML formats.
- *
- * @package    symfony
@@ -21 +21 @@
-  protected
-    $rowFormat                 = '',
+    $helpFormat                = '%help%',
-    $errorRowFormat            = '',
-    $errorListFormatInARow     = "  <ul class=\"error_list\">\n%errors%  </ul>\n",
@@ -33 +34 @@
-      '%field%'         => $field,
-      '%error%'         => $this->formatErrorsForRow($errors),
-help
+this->formatHelp($help)
-      '%hidden_fields%' => is_null($hiddenFields) ? '%hidden_fields%' : $hiddenFields,
-    ));
+  }
+
+  public function formatHelp($help)
+  {
+    if (!$help)
+    {
+      return '';
+    }
+
+    return strtr($this->getHelpFormat(), array('%help%' => $help));
-  }
-
@@ -150 +161 @@
-    return $this->decoratorFormat;
-  }
+
+  public function setHelpFormat($format)
+  {
+    $this->helpFormat = $format;
+  }
+
+  public function getHelpFormat()
+  {
+    return $this->helpFormat;
+  }
-}

trunk/lib/widget/sfWidgetFormSchemaFormatterList.class.php

@@ -22 +22 @@
-    $rowFormat       = "<li>\n  %error%%label%\n  %field%%help%\n%hidden_fields%</li>\n",
-    $errorRowFormat  = "<li>\n%errors%</li>\n",
+    $helpFormat      = '<br />%help%',
-    $decoratorFormat = "<ul>\n  %content%</ul>";
-}

trunk/lib/widget/sfWidgetFormSchemaFormatterTable.class.php

@@ -22 +22 @@
-    $rowFormat       = "<tr>\n  <th>%label%</th>\n  <td>%error%%field%%help%%hidden_fields%</td>\n</tr>\n",
-    $errorRowFormat  = "<tr><td colspan=\"2\">\n%errors%</td></tr>\n",
+    $helpFormat      = '<br />%help%',
-    $decoratorFormat = "<table>\n  %content%</table>";
-}