zms._zreferableitem.ZReferableItem

class documentation

class ZReferableItem(object): (source)

Mixin for internal reference handling in ZMS objects.

This mixin resolves internal link tokens, collects outgoing references, maintains incoming backlinks in ref_by, and validates stored references.

Method	`changeRefsToObj`	Changes all internal references TO a new target object.
Method	`findObject`	Quickly finds and returns an object based on an internal URL. Assumes the object exists as a recently calculated uid in ZMSIndex or as a object path.
Method	`getLinkObj`	Resolves internal or external links and returns the corresponding object.
Method	`getLinkUrl`	Combines internal/external link resolution and returns the final URL string, handling anchors and mailto obfuscation.
Method	`getRefByObjs`	Returns a list of references FROM other objects to this object.
Method	`getRefObjPath`	Returns the internal reference path for a given object.
Method	`getRefToObjs`	Returns a list of references from this object TO other objects.
Method	`getRelativeUrl`	Computes a relative URL from a source path to a destination URL.
Method	`prepareRefreshRefToObjs`	Prepares the refresh of references TO other objects by storing the current references. This method stores the current outgoing references in `self.ref_to` for later comparison by `refreshRefToObjs`.
Method	`refreshRefToObjs`	Synchronizes references TO other objects, updating registrations as needed.
Method	`registerRefObj`	Registers a reference FROM another object to this object.
Method	`synchronizeRefByObjs`	Synchronizes the list of references FROM other objects.
Method	`tal_anchor`	Generate an HTML anchor (<a>) tag.
Method	`unregisterRefObj`	Unregisters a reference FROM another object to this object.
Method	`validateInlineLinkObj`	Validates internal links within inline HTML content.
Method	`validateLinkObj`	Validates a single internal link.
Method	`validateRefObj`	Validates internal object-references.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__administratorPermissions__`	Undocumented
Class Variable	`__authorPermissions__`	Undocumented
Class Variable	`manage_browse_iframe`	Undocumented
Class Variable	`manage_change_refs`	Undocumented
Class Variable	`manage_RefForm`	Undocumented
Instance Variable	`ref_by`	Undocumented
Instance Variable	`ref_to`	Undocumented

def changeRefsToObj(self, ref_to): (source) ¶

Changes all internal references TO a new target object.

Parameters
ref_to:`str`	The target reference to which all selected references should point.
Returns
`dict` or `None`	A result dictionary with changed and unchanged references, or `None` if no update could be performed.

def findObject(self, url): (source) ¶

Quickly finds and returns an object based on an internal URL. Assumes the object exists as a recently calculated uid in ZMSIndex or as a object path.

Parameters
url:`str`	Internal URL string in the format `{$...}`.
Returns
`object` or `None`	The resolved object if found, otherwise `None`.

def getLinkObj(self, url, REQUEST=None): (source) ¶

Resolves internal or external links and returns the corresponding object.

Parameters
url:`str`	The link to resolve. It can be internal or external.
REQUEST:`object`	The request object.
Returns
`object` or `None`	The resolved object if found, otherwise `None`.

def getLinkUrl(self, url, REQUEST=None): (source) ¶

Combines internal/external link resolution and returns the final URL string, handling anchors and mailto obfuscation.

Parameters
url:`str`	The link to resolve. It can be internal or external.
REQUEST:`object`	The request object.
Returns
`str` This method differs from `getLinkObj`, which returns the referenced object, and from `getInternalLinkUrl`, which renders an internal `index_html` URL for a specific object.	The resolved URL as a string.

def getRefByObjs(self, REQUEST=None): (source) ¶

Returns a list of references FROM other objects to this object.

Parameters
REQUEST:`object`	The request object.
Returns
`list`	References from other objects to this object.

def getRefObjPath(self, ob, anchor=''): (source) ¶

Returns the internal reference path for a given object.

Parameters
ob:`object`	The object to reference.
anchor:`str`	Anchor string to append.
Returns
`str`	The internal reference path in `{$...}` format.

def getRefToObjs(self): (source) ¶

Returns a list of references from this object TO other objects.

Returns
`list`	References from this object to other objects.

def getRelativeUrl(self, path, url): (source) ¶

Computes a relative URL from a source path to a destination URL.

Parameters
path:`str`	The source path.
url:`str`	The destination URL.
Returns
`str`	The relative URL if both URLs share the same base, otherwise the original destination URL.

def prepareRefreshRefToObjs(self): (source) ¶

Prepares the refresh of references TO other objects by storing the current references. This method stores the current outgoing references in self.ref_to for later comparison by refreshRefToObjs.

def refreshRefToObjs(self): (source) ¶

Synchronizes references TO other objects, updating registrations as needed.

The method unregisters obsolete backlinks and registers newly created backlinks.

def registerRefObj(self, ob): (source) ¶

Registers a reference FROM another object to this object.

Parameters
ob:`object`	The object referencing this object.

def synchronizeRefByObjs(self, strict=1): (source) ¶

Synchronizes the list of references FROM other objects.

Parameters
strict:`int`	Flag kept for API compatibility.
Returns
`list`	The updated list of references from other objects.

def tal_anchor(self, href, target='', attrs={}, content=''): (source) ¶

Generate an HTML anchor (<a>) tag.

Parameters
href:`str`	The URL for the anchor's `href` attribute.
target:`str`	The target attribute for the anchor, for example `_blank`.
attrs:`dict`	Additional HTML attributes for the anchor tag.
content:`str`	The inner HTML or text content of the anchor.
Returns
`str`	The formatted HTML anchor tag as a string.