PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins::QMPlugin
Child packages:

More ...Less ...

internal package Foswiki::Plugins::QMPlugin::Base

abstract base class for nodes, edges and roles

ClassProperty TRACE

boolean toggle to enable debugging of this class

ClassProperty PROPS

definition of all mandatory properties of a class of its kind; node, edge and role classes each refine this list

ClassMethod new() → $core

constructor for a Base object

ObjectMethod finish()

called when this object is destroyed

ObjectMethod props() → @props

returns a list of all known property keys of this class

ObjectMethod prop($key, $val) → $val

getter/setter for a property of this class

ObjectMethod _getPropLazy($key) → $val

get a property lazily. this method is called by prop() if the given property does not exist (yet).

ObjectMethod expandValue($val) → $val

expand the given value in the context of a state this object is in

ObjectMethod getNet() → $net

get the net this object is part of

ObjectMethod getCore() → $core

convenience method to get the plugin core

ObjectMethod index() → $index

get the unique index of this object in a set of same objects part of a net

ObjectMethod stringify() → $string

returns a string representation of this object

ObjectMethod asJson($state)

returns a json object representing this edge

ObjectMethod getWebTopic() → ($web, $topic, $rev)

returns the web, topic and revision of the current state in which this object is; returns ('', ”, ”) if the object has no state assigned to it

ObjectMethod render($format, $params) → $string

render the properties of this object given the specified format string; params is a hash reference with default values for properties not defined

ObjectMethod renderProp($propName, $params)

returns a rendered version of the given property. in addition a "title" property will be translated.

ObjectMethod expandHelpers($format) → $string

expand helper functions during the render process

ObjectMethod hasAccess($type, $user) → $boolean

checks the type of access for the given user

ObjectMethod writeDebug($string)

prints the given string to STDERR when TRACE is enabled