CORE POS - Fannie
The CORE POS back end
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
COREPOS\Fannie\API\FanniePlugin Class Reference
Inheritance diagram for COREPOS\Fannie\API\FanniePlugin:
CalendarPlugin CoreWarehouse CustomMailing DeliInventory EmailReporting FanniePlugin FileByEmail GiveUsMoneyPlugin HouseCoupon MailChimpSync OpenBookFinancing OverShortTools PIKiller ReverseTransaction SelectInvoiceGrabber ShelfAudit SimpleBackup SPINS StaffArPayrollDeduction StatementsPlugin TimesheetPlugin UnfiInvoiceGrabber WfcAbandonEquity WfcGazetteBilling WfcVirtualCoupon

Public Member Functions

 pluginEnable ()
 
 plugin_enable ()
 
 pluginDisable ()
 
 plugin_disable ()
 
 settingChange ()
 
 setting_change ()
 
 pluginUrl ()
 
 plugin_url ()
 
 pluginDir ()
 
 plugin_dir ()
 
 pluginDbStruct ($db, $struct_name, $db_name="")
 
 plugin_db_struct ($db, $struct_name, $db_name="")
 

Static Public Member Functions

static memberOf ($file)
 
static isEnabled ($plugin)
 
static pluginMap ($path="", $in=array())
 

Public Attributes

 $plugin_settings
 
 $plugin_description = 'This author didn\'t provide anything. Shame!'
 

Detailed Description

FanniePlugin class

Plugins are collections of modules. Each collection should contain one module that subclasses 'Plugin'. This module provides meta-information about the plugin like settings and enable/disable hooks

Member Function Documentation

static COREPOS\Fannie\API\FanniePlugin::isEnabled (   $plugin)
static

Check whether a given plugin is enabled

Parameters
$pluginstring plugin name
Returns
True or False
static COREPOS\Fannie\API\FanniePlugin::memberOf (   $file)
static

Find the plugin containing a given file

Parameters
$filestring filename
Returns
plugin name or boolean False
COREPOS\Fannie\API\FanniePlugin::plugin_db_struct (   $db,
  $struct_name,
  $db_name = "" 
)
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::plugin_dir ( )
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::plugin_disable ( )
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::plugin_enable ( )
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::plugin_url ( )
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::pluginDir ( )

Get filesystem path for the plugin's directory

COREPOS\Fannie\API\FanniePlugin::pluginDisable ( )

Callback. Triggered when plugin is disabled

COREPOS\Fannie\API\FanniePlugin::pluginEnable ( )

Callback. Triggered when plugin is enabled

static COREPOS\Fannie\API\FanniePlugin::pluginMap (   $path = "",
  $in = array() 
)
static

Find potential class files in a given directory

Parameters
$pathstarting directory
Returns
array of class name => full file name
COREPOS\Fannie\API\FanniePlugin::pluginUrl ( )

Get a URL for the plugin's directory

COREPOS\Fannie\API\FanniePlugin::setting_change ( )
Deprecated:
Temporary compat for function normalization
COREPOS\Fannie\API\FanniePlugin::settingChange ( )

Callback. Triggered when a setting is modified

Member Data Documentation

COREPOS\Fannie\API\FanniePlugin::$plugin_settings
Initial value:
= array(
'example1' => array('default'=>'','label'=>'Setting #1',
'description'=>'Text goes here'),
'example2' => array('default'=>1,
'options'=>array('Yes'=>1,'No'=>0)
)
)

Desired settings. These are automatically exposed on the 'Plugins' area of the install page and written to ini.php


The documentation for this class was generated from the following file: