Prechádzať zdrojové kódy

Merge pull request #3626 from idchlife/master

Removed associated_tostring, added 2 string types and wrote more info about `code` option
Oskar Stark 9 rokov pred
rodič
commit
400edc6e13
1 zmenil súbory, kde vykonal 12 pridanie a 9 odobranie
  1. 12 9
      Resources/doc/reference/action_list.rst

+ 12 - 9
Resources/doc/reference/action_list.rst

@@ -41,7 +41,7 @@ Customizing the fields displayed on the list page
 -------------------------------------------------
 
 You can customize the columns displayed on the list through the ``configureListFields`` method.
-Here is an example from Sonata E-Commerce Product Admin:
+Here is an example:
 
 .. code-block:: php
 
@@ -71,13 +71,10 @@ Here is an example from Sonata E-Commerce Product Admin:
                 'currency' => $this->currencyDetector->getCurrency()->getLabel()
             ))
 
-            // here we specify which method is used to render the label
+            // Here we specify which property is used to render the label of each entity in the list
             ->add('productCategories', null, array(
-                'associated_tostring' => 'getCategory'
-            ))
-            ->add('productCollections', null, array(
-                'associated_tostring' => 'getCollection'
-            ))
+                'associated_property' => 'name')
+            )
 
             // you may also use dotted-notation to access
             // specific properties of a relation to the entity
@@ -107,8 +104,10 @@ Options
 - ``template`` (o): the template used to render the field
 - ``label`` (o): the name used for the column's title
 - ``link_parameters`` (o): add link parameter to the related Admin class when the ``Admin::generateUrl`` is called
-- ``code`` (o): the method name to retrieve the related value
-- ``associated_tostring`` (o): (deprecated, use associated_property option) the method to retrieve the "string" representation of the collection element.
+- ``code`` (o): the method name to retrieve the related value (for example,
+  if you have an `array` type field, you would like to show info prettier
+  than `[0] => 'Value'`; useful when simple getter is not enough).
+  Notice: works with string-like types (string, text, html)
 - ``associated_property`` (o): property path to retrieve the "string" representation of the collection element, or a closure with the element as argument and return a string.
 - ``identifier`` (o): if set to true a link appears on the value to edit the element
 
@@ -152,6 +151,10 @@ Available types and associated options
 +-----------+----------------+-----------------------------------------------------------------------+
 | string    |                | Renders a simple string.                                              |
 +-----------+----------------+-----------------------------------------------------------------------+
+| text      |                | See 'string'                                                          |
++-----------+----------------+-----------------------------------------------------------------------+
+| html      |                | Renders string as html                                                |
++-----------+----------------+-----------------------------------------------------------------------+
 | time      |                | Renders a datetime's time with format ``H:i:s``.                      |
 +-----------+----------------+-----------------------------------------------------------------------+
 | trans     | catalogue      | Translates the value with catalogue ``catalogue`` if defined.         |