BiReference

Category: Fields and widgets — Other products by this author

Current release: BiReference 0.1

Released Nov 7, 2007 — tested with Plone 2.5

Initial stable release

List all releases… Full release announcement…

Get BiReference for all platforms (14.2 kB)

BiReference.0.1.zip

Project Description

Project resources

• Releases
• Contact address
• Code repository

Purpose
-------
  Implements BiDirectional/Unidirectional references in Archetypes.
  Acts as a drop in replacement for ReferenceField and BackReferenceField
  and is perfect for self referential relationships.

Installation
------------

  unpack the archive into youe zope's Products dir
  install Archetypes + BiReference inside your portal with QuickInstaller

Usage
-----

- in your UML tool create a relation between 2 classes and make the 'to' end of the assoc
navigable (such a beast is provided in the sample dir). You can also point the referense
to the same class.

- set back_reference_field and reference_field to BiReferenceField (with appropriate imports tags)

- you will need to set the widget to BiReferenceWidget or a compatible reference widget
(see below)

- invoke ArchGenXML (version 1.2, at the date of the writing you must download it from svn.plone.org from the trunk)::

  python ArchGenXML/ArchGenXML --back-references-support ATBackRef/sample/atbackref.zuml BackRefSample

- restart your zope and try it out

- you will notice that references can be created at either end and are viewable at
  either end
 
Caveats - It won't work with many existing reference widgets such as PopupReferenceWidget.
Most reference widgets don't use the fields accessor to get the references and instead
assume they can get the references from the reference tool directly. It will work
with SearchReferenceWidget

Copyright, License, Author
--------------------------

  Copyright (c) 2007, PretaWeb, Australia,
   and the respective authors. All rights reserved.
 
  Author: Dylan Jay <software@pretaweb.com>

  License BSD-ish, see LICENSE.txt


Credits
-------
   Thanks to Phil Auerperg  at bluedynamics for ATBackRef which this is based on