laravel-doctrine / docs Goto Github PK

Explain the multiple strategies for mapping and using inheritance in entities.

Reference to Doctrine documentation, try to avoid duplicating it, but always emphasize differences if they exist.

Explain how to add custom indexes and unique constraints to single fields and multiple fields.

In the documentation in http://www.laraveldoctrine.org/docs/1.1/fluent/entities and also in this docs..
say:

If you're using Laravel and Doctrine through the laravel-doctrine/orm package, then all you need to do here is add the ScientistMapping class reference to your config file

But it isn't anymore, I saw that in laravel-doctrine/orm doesn't have fluent, now you need to install it apart.
Sorry for my bad English I'm from Perú

Version 2.0 seems to be out, but I've seen no reference to updating the documentation.

Is there plans to work on that? Can I help out?

I've noticed that the latest release is 1.4 yet the docs site shows 1.3 as the default/latest. Willing to help out, but curious on what needs to be changed/documented to get the 1.4 docs up on the site?

Btw, thanks for all your hard work on this very useful project!

Recent changes to pagination weren't added to docs.

Explain how to map them and what do each mean. Refer to Doctrine's documentation. Recommend to use only as an infrastructure hack, not as domain events.

This should be more like a guide on how the Builder works, with each method becoming a queued Command and how to use each Command's fluent interface to progressively define the column. Also, this could contain a complete API documentation of possible column types and customizations.

https://github.com/laravel-doctrine/docs/blob/1.5/orm/caching.md

This syntax is deprecated
$cache->extend('memcache', function(Application $app)

and should be replaced by
$cache->extend('memcache', function(array $settings, Application $app)

Explain what is an embeddable and how to map it.

Reference to Doctrine documentation, try to avoid duplicating it, but always emphasize differences if they exist.

While working on laravel-doctrine/orm#308 I noticed that the documentation doesn't mention the fact that the orm package can extend the auth and notification channel managers. For the "extending" to work the managers must be registered before DoctrineServiceProvider.

Explain how to use the Macro functionality (taken almost literally from Laravel) to extend the Fluent\Builder with custom functionality.

As found in laravel-doctrine/fluent#40, Tree has a different syntax and docs weren't updated.

Describe how to map an entity.

Reference to Doctrine documentation, try to avoid duplicating it, but always emphasize differences if they exist.

A separate documentation will be made to inheritance and mapped superclasses, so maybe only link to it here.

This should explain how relations / associations (should we favor Doctrine's lingo here?) work in Doctrine. Maybe clarify differences between how things get done in Laravel and in Doctrine, eg.: pivots don't exist, relations are not bidirectional by default, owning vs inverse, etc.

Always refer to Doctrine's documentation but this one has plenty of room for our customizations to be explained.