internal package Foswiki::Plugins::ListyPlugin::Core

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

internal package ListyPlugin::Core

writeDebug($message)

prints a debug message to STDERR when this module is in TRACE mode

inlineError($text) -> $html

formats an inline error message

new($class)

constructor for the core

init($this, $session)

initializes this instance with values of this session

LISTY($this, $params, $theTopic, $theWeb) -> $result

implementation of this macro

getListyItemTitle($item)

returns the title of a listy item depending on its type

FAVBUTTON($this, $params, $theTopic, $theWeb) -> $result

implementation of this macro

getListyItems($web, $topic, $meta) -> @listyItems

returns all listy items stored in the given topic

getListyItemsByQuery($web, $topic, $query) -> @listyItems

returns a list of items by query

getListyItemsByDBQuery($web, $topic, $query) -> @listyItems

returns a list of items by query

syncQueryListy($web, $topic, $collection, $queryItems) -> @items

jsonRpcSaveListyItem($this, $request)

jsonRpcDeleteListyItem($this, $request)

jsonRpcSaveListy($this, $request)

getMaxIndex($meta, $collection) -> $index

create the index of the last entry

reads the listyplugin templates unless already loaded

remove listy items that already exist in other collections

convert one or multiple sidebar / leftbar topics to listies

This topic: System > Category > DeveloperDocumentationCategory > PerlDoc
Topic revision: 03 Feb 2016, UnknownUser
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding DAMASK? Send feedback