Explorar el Código

[docs] updated sluggable documentation and README

gediminasm hace 13 años
padre
commit
b5562bf873
Se han modificado 2 ficheros con 10 adiciones y 22 borrados
  1. 8 19
      README.markdown
  2. 2 3
      doc/annotations.md

+ 8 - 19
README.markdown

@@ -34,6 +34,13 @@ So root node now looks like this:
 
 ### Latest updates
 
+**2011-08-08**
+
+- Sluggable listener now has extension points to extend the default behavior of sluggable. 
+By default there is TreeSlug, RelativeSlug handlers. Which can build a tree path like slug
+example: **category/shoes/nike**. Using relative slug handler it is possible to have related slug
+for example, user is related to company by ManyToOne relation in result slug is: **company/user-name**
+
 **2011-07-14**
 
 - Sluggable can handle multiple slug fields, now on Sluggable annotation you will need
@@ -41,20 +48,6 @@ to provide slugField property it should belong to
 - Translatable query hint will use **default locale** translations in case if it does not
 have a translation in currently used locale
 
-**2011-06-24**
-
-- Implemented better compatibility with new and older annotation mapping style. Read
-**doc/annotations.md** on how to achieve best performances using annotation mapping and
-how to configure it.
-- The object wrappers were implemented internally in extensions to avoid issues with
-uninitialized or detached proxies.
-
-**2011-06-08**
-
-- [mvrhov](http://github.com/mvrhov) implemented the XML driver for extensions and now
-there is a full stack of drivers to make your experience even better using these extensions.
-So far I'm not sure if the same xsd will work with ODM but it will be created in comming month.
-
 ### ODM MongoDB support
 
 List of extensions which support ODM
@@ -75,11 +68,6 @@ You can test these extensions on [my blog](http://gediminasm.org/test/ "Test doc
 
 All tutorials for basic usage examples are on [my blog](http://gediminasm.org "Tutorials for extensions") also.
 
-### Recommendations
-
-- Use Symfony/Component/ClassLoader/UniversalClassLoader for autoloading these extensions, it will help
-to avoid triggering fatal error during the check of **class_exists**
-
 ### Running the tests:
 
 PHPUnit 3.5 or newer is required.
@@ -92,6 +80,7 @@ To setup and run tests follow these steps:
 
 ### Contributors:
 
+- Daniel Gomes [danielcsgomes](http://github.com/danielcsgomes)
 - megabite [oscarballadares](http://github.com/oscarballadares)
 - DinoWeb [dinoweb](http://github.com/dinoweb)
 - Miha Vrhovnik [mvrhov](http://github.com/mvrhov)

+ 2 - 3
doc/annotations.md

@@ -334,8 +334,7 @@ with TreeSlugHandler
     /**
      * @Gedmo\Mapping\Annotation\Slug(handlers={
      *      @Gedmo\Mapping\Annotation\SlugHandler(class="Gedmo\Sluggable\Handler\TreeSlugHandler", options={
-     *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="parentRelation", value="parent"),
-     *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="targetField", value="title"),
+     *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="parentRelationField", value="parent"),
      *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="separator", value="/")
      *      })
      * }, separator="-", updatable=true)
@@ -351,7 +350,7 @@ with **RelativeSlugHandler**:
      * @Gedmo\Mapping\Annotation\Slug(handlers={
      *      @Gedmo\Mapping\Annotation\SlugHandler(class="Gedmo\Sluggable\Handler\RelativeSlugHandler", options={
      *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="relationField", value="category"),
-     *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="relativeSlugField", value="slug"),
+     *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="relationSlugField", value="slug"),
      *          @Gedmo\Mapping\Annotation\SlugHandlerOption(name="separator", value="/")
      *      })
      * })