Properties

$withUnixTimestamp

$withUnixTimestamp : 

boolean

Type

$listFields

$listFields : 

array

Type

$resourceFields

$resourceFields : 

array

Type

$resourceMiscFields

$resourceMiscFields : 

array

Type

$textFields

$textFields : 

array

Type

$yearFields

$yearFields : 

array

Type

$pageFields

$pageFields : 

array

Type

$summaryFields

$summaryFields : 

array

Type

$timestampFields

$timestampFields : 

array

Type

$unixTimestampFields

$unixTimestampFields : 

array

Type

$publisherFields

$publisherFields : 

array

Type

$collectionFields

$collectionFields : 

array

Type

$userFields

$userFields : 

array

Type

$attachmentFields

$attachmentFields : 

array

Type

$categoryFields

$categoryFields : 

array

Type

$keywordFields

$keywordFields : 

array

Type

$musingFields

$musingFields : 

array

Type

$languageFields

$languageFields : 

array

Type

$groupByResourceId

$groupByResourceId : 

boolean

Type

Methods

__construct()

__construct() : 

RESOURCECOMMON

Returns

setHighlightPatterns()

setHighlightPatterns() : 

Set up highlighting of text if required (after a search operation).

Creates array of regexp expressions for search terms

Returns

doHighlight()

doHighlight(  text) : 

Do pattern highlighting after a SEARCH operation

Parameters

text

Returns

showCitations()

showCitations(  resourceId,   countOnly = FALSE) : 

show citations about this resource

Parameters

resourceId
countOnly

Default is FALSE

Returns

insert()

insert(mixed||string|int  v,   alreadyExisted = FALSE, mixed||string|int  errs = array()) : \returns

Insert new resource into database.

Parameters

mixed||string|int v

POST/GET variables needed to create resource (the actual required and optional keys should be specified)

alreadyExisted

Indicates if the resource already exists. Reference, default is FALSE

mixed||string|int errs

Array to push any errors that occur. Reference, default is empty array

Returns

\returns —

the id of the (new or already existing) resource or returns FALSE on failure.

getResource()

getResource(mixed||string|int  ids = FALSE,   order1 = FALSE,   order2 = FALSE,   order3 = FALSE,   subQuery = FALSE,   sqlOnly = FALSE) : 

Return resultset for one or more resources.

NB -- resource ID conditions can be set elsewhere $orderX is for footnote ordering in CITESTYLE/CITEFORMAT or $order1 is for the ordering of CMS output.

Parameters

mixed||string|int ids

Resource IDs, default is FALSE

order1

Default is FALSE

order2

Default is FALSE

order3

Default is FALSE

subQuery

Can come from elsewhere such as core/cms/CMS.php. Default is FALSE

sqlOnly

Don't execute, just return SQL statement. Default is FALSE

Returns

SQL statement|SQL resource object

tableSetup()

tableSetup() : 

set DB stuff including list operation fields

Returns