tiles Package¶
tiles Package¶
absoluteurl Module¶
- class plone.tiles.absoluteurl.BaseTileAbsoluteURL(context, request)[source]¶
Bases: zope.traversing.browser.absoluteurl.AbsoluteURL
Convenience base class
- class plone.tiles.absoluteurl.PersistentTileAbsoluteURL(context, request)[source]¶
Bases: plone.tiles.absoluteurl.BaseTileAbsoluteURL
Absolute URL for a persitent tile. Includes the tile traverser, but no tile data encoded in the query string.
- class plone.tiles.absoluteurl.TransientTileAbsoluteURL(context, request)[source]¶
Bases: plone.tiles.absoluteurl.BaseTileAbsoluteURL
Absolute URL for a transient tile. Includes the tile traverser and tile data encoded in the query string.
data Module¶
- class plone.tiles.data.PersistentTileDataManager(tile)[source]¶
Bases: object
A data reader for persistent tiles operating on annotatable contexts. The data is retrieved from an annotation.
- class plone.tiles.data.TransientTileDataManager(tile)[source]¶
Bases: object
A data manager for transient tile data, which reads data from the request query string.
- plone.tiles.data.decode(data, schema, missing=True)[source]¶
Decode a data dict according to a schema. The returned dictionary will contain only keys matching schema names, and will force type values appropriately.
This function is only necessary because the encoders used by encode() are not sufficiently detailed to always return the exact type expected by a field, e.g. resulting in ascii/unicode discrepancies.
If missing is True, fields that are in the schema but not in the data will be set to field.missing_value. Otherwise, they are ignored.
- plone.tiles.data.encode(data, schema, ignore=())[source]¶
Given a data dictionary with key/value pairs and schema, return an encoded query string. This is similar to urllib.urlencode(), but field names will include the appropriate field type converters, e.g. an int field will be encoded as fieldname:int=123. Fields not found in the data dict will be ignored, and items in the dict not in the schema will also be ignored. Additional fields to ignore can be passed with the ‘ignore’ parameter. If any fields cannot be converted, a ComponentLookupError will be raised.
esi Module¶
- class plone.tiles.esi.ESIBody(context, request)[source]¶
Bases: object
Render the head portion of a tile independently.
- class plone.tiles.esi.ESIHead(context, request)[source]¶
Bases: object
Render the head portion of a tile independently.
- class plone.tiles.esi.ESIPersistentTile(context, request)[source]¶
Bases: plone.tiles.esi.ConditionalESIRendering, plone.tiles.tile.PersistentTile
Convenience class for tiles using ESI rendering.
Set head to True if this tile renders <head /> content. The default is to render <body /> content.
- head = False¶
- class plone.tiles.esi.ESITile(context, request)[source]¶
Bases: plone.tiles.esi.ConditionalESIRendering, plone.tiles.tile.Tile
Convenience class for tiles using ESI rendering.
Set head to True if this tile renders <head /> content. The default is to render <body /> content.
- head = False¶
fieldtypeconverters Module¶
- class plone.tiles.fieldtypeconverters.BoolConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'boolean'¶
- class plone.tiles.fieldtypeconverters.FloatConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'float'¶
- class plone.tiles.fieldtypeconverters.ListConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'list'¶
- class plone.tiles.fieldtypeconverters.LongConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'long'¶
- class plone.tiles.fieldtypeconverters.TextConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'text'¶
- class plone.tiles.fieldtypeconverters.TupleConverter(field)[source]¶
Bases: plone.tiles.fieldtypeconverters.NoConverter
- token = 'tuple'¶
interfaces Module¶
meta Module¶
tests Module¶
tile Module¶
- class plone.tiles.tile.PersistentTile(context, request)[source]¶
Bases: plone.tiles.tile.Tile
Base class for persistent tiles. Identical to Tile, except that the data dict is never serialized with the URL.
- class plone.tiles.tile.Tile(context, request)[source]¶
Bases: zope.publisher.browser.BrowserView
Basic implementation of a transient tile. Subclasses should override __call__ or set an ‘index’ variable to point to a view page template file.
The tile is basically a browser view, with the following enhancements:
- The attribute data can be used to read the tile data, as returned by ITileDataManager(tile).get(). This value is cached when it is first read.
- The attribute url can be used to obtain the tile’s URL, including the id specifier and any data associated with a transient tile. Again, the return value is cached after the first access.
- The class implements __getitem__() to set the tile id from the traversal sub-path, as well as to allow views to be looked up. This is what allows a URL like http://.../@@example.tile/foo to result in a tile with id foo.
- id = None¶
