Skip to main content

Plone integration for the basic plone.uuid package

Project description

Introduction

This package integrates the low-level plone.uuid into Plone-the- application. In particular, it:

  • Registers a portal_catalog indexer for the UID index that allows an object’s UUID to be indexed.

    This name is intentionally chosen to be the same as the Archetypes UID() attribute, which is already indexed by Plone. The effect is that the UID catalog attribute/metadata is now generalised to all content that supports the plone.uuid protocol.

    As of version 1.7, Products.Archetypes depends on plone.uuid and implements an IUUID adapter suitable for Archetypes content. It also uses the plone.uuid IUUIDGenerator utility to generate UUIDs for (new) content, although note that UUIDs generated by the pre-1.7 UUID algorithm, whilst different, cannot collide with the UUIDs generated by the default IUUIDGenerator implementation.

    It follows that the plone.uuid IUUID adapter and @@uuid view are now the preferred, generalised way to look up a UUID for an object.

  • Registers a utility view, @@redirect-to-uuid. You can use this with a URL like:

    http://example.org/some/path/@@redirect-to-uuid/b2dc6f7a-9d17-11df-8788-58b035f3cfa0

    This will then redirect to the object identified by that URL.

    Hint: You can use the @@uuid view from plone.uuid to render a UUID. In TAL, you can do something like:

    <a tal:attributes="href string:${portal_url}/@@redirect-to-uuid/${obj/@@uuid}">Click here</a>
  • Provides several utility methods in the plone.app.uuid.utils module:

    uuidToPhysicalPath(uuid)

    Returns the physical path (relative to the ZODB root) as a string of the object with the given UUID, or None if it cannot be found.

    uuidToURL(uuid)

    Returns the absolute URL of the object with the given UUID, or None if it cannot be found.

    uuidToObject(uuid)

    Returns the content object associated with the given UUID, or None if it cannot be found.

Please see the plone.uuid package for more details about how UUIDs are generated and can be accessed.

Changelog

1.1.1 (2016-08-10)

Fixes:

  • Use zope.interface decorator. [gforcada]

1.1 (2014-02-19)

  • Make the test setup independent from basic content types in the PLONE_FIXTURE. [timo]

1.0 - 2011-05-13

  • Release 1.0 Final. [esteele]

  • Add MANIFEST.in. [WouterVH]

1.0b2 - 2011-01-03

  • Use user id instead of user name to fix tests. [davisagli]

1.0b1 - 2010-11-27

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plone.app.uuid-1.1.1.tar.gz (12.8 kB view details)

Uploaded Source

File details

Details for the file plone.app.uuid-1.1.1.tar.gz.

File metadata

File hashes

Hashes for plone.app.uuid-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e28cb19a9906ce0f5afddcf645ce32bc3147a3d7c37f2e5b164bb1b5c5b7461b
MD5 029bb8ebb58df4463793c6a6b021196a
BLAKE2b-256 d7a666fcdcf94ee3a553b97679e4ff3bb352fc2f13000f2ed1f8c13c0c47dfce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page