You are here

README.txt in Entity Dependency API 7

INTRODUCTION
------------

This module provides an API to define dependencies between entities and a useful
iterator.

BACKGROUND
----------

This project originated from the Deploy module, where it's used heavily, but
were later separated out for better code separation and reusability between
modules.

THE ITERATOR
------------

You construct the iterator with an array of entity type keys and entity id
values. Then, when iterating over the iterator you will get all entities AND
their dependencies out in a sane order (i.e. dependencies first).

Since the iterator only return "plain" entity objects and developers often need
more meta data around the entity (primarily the entity type) we are embedding
metadata within the entity object according to the OData protocol's JSON format
(http://www.odata.org/developers/protocols/json-format) which is a very simple
and lightweight way of solving the problem.

7.x-2.x
-------

The next major version should provide a more declarative API. Right now run-time
hooks are provided, which is a bit ineffective.

File

README.txt
View source
  1. INTRODUCTION
  2. ------------
  3. This module provides an API to define dependencies between entities and a useful
  4. iterator.
  5. BACKGROUND
  6. ----------
  7. This project originated from the Deploy module, where it's used heavily, but
  8. were later separated out for better code separation and reusability between
  9. modules.
  10. THE ITERATOR
  11. ------------
  12. You construct the iterator with an array of entity type keys and entity id
  13. values. Then, when iterating over the iterator you will get all entities AND
  14. their dependencies out in a sane order (i.e. dependencies first).
  15. Since the iterator only return "plain" entity objects and developers often need
  16. more meta data around the entity (primarily the entity type) we are embedding
  17. metadata within the entity object according to the OData protocol's JSON format
  18. (http://www.odata.org/developers/protocols/json-format) which is a very simple
  19. and lightweight way of solving the problem.
  20. 7.x-2.x
  21. -------
  22. The next major version should provide a more declarative API. Right now run-time
  23. hooks are provided, which is a bit ineffective.