You are here

Home » API reference » Corresponding Entity References 7.3

README.txt in Corresponding Entity References 7.3

Same filename and directory in other branches
  1. 7 README.txt
  2. 7.2 README.txt
ACKNOWLEDGEMENTS

This is the next generation of Corresponding Node References. So, thanks are due
to everyone who ever worked on CNR!

DESCRIPTION

CER keeps reference fields in sync. If entity Alice references entity Bob, CER will make Bob back-reference Alice automatically, and it will continue to keep the two in sync if either one is changed or deleted. CER does this by way of “presets”, which are relationships you set up between reference-type fields.

By “reference-type fields”, I mean any kind of field that references an entity. Out of the box, CER can integrate with the following field types:

- Entity Reference
- Node Reference
- User Reference
- Taxonomy Term Reference
- Profile2 (using the cer_profile2 add-on module)
- Commerce Product Reference (using the cer_commerce add-on module)

CER has an object-oriented API you can use to integrate other kinds of fields, if you need to. For more information, see cer.api.php.

DEPENDENCIES

- Entity API
- CTools
- Table Element

CREATING PRESETS

CER won’t do anything until you create at least one preset. To create a preset, visit admin/config/content/cer and click “Add a preset”. You will need Hierarchical Select installed to continue.

Select the field you want to use for the left side of the preset, then click Continue. Another select field will appear; use it to choose the field to use for the right side of the preset. Click Save, and you’re all set!

THINGS YOU SHOULD KNOW

* If you’re updating from CER 1.x or 2.x, you MUST clear all your caches *before* running update.php so that new classes can be registered with the autoloader! If you don’t do this, you are likely to receive fatal errors during the update.

* If you have Corresponding Node References installed, CER will disable it and take over its field relationships.

* Everything CER does, it does in a normal security context. This can lead to unexpected behavior if you’re not aware of it. In other words, if you don’t have the permission to view a specific node, don’t expect CER to be able to reference it when logged in as you. Be mindful of your entity/field permissions!
  
* devel_generate does not play nicely with CER, especially where field collections are concerned. The results are utterly unpredictable.

ROAD MAP

If any of this stuff interests you, I wholeheartedly encourage you to submit patches or contribute in any way you can!

- Moar automated test coverage
- Performance enhancement
- Documentation

MAINTAINER

Questions, comments, etc. should be directed to phenaproxima (djphenaproxima@gmail.com).

File

README.txt
View source 
  1. ACKNOWLEDGEMENTS

  2. 

  3. This is the next generation of Corresponding Node References. So, thanks are due

  4. to everyone who ever worked on CNR!

  5. 

  6. DESCRIPTION

  7. 

  8. CER keeps reference fields in sync. If entity Alice references entity Bob, CER will make Bob back-reference Alice automatically, and it will continue to keep the two in sync if either one is changed or deleted. CER does this by way of “presets”, which are relationships you set up between reference-type fields.

  9. 

  10. By “reference-type fields”, I mean any kind of field that references an entity. Out of the box, CER can integrate with the following field types:

  11. 

  12. - Entity Reference

  13. - Node Reference

  14. - User Reference

  15. - Taxonomy Term Reference

  16. - Profile2 (using the cer_profile2 add-on module)

  17. - Commerce Product Reference (using the cer_commerce add-on module)

  18. 

  19. CER has an object-oriented API you can use to integrate other kinds of fields, if you need to. For more information, see cer.api.php.

  20. 

  21. DEPENDENCIES

  22. 

  23. - Entity API

  24. - CTools

  25. - Table Element

  26. 

  27. CREATING PRESETS

  28. 

  29. CER won’t do anything until you create at least one preset. To create a preset, visit admin/config/content/cer and click “Add a preset”. You will need Hierarchical Select installed to continue.

  30. 

  31. Select the field you want to use for the left side of the preset, then click Continue. Another select field will appear; use it to choose the field to use for the right side of the preset. Click Save, and you’re all set!

  32. 

  33. THINGS YOU SHOULD KNOW

  34. 

  35. * If you’re updating from CER 1.x or 2.x, you MUST clear all your caches *before* running update.php so that new classes can be registered with the autoloader! If you don’t do this, you are likely to receive fatal errors during the update.

  36. 

  37. * If you have Corresponding Node References installed, CER will disable it and take over its field relationships.

  38. 

  39. * Everything CER does, it does in a normal security context. This can lead to unexpected behavior if you’re not aware of it. In other words, if you don’t have the permission to view a specific node, don’t expect CER to be able to reference it when logged in as you. Be mindful of your entity/field permissions!

  40.   

  41. * devel_generate does not play nicely with CER, especially where field collections are concerned. The results are utterly unpredictable.

  42. 

  43. ROAD MAP

  44. 

  45. If any of this stuff interests you, I wholeheartedly encourage you to submit patches or contribute in any way you can!

  46. 

  47. - Moar automated test coverage

  48. - Performance enhancement

  49. - Documentation

  50. 

  51. MAINTAINER

  52. 

  53. Questions, comments, etc. should be directed to phenaproxima (djphenaproxima@gmail.com).