Docs For Class PluginSetup

Description

Plugin setup class

author: Murat Purc (murat@purc.de)
todo: should extend PluginSetupAbstract and implement IPluginSetup

Located in /contenido/plugins/mod_rewrite/includes/functions.mod_rewrite_setup.php (line 31)

Variable Summary

static mixed $_bInitialized

static mixed $_cfg

static mixed $_db

Method Summary

static void initialize ()

static void install ()

static void uninstall ()

static void upgrade ()

static boolean _inArticles ([string $sName = ''], [integer $iArtId = 0], [integer $iLangId = 0], [integer $iCatId = 0])

static boolean _inCategory ([string $sName = ''], [integer $iCatId = 0], [integer $iLangId = 0])

static boolean _setArticle ([string $sName = ""], [integer $iArtId = 0], [integer $iLangId = 0], [ $iCatId = 0])

static boolean _setCategory ([string $sName = ''], [integer $iCatId = 0], [integer $iLangId = 0])

static string _setCategoryPath ([int $iCatId = 0], [int $iLangId = 0], [int $iLastId = 0])

Variables

static mixed $_bInitialized = false (line 33)

access: private

static mixed $_cfg (line 35)

access: private

static mixed $_db (line 37)

access: private

Methods

static initialize (line 40)

access: public

void initialize ()

static install (line 54)

Install plugin

Handle upgrading of mod rewrite needed database table columns

access: public

void install ()

static uninstall (line 114)

Delete plugin

Removed done changes to database during installation/upgrade process

access: public

void uninstall ()

static upgrade (line 104)

Upgrade plugin

Handle upgrading of mod rewrite needed database table columns

access: public

void upgrade ()

static _inArticles (line 253)

Check articles on websafe name

Check all articles in the current category on existing same websafe name

return: true if websafename already exists, false if not
access: private

boolean _inArticles ([string $sName = ''], [integer $iArtId = 0], [integer $iLangId = 0], [integer $iCatId = 0])

string $sName: Websafe name to check
integer $iArtId: current article id
integer $iLangId: current language id
integer $iCatId: current category id

static _inCategory (line 293)

Check categories on websafe name

Check all categories in the main parent category on existing same websafe name

return: true if websafename already exists, false if not
access: private

boolean _inCategory ([string $sName = ''], [integer $iCatId = 0], [integer $iLangId = 0])

string $sName: Websafe name to check
integer $iCatId: current category id
integer $iLangId: current language id

static _setArticle (line 132)

Set websafe name in article list

insert new websafe name in article list

return: true if insert was successfully
access: private

boolean _setArticle ([string $sName = ""], [integer $iArtId = 0], [integer $iLangId = 0], [ $iCatId = 0])

string $sName: original name (will be converted)
integer $iArtId: current article id
integer $iLangId: current language id
$iCatId

static _setCategory (line 169)

Set websafe name in category list

insert new websafe name in category list

return: true if insert was successfully
access: private

boolean _setCategory ([string $sName = ''], [integer $iCatId = 0], [integer $iLangId = 0])

string $sName: original name (will be converted)
integer $iCatId: current article id
integer $iLangId: current language id

static _setCategoryPath (line 205)

Build and set recursiv path for mod_rewrite rule like server directories (dir1/dir2/dir3)

return: linkpath with correct uri
access: private

string _setCategoryPath ([int $iCatId = 0], [int $iLangId = 0], [int $iLastId = 0])

int $iCatId: Latest category id
int $iLangId: Language id
int $iLastId: Last category id