Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]

Class: Plugin

Source Location: /lib/class/plugin.class.php

Class Overview




Variables

Methods



Class Details

[line 22]


[ Top ]


Class Variables

$name =

[line 25]



Tags:

access:  public

Type:   mixed


[ Top ]

$_plugin =

[line 28]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


static method get_plugins [line 73]

static void get_plugins( )

get_plugins

This returns an array of plugin names




Tags:

access:  public


[ Top ]

static method get_plugin_version [line 196]

static void get_plugin_version( $plugin_name)

get_plugin_version

This returns the version of the specified plugin




Tags:

access:  public


Parameters:

   $plugin_name  

[ Top ]

static method is_installed [line 153]

static void is_installed( $plugin_name)

is_installed

This checks to see if the specified plugin is currently installed in the database, it doesn't check the files for integrity




Tags:

access:  public


Parameters:

   $plugin_name  

[ Top ]

constructor __construct [line 35]

Plugin __construct( $name)

Constructor

This constructor loads the Plugin config file which defines how to install/uninstall the plugin from Ampache's database




Tags:

access:  public


Parameters:

   $name  

[ Top ]

method get_ampache_db_version [line 213]

void get_ampache_db_version( )

get_ampache_db_version

This function returns the Ampache database version




[ Top ]

method install [line 166]

void install( )

install

This runs the install function of the plugin (must be called install) at the end it inserts a row into the update_info table to indicate That it's installed




Tags:

access:  public


[ Top ]

method is_valid [line 110]

void is_valid( )

is_valid

This checks to make sure the plugin has the required functions and settings, Ampache requires Name/Description/Version (Int) and a install & uninstall method and Ampache must be within the min/max version specifications




[ Top ]

method remove_plugin_version [line 244]

void remove_plugin_version( )

remove_plugin_version

This removes the version row from the db done on uninstall




Tags:

access:  public


[ Top ]

method set_plugin_version [line 228]

void set_plugin_version( $version)

set_plugin_version

This sets the plugin version in the update_info table




Tags:

access:  public


Parameters:

   $version  

[ Top ]

method uninstall [line 184]

void uninstall( )

uninstall

This runs the uninstall function of the plugin (must be called uninstall) at the end it removes the row from the update_info table to indicate that it isn't installed




Tags:

access:  public


[ Top ]

method _get_info [line 52]

void _get_info( $name)

_get_info

This actually loads the config file for the plugin the name of the class contained within the config file must be Plugin[NAME OF FILE]




Parameters:

   $name  

[ Top ]


Documentation generated on Thu, 12 Feb 2009 08:00:05 +0900 by phpDocumentor 1.4.2