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

More ...Less ...

internal package Foswiki::Plugins::JQDataTablesPlugin::Connector

base class for grid connectors used to feed a datatables widget

ClassMethod new($session)

constructor

ObjectMethod restHandleSave($request, $response)

this is called by the gridconnector REST handler based on the "oper" url parameter as provided by the GRID widget.

ObjectMethod buildQuery($request) → $string

creates a query based on the current request

ObjectMethod convertResult( %params ) → \%rows

convert a result to a rows for datatable.

params:

• fields: list of fields to extract
• result: result object (e.g. a solr document)
• index: row number of the result being rendered
• formDef (optional): form definition of all items in the result set

ObjectMethod getValueOfResult( $doc, $property, $fieldDef ) → $value

get a property of a result document

ObjectMethod search( %params ) → ($total, $totalFiltered, $data)

perform the actual search and fetch result

ObjectMethod restHandleSearch($request, $response)

this is called by the connector REST handler based on the "oper" url parameter as provided by the Datatables widget.

ObjectMethod getColumnDescription( $columnName ) → \%desc

describe the kind of data for a column as available in the store. this returns a description has

{ type => "date|user|topic|formfield|default|image|icon|email|index|score|number", data => "...", # access to the raw data search => "...", # data that is being searched for sort => "...", # data in a sortable fashion }

ObjectMethod getColumnsFromRequest( $request ) → @cols

read the request params and collect the column descriptions as transmitted by the Datatables client

ObjectMethod translate($string, $web, $topic) → $string

translate string to user's current language

ObjectMethod addStats($stats, $row) → $stats

counts all values of all columns in the row

StaticMethod urlDecode( $text ) → $text

from Fowiki.pm

ObjectMethod isProtected( $colname ) → $boolean

returns true if the column is supposed to be be protected