Permalink
Browse files

MINOR Documentation

  • Loading branch information...
1 parent e95a2cf commit cbfd76dd364d8cbab01d2cac4d07b0c6a39e7eab @chillu chillu committed Feb 27, 2012
Showing with 10 additions and 4 deletions.
  1. +5 −2 forms/gridfield/GridFieldAction.php
  2. +5 −2 forms/gridfield/GridFieldPopupForms.php
@@ -1,7 +1,10 @@
<?php
/**
- * This class is an GridField Component that add Delete action for Objects in the GridField
- *
+ * Provides the entry point to editing a single record presented by the grid.
+ * Doesn't show an edit view on its own or modifies the record, but rather relies on routing conventions
+ * established in {@link getColumnContent()}. The default routing applies to
+ * the {@link GridFieldPopupForms} component, which has to be added separately
+ * to the grid field configuration.
*/
class GridFieldAction_Edit implements GridField_ColumnProvider {
@@ -1,7 +1,10 @@
<?php
/**
- * Provides view and edit forms at GridField-specific URLs. These can be placed into pop-ups by an appropriate front-end.
+ * Provides view and edit forms at GridField-specific URLs.
+ * These can be placed into pop-ups by an appropriate front-end.
+ * Usually added to a grid field alongside of {@link GridFieldAction_Edit}
+ * which takes care of linking the individual rows to their edit view.
*
* The URLs provided will be off the following form:
* - <FormURL>/field/<GridFieldName>/item/<RecordID>
@@ -193,7 +196,7 @@ function edit($request) {
* Builds an item edit form. The arguments to getCMSFields() are the popupController and
* popupFormName, however this is an experimental API and may change.
*
- * In the future, we will probably need to come up with a tigher object representing a partially
+ * @todo In the future, we will probably need to come up with a tigher object representing a partially
* complete controller with gaps for extra functionality. This, for example, would be a better way
* of letting Security/login put its log-in form inside a UI specified elsewhere.
*

0 comments on commit cbfd76d

Please sign in to comment.