Sfoglia il codice sorgente

Merge pull request #115 from adrienbrault/handler-doc

Document the SubscribingHandlerInterface a bit
Johannes 12 anni fa
parent
commit
30422b6296
1 ha cambiato i file con 13 aggiunte e 0 eliminazioni
  1. 13 0
      src/JMS/Serializer/Handler/SubscribingHandlerInterface.php

+ 13 - 0
src/JMS/Serializer/Handler/SubscribingHandlerInterface.php

@@ -21,6 +21,19 @@ namespace JMS\Serializer\Handler;
 interface SubscribingHandlerInterface
 {
     /**
+     * Return format:
+     *
+     *      array(
+     *          array(
+     *              'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
+     *              'format' => 'json',
+     *              'type' => 'DateTime',
+     *              'method' => 'serializeDateTimeToJson',
+     *          ),
+     *      )
+     *
+     * The direction and method keys can be omitted.
+     *
      * @return array
      */
     public static function getSubscribingMethods();