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::LikePlugin
Child packages:

More ...Less ...

internal package Foswiki::Plugins::LikePlugin::Core

Core of the plugin. There can only be one.

ClassMethod new() → $core

constructor for a Core object

ObjectMethod finish()

deconstruct this object

ObjectMethod db() - $db

create db based on dbi schema

ObjectMethod getStatementHandler($id) → $sth

get sql statement handler for the stored templates

ObjectMethod LIKE($session, $params, $topic, $web) → $string

implements the %LIKE macro

ObjectMethod getTheme($name) → $record

returns the theme description for the given name

ObjectMethod jsonRpcVote($session, $request) → $responseJson

JSON-RPC handler for the vote method

ObjectMethod like($record) → ($likes, $dislikes)

adds a like record to the db and returns an array of likes, dislikes counter

ObjectMethod getLikes($web, $topic, $type, $id) → ($likes, $dislikes)

returns an array of two counters likes and dislikes

ObjectMethod getLikeOfUser($web, $topic, $type, $id, $wikiName) → ($likes, $dislikes)

return the likes of a given user

ObjectMethod solrIndexTopicHandler($indexer, $doc, $web, $topic, $meta, $text)

solr handler adding likes to the index

ObjectMethod dbcacheIndexTopicHandler($db, $obj, $web, $topic, $meta, $text)

dbcache handler adding likes to the dbcache

ObjectMethod afterRenameHandler($oldWeb, $oldTopic, $oldAttachment, $newWeb, $newTopic, $newAttachment)

this handler is called whenever an object on Foswiki is renamed. the callback will then maintain the database records associated with this object and rename the records accordingly