Skip to content

Remove references to Yaml driver #2403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ flushed in a behavioral way.
- [**References**](/doc/references.md) - supports linking Entities in Documents and vice versa
- [**ReferenceIntegrity**](/doc/reference_integrity.md) - constrains ODM MongoDB Document references

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

### Version Compatibility
Expand Down
2 changes: 1 addition & 1 deletion doc/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ $annotationDriver = new Doctrine\ORM\Mapping\Driver\AnnotationDriver(
$cachedAnnotationReader, // our cached annotation reader
array(__DIR__.'/app/Entity') // paths to look in
);
// NOTE: driver for application Entity can be different, Yaml, Xml or whatever
// NOTE: driver for application Entity can be different, Attribute, Xml or whatever
// register annotation driver for our application Entity namespace
$driverChain->addDriver($annotationDriver, 'Entity');

Expand Down
2 changes: 1 addition & 1 deletion doc/mapping.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Mapping extension for Doctrine2

**Mapping** extension makes it easy to map additional metadata for event listeners.
It supports **Yaml**, **Xml** and **Annotation** drivers which will be chosen depending on
It supports **Attribute**, **Xml** and **Annotation** drivers which will be chosen depending on
currently used mapping driver for your domain objects. **Mapping** extension also
provides abstraction layer of **EventArgs** to make it possible to use single listener
for different object managers like **ODM** and **ORM**.
Expand Down
2 changes: 1 addition & 1 deletion doc/sluggable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Features:
- ORM and ODM support using same listener
- Slugs can be unique and styled, even with prefixes and/or suffixes
- Can be nested with other behaviors
- Attribute, Annotation, Yaml and Xml mapping support for extensions
- Attribute, Annotation and Xml mapping support for extensions
- Multiple slugs, different slugs can link to same fields

**Note:**
Expand Down
2 changes: 1 addition & 1 deletion doc/softdeleteable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Features:
- All SELECT queries will be filtered, not matter from where they are executed (Repositories, DQL SELECT queries, etc).
- For now, it works only with the ORM
- Can be nested with other behaviors
- Attribute, Annotation, Yaml and Xml mapping support for extensions
- Attribute, Annotation and Xml mapping support for extensions
- 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.
- Support for 'hardDelete' option: When deleting a second time it allows to disable hard delete.

Expand Down
3 changes: 1 addition & 2 deletions doc/sortable.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Features:
- Automatic handling of position index
- Group entity ordering by one or more fields
- Can be nested with other behaviors
- Annotation, Attribute, Yaml and Xml mapping support for extensions
- Annotation, Attribute and Xml mapping support for extensions

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

> Implementing **[Sortable interface](../src/Sortable/Sortable.php) is optional**, except in cases there you need to identify entity as being Sortable.
Expand Down
2 changes: 1 addition & 1 deletion doc/timestampable.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Features:
- 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
- Attribute, Annotation, Yaml and Xml mapping support for extensions
- Attribute, Annotation and Xml mapping support for extensions

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

Expand Down
2 changes: 1 addition & 1 deletion doc/translatable.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Features:
- Automatic translation of Entity or Document fields when loaded
- ORM query can use **hint** to translate all records without issuing additional queries
- Can be nested with other behaviors
- Attribute, Annotation, Yaml and Xml mapping support for extensions
- Attribute, Annotation and Xml mapping support for extensions

**Note list:**

Expand Down
61 changes: 2 additions & 59 deletions doc/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Features:
- Synchronization of left, right values is automatic
- Can support concurrent flush with many objects being persisted and updated
- Can be nested with other extensions
- Attribute, Annotation, Yaml and Xml mapping support for extensions
- Attribute, Annotation and Xml mapping support for extensions

Thanks for contributions to:

Expand Down Expand Up @@ -966,63 +966,6 @@ class Category

```

### MongoDB example (Yaml)
```
YourNamespace\Document\Category:
type: mappedSuperclass
repositoryClass: Gedmo\Tree\Document\MongoDB\Repository\MaterializedPathRepository
collection: categories
gedmo:
tree:
type: materializedPath
activateLocking: true
fields:
id:
id: true
title:
type: string
gedmo:
- sluggable
slug:
type: string
gedmo:
0: treePathSource
slug:
unique: false
fields:
- title
path:
type: string
gedmo:
treePath:
separator: '/'
appendId: false
startsWithSeparator: false # default
endsWithSeparator: true # default
level:
type: int
name: lvl
nullable: true
gedmo:
- treeLevel
lockTime:
type: date
gedmo:
- treeLockTime
hash:
type: string
gedmo:
- treePathHash
parent:
reference: true
type: one
inversedBy: children
targetDocument: YourNamespace\Document\Category
simple: true
gedmo:
- treeParent
```

### Path generation

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

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


Expand Down