tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 12:05:37 +00:00
Code Issues Projects Releases Wiki Activity

MINOR Documentation

Browse Source
This commit is contained in:
Ingo Schommer 2012-02-27 18:26:11 +01:00
parent e95a2cf40c
commit cbfd76dd36
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
forms/gridfield/GridFieldAction.php
View File

@ -1,7 +1,10 @@
<?php <?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 { class GridFieldAction_Edit implements GridField_ColumnProvider {

7
forms/gridfield/GridFieldPopupForms.php
View File

@ -1,7 +1,10 @@
<?php <?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: * The URLs provided will be off the following form:
* - <FormURL>/field/<GridFieldName>/item/<RecordID> * - <FormURL>/field/<GridFieldName>/item/<RecordID>
@ -193,7 +196,7 @@ class GridFieldPopupForm_ItemRequest extends RequestHandler {
* Builds an item edit form. The arguments to getCMSFields() are the popupController and * Builds an item edit form. The arguments to getCMSFields() are the popupController and
* popupFormName, however this is an experimental API and may change. * 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 * 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. * of letting Security/login put its log-in form inside a UI specified elsewhere.
* *