Skip to content

Commit d9c1305

Browse files
franmomuphansys
authored andcommitted
Remove references to Yaml driver
1 parent 4fc3b4d commit d9c1305

9 files changed

+10
-68
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ flushed in a behavioral way.
6161
- [**References**](/doc/references.md) - supports linking Entities in Documents and vice versa
6262
- [**ReferenceIntegrity**](/doc/reference_integrity.md) - constrains ODM MongoDB Document references
6363

64-
All extensions support **YAML**, **Annotation** and **XML** mapping. Additional mapping drivers
64+
All extensions support **Attribute**, **Annotation** and **XML** mapping. Additional mapping drivers
6565
can be easily implemented using Mapping extension to handle the additional metadata mapping.
6666

6767
### Version Compatibility

doc/annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ $annotationDriver = new Doctrine\ORM\Mapping\Driver\AnnotationDriver(
9292
$cachedAnnotationReader, // our cached annotation reader
9393
array(__DIR__.'/app/Entity') // paths to look in
9494
);
95-
// NOTE: driver for application Entity can be different, Yaml, Xml or whatever
95+
// NOTE: driver for application Entity can be different, Attribute, Xml or whatever
9696
// register annotation driver for our application Entity namespace
9797
$driverChain->addDriver($annotationDriver, 'Entity');
9898

doc/mapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Mapping extension for Doctrine2
22

33
**Mapping** extension makes it easy to map additional metadata for event listeners.
4-
It supports **Yaml**, **Xml** and **Annotation** drivers which will be chosen depending on
4+
It supports **Attribute**, **Xml** and **Annotation** drivers which will be chosen depending on
55
currently used mapping driver for your domain objects. **Mapping** extension also
66
provides abstraction layer of **EventArgs** to make it possible to use single listener
77
for different object managers like **ODM** and **ORM**.

doc/sluggable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Features:
99
- ORM and ODM support using same listener
1010
- Slugs can be unique and styled, even with prefixes and/or suffixes
1111
- Can be nested with other behaviors
12-
- Attribute, Annotation, Yaml and Xml mapping support for extensions
12+
- Attribute, Annotation and Xml mapping support for extensions
1313
- Multiple slugs, different slugs can link to same fields
1414

1515
**Note:**

doc/softdeleteable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Features:
99
- All SELECT queries will be filtered, not matter from where they are executed (Repositories, DQL SELECT queries, etc).
1010
- For now, it works only with the ORM
1111
- Can be nested with other behaviors
12-
- Attribute, Annotation, Yaml and Xml mapping support for extensions
12+
- Attribute, Annotation and Xml mapping support for extensions
1313
- Support for 'timeAware' option: When creating an entity set a date of deletion in the future and never worry about cleaning up at expiration time.
1414
- Support for 'hardDelete' option: When deleting a second time it allows to disable hard delete.
1515

doc/sortable.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Features:
66
- Automatic handling of position index
77
- Group entity ordering by one or more fields
88
- Can be nested with other behaviors
9-
- Annotation, Attribute, Yaml and Xml mapping support for extensions
9+
- Annotation, Attribute and Xml mapping support for extensions
1010

1111
Contents:
1212
- [Setup and autoloading](#setup-and-autoloading)
@@ -29,7 +29,6 @@ on how to setup and use the extensions in most optimized way.
2929
|-------------|---------------------------------------------|------------------------------------------------|
3030
| Annotations | `@Gedmo\Mapping\Annotation\SortableGroup` | `@Gedmo\Mapping\Annotation\SortablePosition` |
3131
| Attributes | `#[Gedmo\Mapping\Annotation\SortableGroup]` | `#[Gedmo\Mapping\Annotation\SortablePosition]` |
32-
| Yaml | `gedmo: [sortableGroup]` | `gedmo: [sortablePosition]` |
3332
| Xml | `<gedmo:sortable-group />` | `<gedmo:sortable-position />` |
3433

3534
> Implementing **[Sortable interface](../src/Sortable/Sortable.php) is optional**, except in cases there you need to identify entity as being Sortable.

doc/timestampable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Features:
1111
- Specific annotations for properties, and no interface required
1212
- Can react to specific property or relation changes to specific value
1313
- Can be nested with other behaviors
14-
- Attribute, Annotation, Yaml and Xml mapping support for extensions
14+
- Attribute, Annotation and Xml mapping support for extensions
1515

1616
This article will cover the basic installation and functionality of **Timestampable** behavior
1717

doc/translatable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Features:
1212
- Automatic translation of Entity or Document fields when loaded
1313
- ORM query can use **hint** to translate all records without issuing additional queries
1414
- Can be nested with other behaviors
15-
- Attribute, Annotation, Yaml and Xml mapping support for extensions
15+
- Attribute, Annotation and Xml mapping support for extensions
1616

1717
**Note list:**
1818

doc/tree.md

Lines changed: 2 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Features:
1414
- Synchronization of left, right values is automatic
1515
- Can support concurrent flush with many objects being persisted and updated
1616
- Can be nested with other extensions
17-
- Attribute, Annotation, Yaml and Xml mapping support for extensions
17+
- Attribute, Annotation and Xml mapping support for extensions
1818

1919
Thanks for contributions to:
2020

@@ -966,63 +966,6 @@ class Category
966966

967967
```
968968

969-
### MongoDB example (Yaml)
970-
```
971-
YourNamespace\Document\Category:
972-
type: mappedSuperclass
973-
repositoryClass: Gedmo\Tree\Document\MongoDB\Repository\MaterializedPathRepository
974-
collection: categories
975-
gedmo:
976-
tree:
977-
type: materializedPath
978-
activateLocking: true
979-
fields:
980-
id:
981-
id: true
982-
title:
983-
type: string
984-
gedmo:
985-
- sluggable
986-
slug:
987-
type: string
988-
gedmo:
989-
0: treePathSource
990-
slug:
991-
unique: false
992-
fields:
993-
- title
994-
path:
995-
type: string
996-
gedmo:
997-
treePath:
998-
separator: '/'
999-
appendId: false
1000-
startsWithSeparator: false # default
1001-
endsWithSeparator: true # default
1002-
level:
1003-
type: int
1004-
name: lvl
1005-
nullable: true
1006-
gedmo:
1007-
- treeLevel
1008-
lockTime:
1009-
type: date
1010-
gedmo:
1011-
- treeLockTime
1012-
hash:
1013-
type: string
1014-
gedmo:
1015-
- treePathHash
1016-
parent:
1017-
reference: true
1018-
type: one
1019-
inversedBy: children
1020-
targetDocument: YourNamespace\Document\Category
1021-
simple: true
1022-
gedmo:
1023-
- treeParent
1024-
```
1025-
1026969
### Path generation
1027970

1028971
When an entity is inserted, a path is generated using the value of the field configured as the TreePathSource.
@@ -1062,7 +1005,7 @@ If it is locked, then it throws an exception of type "Gedmo\Exception\TreeLockin
10621005
it locks the tree and proceeds with the modification. After all the modifications are done, the lock is freed.
10631006

10641007
If, for some reason, the lock couldn't get freed, there's a lock timeout configured with a default time of 3 seconds.
1065-
You can change this value using the **lockingTimeout** parameter under the Tree annotation (or equivalent in XML and YML).
1008+
You can change this value using the **lockingTimeout** parameter under the Tree attribute (or equivalent in annotation and XML).
10661009
You must pass a value in seconds to this parameter.
10671010

10681011

0 commit comments

Comments
 (0)