Skip to content
Newer
Older
100644 140 lines (101 sloc) 6.76 KB
a01d346 @l3pp4rd [sluggable] more tests and docs for handlers
authored
1 # Doctrine2 behavioral extensions
79695df @l3pp4rd readme update
authored
2
6afe3eb @l3pp4rd updated readme
authored
3 **Version 2.3.1-DEV**
8b4ceed @l3pp4rd [docs] updated documentation
authored
4
215d0c6 @jakzal Added TravisCI configuration (and build status in the README).
jakzal authored
5 [![Build Status](https://secure.travis-ci.org/l3pp4rd/DoctrineExtensions.png?branch=master)](http://travis-ci.org/l3pp4rd/DoctrineExtensions)
6
6afe3eb @l3pp4rd updated readme
authored
7 **Note:** tag **2.2.1** was removed, because it was published with backward incompatible changes by
31fc585 @gquemener Fixing typo
gquemener authored
8 mistake. If you have used **2.2.1** tag as a dependency version, please switch to **2.3.0** it is
9 a direct replacement of the removed tag.
6afe3eb @l3pp4rd updated readme
authored
10
c1f72b1 @l3pp4rd updated readme
authored
11 **Note:** Use 2.1.x or 2.2.x tag in order to use extensions based on Doctrine2.x.x component versions. Currently
12 master branch is based on 2.3.x versions and may not work with older components.
13
ab2fe66 @l3pp4rd updated readme and added upgrade guide
authored
14 ### Latest updates
15
c68bb50 @l3pp4rd update readme
authored
16 **2012-03-04**
17
f4b50b0 @l3pp4rd update readme
authored
18 - We should be very grateful for contributions of [comfortablynumb](http://github.com/comfortablynumb)
19 He has contributed most to these extensions and recently - long waited [softdeleteable
c68bb50 @l3pp4rd update readme
authored
20 behavior](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/softdeleteable.md) for **ORM** users. Also most important, there
21 was a tree extension missing for **ODM** now everyone can enjoy [materialized path tree strategy](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/tree.md#materialized-path) for **ORM** including.
22
f693cf4 @l3pp4rd [sluggable] cleanup after handler removal
authored
23 **2012-02-26**
24
25 - Removed slug handlers, this functionality brought complucations which could not be maintained.
26
0939148 @l3pp4rd [documentation] document translatable usage regarding default locale
authored
27 **2012-02-15**
28
29 - Add option to force **Translatable** store translation in default locale like any other.
772b85d @l3pp4rd fix typo in readme
authored
30 See [documentation](http://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/translatable.md#advanced-examples)
0939148 @l3pp4rd [documentation] document translatable usage regarding default locale
authored
31
ab2fe66 @l3pp4rd updated readme and added upgrade guide
authored
32 **2012-01-29**
33
34 - Translatable finally has **Personal Translations** which can relate through a real **foreign key**
35 constraint and be used as a standard doctrine collection. This allows to configure domain
36 objects anyway you prefere and still enjoy all features **Translatable** provides.
37 - There were **BC** breaks introduced in **master** branch of extensions which is
38 based on **doctrine2.3.x** version. If you are not interested in upgrading you can
39 safely checkout at **2.2.x** or **2.1.x** [tag](http://github.com/l3pp4rd/DoctrineExtensions/tags).
8c40921 @l3pp4rd [translatable] tramnslation repository is useless for personal transl…
authored
40 To upgrade your source code follow the [upgrade guide](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/upgrade/2-3-0.md)
ab2fe66 @l3pp4rd updated readme and added upgrade guide
authored
41 - Library now can map only **MappedSuperclass**es which would avoid generation of **ext_**
8c40921 @l3pp4rd [translatable] tramnslation repository is useless for personal transl…
authored
42 tables which might not be used. Also it provides [convinient methods](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/lib/Gedmo/DoctrineExtensions.php#L66)
ab2fe66 @l3pp4rd updated readme and added upgrade guide
authored
43 to hook extension metadata drivers into metadata driver chain.
772b85d @l3pp4rd fix typo in readme
authored
44 - [Example demo application](https://github.com/l3pp4rd/DoctrineExtensions/blob/master/example/em.php) has a detailed configuration provided, which
ab2fe66 @l3pp4rd updated readme and added upgrade guide
authored
45 explains and shows how extensions can or should be used with **Doctrine2** ORM. To install
46 it follow the [steps](#example-demo).
47
4931b7d @l3pp4rd [docs] updating documentation in more sensible way
authored
48 ### Summary and features
49
a01d346 @l3pp4rd [sluggable] more tests and docs for handlers
authored
50 This package contains extensions for Doctrine2 that hook into the facilities of Doctrine and
51 offer new functionality or tools to use Doctrine2 more efficently. This package contains mostly
52 used behaviors which can be easily attached to your event system of Doctrine2 and handle the
3599167 @l3pp4rd updated readme
authored
53 records being flushed in the behavioral way. List of extensions:
79695df @l3pp4rd readme update
authored
54
c68bb50 @l3pp4rd update readme
authored
55 - **Tree** - this extension automates the tree handling process and adds some tree specific functions on repository.
56 (**closure**, **nestedset** or **materialized path**)
f693cf4 @l3pp4rd [sluggable] cleanup after handler removal
authored
57 - **Translatable** - gives you a very handy solution for translating records into diferent languages. Easy to setup, easier to use.
58 - **Sluggable** - urlizes your specified fields into single unique slug
59 - **Timestampable** - updates date fields on create, update and even property change.
60 - **Loggable** - helps tracking changes and history of objects, also supports version managment.
61 - **Sortable** - makes any document or entity sortable
62 - **Translator** - explicit way to handle translations
c68bb50 @l3pp4rd update readme
authored
63 - **Softdeleteable** - allows to implicitly remove records
3649d79 @l3pp4rd repository method for finding all translations
authored
64
eb25e74 @mvrhov Xml mapping driver now uses its own namespace.
mvrhov authored
65 Currently these extensions support **Yaml**, **Annotation** and **Xml** mapping. Additional mapping drivers
3918019 @l3pp4rd updated README
authored
66 can be easily implemented using Mapping extension to handle the additional metadata mapping.
6bcddf0 @l3pp4rd yaml mapping driver support for all extensions
authored
67
3918019 @l3pp4rd updated README
authored
68 **Note:** Please note, that xml mapping needs to be in a different namespace, the declared namespace for
eb25e74 @mvrhov Xml mapping driver now uses its own namespace.
mvrhov authored
69 Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
70 So root node now looks like this:
3918019 @l3pp4rd updated README
authored
71
a01d346 @l3pp4rd [sluggable] more tests and docs for handlers
authored
72 **Note:** Use 2.1.x tag in order to use extensions based on Doctrine2.1.x versions. Currently
73 master branch is based on 2.2.x versions and may not work with 2.1.x
74
7fd7dab @mvrhov Trying to get github to format the xml
mvrhov authored
75 ```
76 <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
77 xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
78 ...
79 </doctrine-mapping>
80 ```
eb25e74 @mvrhov Xml mapping driver now uses its own namespace.
mvrhov authored
81
ca989dc @l3pp4rd [docs] updated readme
authored
82 XML mapping xsd schemas are also versioned and can be used by version suffix:
83
84 - Latest version - **http://gediminasm.org/schemas/orm/doctrine-extensions-mapping**
85 - 2.2.x version - **http://gediminasm.org/schemas/orm/doctrine-extensions-mapping-2-2**
86 - 2.1.x version - **http://gediminasm.org/schemas/orm/doctrine-extensions-mapping-2-1**
87
427ea4b @l3pp4rd [translatable] odm mongodb translation listener
authored
88 ### ODM MongoDB support
89
11a79dd updated README
Gediminas Morkevicius authored
90 List of extensions which support ODM
427ea4b @l3pp4rd [translatable] odm mongodb translation listener
authored
91
92 - Translatable
93 - Sluggable
887e37d @l3pp4rd [timestampable] odm listener implementation
authored
94 - Timestampable
f0d2efd [loggable] tests and other changes
Gediminas Morkevicius authored
95 - Loggable
e5048c6 @l3pp4rd [doc] updated readme for new extension
authored
96 - Translator
5a1ce01 @comfortablynumb [Tree] Materialized Path: Added some more documentation
comfortablynumb authored
97 - Tree (Materialized Path strategy for now)
427ea4b @l3pp4rd [translatable] odm mongodb translation listener
authored
98
3918019 @l3pp4rd updated README
authored
99 All these extensions can be nested together and mapped in traditional ways - annotations,
100 xml or yaml
3649d79 @l3pp4rd repository method for finding all translations
authored
101
8156ad5 @l3pp4rd updated readme
authored
102 You can test these extensions on [my blog](http://gediminasm.org/demo "Test doctrine behavioral extensions").
103 All tutorials for basic usage examples are on [my blog](http://gediminasm.org "Tutorials for extensions") too.
104 You can also fork or clone this blog from [github repository](https://github.com/l3pp4rd/gediminasm.org)
9d81595 @l3pp4rd readme update, added contributor names
authored
105
81edcf7 @l3pp4rd created vendor dir, updated test running config
authored
106 ### Running the tests:
107
4dd94bf @stloyd Updated tests code to use proper assertion functions and parameter order
stloyd authored
108 PHPUnit 3.6 or newer is required.
81edcf7 @l3pp4rd created vendor dir, updated test running config
authored
109 To setup and run tests follow these steps:
110
111 - go to the root directory of extensions
90d86c6 @l3pp4rd [vendors] removed submodules in order to avoid recursive cloning, add…
authored
112 - run: **php bin/vendors.php**
b830874 [tree] refactored closure tree, which is fully functional now, refere…
Gediminas Morkevicius authored
113 - run: **phpunit -c tests**
aee5b41 [docs] update tree specific changes
Gediminas Morkevicius authored
114 - optional - run mongodb in background to complete all tests
81edcf7 @l3pp4rd created vendor dir, updated test running config
authored
115
8c40921 @l3pp4rd [translatable] tramnslation repository is useless for personal transl…
authored
116 <a name="example-demo"></a>
117
48847d3 @l3pp4rd [example] created an example on initialization of entity manager with…
authored
118 ### Running the example:
119
120 To setup and run example follow these steps:
121
122 - go to the root directory of extensions
123 - run: **php bin/vendors.php** installs doctrine and required symfony libraries
124 - edit **example/em.php** and configure your database on top of the file
dae5de1 @l3pp4rd [example] improved readme on example setup
authored
125 - run: **./example/bin/console** or **php example/bin/console** for console commands
126 - run: **./example/bin/console orm:schema-tool:create** to create schema
48847d3 @l3pp4rd [example] created an example on initialization of entity manager with…
authored
127 - run: **php example/run.php** to run example
128
f0d2efd [loggable] tests and other changes
Gediminas Morkevicius authored
129 ### Contributors:
9d81595 @l3pp4rd readme update, added contributor names
authored
130
f693cf4 @l3pp4rd [sluggable] cleanup after handler removal
authored
131 Thanks to [everyone participating](http://github.com/l3pp4rd/DoctrineExtensions/contributors) in
132 the development of these great Doctrine2 extensions!
133
134 And especialy ones who create and maintain new extensions:
135
8b4ceed @l3pp4rd [docs] updated documentation
authored
136 - Lukas Botsch [lbotsch](http://github.com/lbotsch)
42325be Update of README and identation fixes
Gediminas Morkevicius authored
137 - Gustavo Adrian [comfortablynumb](http://github.com/comfortablynumb)
f0d2efd [loggable] tests and other changes
Gediminas Morkevicius authored
138 - Boussekeyt Jules [gordonslondon](http://github.com/gordonslondon)
9d81595 @l3pp4rd readme update, added contributor names
authored
139 - Kudryashov Konstantin [everzet](http://github.com/everzet)
Something went wrong with that request. Please try again.