Class: Plugin

Source Location: /system/classes/plugin.class.php

Class Overview

This is a poorly thought out class that is used pretty much as a structure when we need to pass plugin data back and forth

Author(s):

Tony Bibbs, tony AT tonybibbs DOT com

Variables

Methods

Class Details

[line 39]
This is a poorly thought out class that is used pretty much as a structure when we need to pass plugin data back and forth

Tags:

author:

Tony Bibbs, tony AT tonybibbs DOT com

[ Top ]

Class Variables

$adminlabel = ''

[line 44]

Type:

mixed

[ Top ]

$adminurl = ''

[line 45]

Type:

mixed

[ Top ]

$getsubmissionssql = ''

[line 67]

Type:

mixed

[ Top ]

$num_itemssearched = 0

[line 54]

Type:

mixed

[ Top ]

$num_searchheadings = 0

[line 55]

Type:

mixed

[ Top ]

$num_searchresults = 0

[line 51]

Type:

mixed

[ Top ]

$num_submissions = 0

[line 64]

Type:

mixed

[ Top ]

$plugin_image = ''

[line 46]

Type:

mixed

[ Top ]

$plugin_name = ''

[line 47]

Type:

mixed

[ Top ]

$searchheading = array()

[line 52]

Type:

mixed

[ Top ]

$searchlabel = ''

[line 50]

Type:

mixed

[ Top ]

$searchresults = array()

[line 53]

Type:

mixed

[ Top ]

$submissionheading = array()

[line 68]

Type:

mixed

[ Top ]

$submissionhelpfile = ''

[line 66]

Type:

mixed

[ Top ]

$submissionlabel = ''

[line 65]

Type:

mixed

[ Top ]

Class Methods

constructor Plugin [line 79]

Plugin Plugin(
)

Constructor

This initializes the plugin

[ Top ]

method addSearchHeading [line 115]

void addSearchHeading(
string
$heading)

Adds a header that will be used in outputing search results for this plugin

Parameters:

string

$heading

Heading label

[ Top ]

method addSearchResult [line 127]

void addSearchResult(
string
$result_string)

Adds a search result to the result array.

Parameters:

string

$result_string

Holds coma delimited set of data

[ Top ]

method addSubmissionHeading [line 138]

void addSubmissionHeading(
string
$heading)

Hrm, can't remember what this does exactly

Parameters:

string

$heading

string for heading

[ Top ]

method reset [line 88]

void reset(
)

Resets the object

[ Top ]

method setExpandedSearchSupport [line 154]

void setExpandedSearchSupport(
boolean
$switch)

Sets whether or not the plugin supports expanded search results

Tags:

author:	Tony Bibbs, tony AT geeklog DOT net
deprecated:	no longer used
access:	public

Parameters:

boolean

$switch

True if expanded search is supported otherwise false

[ Top ]

method supportsExpandedSearch [line 172]

boolean supportsExpandedSearch(
)

Returns if plugin supports expanded searches

Tags:

return:	True if expanded search is supported otherwise false
author:	Tony Bibbs, tony AT geeklog DOT net
deprecated:	no longer used
access:	public

[ Top ]

Documentation generated on Sat, 11 Feb 2012 02:08:51 -0500 by phpDocumentor 1.4.3