Skip to content

Commit

Permalink
remove blog references, closes doctrine-extensions#1244
Browse files Browse the repository at this point in the history
  • Loading branch information
l3pp4rd committed Feb 10, 2015
1 parent acbf585 commit 61a13a7
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 67 deletions.
4 changes: 0 additions & 4 deletions README.md
Expand Up @@ -94,10 +94,6 @@ List of extensions which support ODM
All these extensions can be nested together and mapped in traditional ways - annotations,
xml or yaml

You can test these extensions on [my blog](http://gediminasm.org/demo "Test doctrine behavioral extensions").
All tutorials for basic usage examples are on [my blog](http://gediminasm.org "Tutorials for extensions") too.
You can also fork or clone this blog from [github repository](https://github.com/l3pp4rd/gediminasm.org)

### Running the tests:

PHPUnit 3.6 or newer is required. **pdo-sqlite** extension is necessary.
Expand Down
10 changes: 4 additions & 6 deletions doc/annotations.md
Expand Up @@ -4,8 +4,6 @@ Bellow you will find all annotation descriptions used in these extensions.
There will be introduction on usage with examples. For more detailed usage
on extensions, refer to their specific documentation.

[blog_reference]: http://gediminasm.org/article/annotation-reference-for-extensions "Doctrine2 extensions annotation reference and examples"

Content:

- Best [practices](#em-setup) for setting up
Expand Down Expand Up @@ -39,13 +37,13 @@ class Article
* @ORM\Column(length=32, unique=true)
*/
private $id;

/**
* @Gedmo\Translatable
* @ORM\Column(length=64)
*/
private $title;

/**
* @Gedmo\Timestampable(on="create")
* @ORM\Column(type="datetime")
Expand Down Expand Up @@ -171,7 +169,7 @@ to doctrine-common-2.1.x branch and newer.
## Tree annotations

Tree can use different adapters. Currently **Tree** extension supports **NestedSet**
and **Closure** strategies which has a difference for annotations used. Note, that
and **Closure** strategies which has a difference for annotations used. Note, that
tree will automatically map indexes which are considered necessary for best performance.

### @Gedmo\Mapping\Annotation\Tree (required for all tree strategies)
Expand Down Expand Up @@ -355,7 +353,7 @@ example:
*/
private $content;
```

### @Gedmo\Mapping\Annotation\Locale or @Gedmo\Mapping\Annotation\Language (optional)

**unmapped property** annotation
Expand Down
16 changes: 3 additions & 13 deletions doc/loggable.md
Expand Up @@ -2,7 +2,7 @@

**Loggable** behavior tracks your record changes and is able to
manage versions.

Features:

- Automatic storage of log entries in database
Expand All @@ -11,21 +11,11 @@ Features:
- Objects can be reverted to previous versions
- Annotation, Yaml and Xml mapping support for extensions

[blog_reference]: http://gediminasm.org/article/loggable-behavioral-extension-for-doctrine2 "Loggable extension for Doctrine2 tracks record changes and version management"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

Update **2011-04-04**

- Made single listener, one instance can be used for any object manager
and any number of them


**Note:**

- You can [test live][blog_test] on this blog
- Public [Loggable repository](http://github.com/l3pp4rd/DoctrineExtensions "Loggable extension on Github") is available on github
- Last update date: **2012-01-02**

**Portability:**

- **Loggable** is now available as [Bundle](http://github.com/stof/StofDoctrineExtensionsBundle)
Expand All @@ -35,7 +25,7 @@ This article will cover the basic installation and functionality of **Loggable**
behavior

Content:

- [Including](#including-extension) the extension
- Entity [example](#entity-mapping)
- Document [example](#document-mapping)
Expand All @@ -53,7 +43,7 @@ on how to setup and use the extensions in most optimized way.

### Loggable annotations:

- **@Gedmo\Mapping\Annotation\Loggable(logEntryClass="my\class")** this class annotation
- **@Gedmo\Mapping\Annotation\Loggable(logEntryClass="my\class")** this class annotation
will store logs to optionally specified **logEntryClass**. You will still need to specify versioned fields with the following annotation.
- **@Gedmo\Mapping\Annotation\Versioned** tracks annotated property for changes

Expand Down
7 changes: 2 additions & 5 deletions doc/mapping.md
Expand Up @@ -11,16 +11,13 @@ Features:
- Mapping drivers for annotation and yaml
- Conventional extension points for metadata extraction and object manager abstraction

[blog_reference]: http://gediminasm.org/article/mapping-extension-for-doctrine2 "Mapping extension for Doctrine2 makes it easy to create extensions based on annotation, xml, yaml mapping drivers"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

- Public [Mapping repository](http://github.com/l3pp4rd/DoctrineExtensions "Mapping extension on Github") is available on github
- Last update date: **2012-01-02**

This article will cover the basic installation and usage of **Mapping** extension

Content:

- [Including](#including-extension) the extension
- [Creating](#create-extension) an extension
- Defining [annotations](#annotations)
Expand Down Expand Up @@ -483,7 +480,7 @@ class ODM extends BaseAdapterODM
{
public function someSpecificMethod()
{

}
}
```
Expand Down
7 changes: 2 additions & 5 deletions doc/sortable.md
Expand Up @@ -10,9 +10,6 @@ Features:
- Can be nested with other behaviors
- Annotation, Yaml and Xml mapping support for extensions

[blog_reference]: http://gediminasm.org/article/sortable-behavior-extension-for-doctrine2 "Sortable extension will enable ordering on any entity or its relation"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

**Note:**

- Public [Sortable repository](http://github.com/l3pp4rd/DoctrineExtensions "Sortable extension on Github") is available on github
Expand Down Expand Up @@ -116,12 +113,12 @@ class Item
{
return $this->position;
}

public function setCategory($category)
{
$this->category = $category;
}

public function getCategory()
{
return $this->category;
Expand Down
19 changes: 8 additions & 11 deletions doc/symfony2.md
Expand Up @@ -5,15 +5,12 @@ This post will show you - how to create a simple configuration file to manage ex
ability to use all features it provides.
Interested? then bear with me! and don't be afraid, we're not diving into security component :)

[blog_reference]: http://gediminasm.org/article/mapping-extension-for-doctrine2 "Mapping extension for Doctrine2 makes it easy to create extensions based on annotation, xml, yaml mapping drivers"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

This post will put some light over the shed of extension installation and mapping configuration
of Doctrine2. It does not require any additional dependencies and gives you full power
over management of extensions.

Content:

- [Symfony2](#sf2-app) application
- Extensions metadata [mapping](#ext-mapping)
- Extension [listeners](#ext-listeners)
Expand Down Expand Up @@ -79,7 +76,7 @@ doctrine:
orm:
auto_generate_proxy_classes: %kernel.debug%
auto_mapping: true
# only these lines are added additionally
# only these lines are added additionally
mappings:
translatable:
type: annotation
Expand Down Expand Up @@ -131,7 +128,7 @@ everything extensions provide:
orm:
auto_generate_proxy_classes: %kernel.debug%
auto_mapping: true
# only these lines are added additionally
# only these lines are added additionally
mappings:
translatable:
type: annotation
Expand Down Expand Up @@ -182,7 +179,7 @@ services:
- { name: doctrine.event_subscriber, connection: default }
calls:
- [ setAnnotationReader, [ @annotation_reader ] ]

gedmo.listener.translatable:
class: Gedmo\Translatable\TranslatableListener
tags:
Expand All @@ -191,28 +188,28 @@ services:
- [ setAnnotationReader, [ @annotation_reader ] ]
- [ setDefaultLocale, [ %locale% ] ]
- [ setTranslationFallback, [ false ] ]

gedmo.listener.timestampable:
class: Gedmo\Timestampable\TimestampableListener
tags:
- { name: doctrine.event_subscriber, connection: default }
calls:
- [ setAnnotationReader, [ @annotation_reader ] ]

gedmo.listener.sluggable:
class: Gedmo\Sluggable\SluggableListener
tags:
- { name: doctrine.event_subscriber, connection: default }
calls:
- [ setAnnotationReader, [ @annotation_reader ] ]

gedmo.listener.sortable:
class: Gedmo\Sortable\SortableListener
tags:
- { name: doctrine.event_subscriber, connection: default }
calls:
- [ setAnnotationReader, [ @annotation_reader ] ]

gedmo.listener.loggable:
class: Gedmo\Loggable\LoggableListener
tags:
Expand Down
18 changes: 6 additions & 12 deletions doc/timestampable.md
@@ -1,21 +1,18 @@
# Timestampable behavior extension for Doctrine 2

**Timestampable** behavior will automate the update of date fields
on your Entities or Documents. It works through annotations and can update
on your Entities or Documents. It works through annotations and can update
fields on creation, update, property subset update, or even on specific property value change.

Features:

- Automatic predefined date field update on creation, update, property subset update, and even on record property changes
- ORM and ODM support using same listener
- Specific annotations for properties, and no interface required
- Can react to specific property or relation changes to specific value
- Can be nested with other behaviors
- Can react to specific property or relation changes to specific value
- Can be nested with other behaviors
- Annotation, Yaml and Xml mapping support for extensions

[blog_reference]: http://gediminasm.org/article/timestampable-behavior-extension-for-doctrine-2 "Timestampable extension for Doctrine 2 helps automate update of dates"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

Update **2012-06-26**

- Allow multiple values for on="change"
Expand All @@ -25,14 +22,11 @@ Update **2012-03-10**
- Add [Timestampable traits](#traits)

Update **2011-04-04**

- Made single listener, one instance can be used for any object manager
and any number of them

**Note:**

- You can [test live][blog_test] on this blog
- Public [Timestampable repository](http://github.com/l3pp4rd/DoctrineExtensions "Timestampable extension on Github") is available on github
- Last update date: **2012-01-02**

**Portability:**
Expand Down Expand Up @@ -71,7 +65,7 @@ type it will trigger an exception.

Available configuration options:

- **on** - is main option and can be **create, update, change** this tells when it
- **on** - is main option and can be **create, update, change** this tells when it
should be updated
- **field** - only valid if **on="change"** is specified, tracks property or a list of properties for changes
- **value** - only valid if **on="change"** is specified and the tracked field is a single field (not an array), if the tracked field has this **value**
Expand Down Expand Up @@ -596,7 +590,7 @@ Now in Symfony2, we register and override the **datetime** type. **WARNING:** th
```
doctrine:
dbal:
types:
types:
datetime: Acme\DoctrineExtensions\DBAL\Types\UTCDateTimeType
```

Expand Down
4 changes: 0 additions & 4 deletions doc/translatable.md
Expand Up @@ -14,9 +14,6 @@ Features:
- Can be nested with other behaviors
- Annotation, Yaml and Xml mapping support for extensions

[blog_reference]: http://gediminasm.org/article/translatable-behavior-extension-for-doctrine-2 "Translatable extension for Doctrine 2 makes automatic record field translations and their loading depending on language used"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

**2012-01-28**

- Created personal translation which maps through real foreign key
Expand Down Expand Up @@ -57,7 +54,6 @@ and any number of them

**Note list:**

- You can [test live][blog_test] on this blog
- Public [Translatable repository](http://github.com/l3pp4rd/DoctrineExtensions "Translatable extension on Github") is available on github
- Using other extensions on the same Entity fields may result in unexpected way
- May impact your application performance since it does an additional query for translation if loaded without query hint
Expand Down
4 changes: 0 additions & 4 deletions doc/tree.md
Expand Up @@ -16,9 +16,6 @@ Features:
- Can be nested with other extensions
- Annotation, Yaml and Xml mapping support for extensions

[blog_reference]: http://gediminasm.org/article/tree-nestedset-behavior-extension-for-doctrine-2 "Tree - Nestedset or Closure extension for Doctrine 2 makes tree implementation on entities"
[blog_test]: http://gediminasm.org/test "Test extensions on this blog"

Thanks for contributions to:

- **[comfortablynumb](http://github.com/comfortablynumb) Gustavo Falco** for Closure and Materialized Path strategy
Expand Down Expand Up @@ -58,7 +55,6 @@ Update **2011-02-02**

**Note:**

- You can [test live][blog_test] on this blog
- After using a NestedTreeRepository functions: **verify, recover, removeFromTree** it is recommended to clear EntityManager cache
because nodes may have changed values in database but not in memory. Flushing dirty nodes can lead to unexpected behaviour.
- Closure tree implementation is experimental and not fully functional, so far not documented either
Expand Down
6 changes: 3 additions & 3 deletions doc/zendframework2.md
Expand Up @@ -17,9 +17,9 @@ Add DoctrineModule, DoctrineORMModule and DoctrineExtensions to composer.json fi
}
}
```

Then run `composer.phar update`.

### Configuration

Once libraries are installed, you can tell Doctrine which behaviors you want to use, by declaring appropriate subscribers in Event Manager settings. Together with [entity mapping options](https://github.com/doctrine/DoctrineORMModule#entities-settings), your module configuration file should look like following:
Expand All @@ -30,7 +30,7 @@ return array(
'eventmanager' => array(
'orm_default' => array(
'subscribers' => array(

// pick any listeners you need
'Gedmo\Tree\TreeListener',
'Gedmo\Timestampable\TimestampableListener',
Expand Down

0 comments on commit 61a13a7

Please sign in to comment.