Docs For Class CoreModuleExtras

Method Summary

array	convertCharacterSetToUtf8()	Change character set encoding to utf 8 for MySQL if necessary. This is public because it is also used by ConvertDatabaseToUtf8Task.
boolean	isConfigUpgradeRequired()	Check if any changes to config.php are required for this upgrade.
GalleryStatus	performConfigUpgrade()	Perform upgrade of config.php file.
void	performFactoryRegistrations()
void	upgrade()
GalleryStatus	_createAccessListCompacterLock()	Create the access list compactor lock entity.
GalleryStatus	_createAdminUser()	Create the initial admin user.
GalleryStatus	_createAllUsersGroup()	Create the initial all users group.
GalleryStatus	_createAnonymousUser()	Create the initial anonymous user.
GalleryStatus	_createEverybodyGroup()	Create the everybody group.
GalleryStatus	_createRootAlbumItem()	Create the root album item.
GalleryStatus	_createSiteAdminsGroup()	Create the site admins group.
array	_prepareConfigUpgrade()	Determine what changes to config.php are required for this upgrade.
void	_sortSchemaTableLast()	Sort an associative array where the key is the name of the table. Force the schema table to be last in line.

[ Top ]

Methods

convertCharacterSetToUtf8 [line 3451]

array convertCharacterSetToUtf8(

$module, 
$statusMonitor 
)

Change character set encoding to utf 8 for MySQL if necessary. This is public because it is also used by ConvertDatabaseToUtf8Task.

Parameters:

	$module:
	$statusMonitor:

API Tags:

Return:	GalleryStatus a status code bool true if any conversions took place
Access:	public

[ Top ]

isConfigUpgradeRequired [line 2952]

boolean isConfigUpgradeRequired(
string
$currentVersion 
)

Check if any changes to config.php are required for this upgrade.

Parameters:

string

$currentVersion:

current core version

API Tags:

Return:

true if change is required

[ Top ]

performConfigUpgrade [line 2963]

GalleryStatus performConfigUpgrade(
string
$currentVersion 
)

Perform upgrade of config.php file.

Parameters:

string

$currentVersion:

current core version

API Tags:

Return:

a status code

[ Top ]

performFactoryRegistrations [line 3347]

void performFactoryRegistrations(

$module 
)

Parameters:

$module:

API Tags:

See:

GalleryModule::performFactoryRegistrations

[ Top ]

upgrade [line 46]

void upgrade(
GalleryModule
$module, string
$currentVersion, 
$statusMonitor 
)

Parameters:

GalleryModule	$module:	the core module
string	$currentVersion:	the current installed version
	$statusMonitor:

API Tags:

See:

GalleryModule::upgrade

[ Top ]

_createAccessListCompacterLock [line 3319]

GalleryStatus _createAccessListCompacterLock(
GalleryModule
$module 
)

Create the access list compactor lock entity.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createAdminUser [line 3194]

GalleryStatus _createAdminUser(
GalleryModule
$module 
)

Create the initial admin user.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createAllUsersGroup [line 3021]

GalleryStatus _createAllUsersGroup(
GalleryModule
$module 
)

Create the initial all users group.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createAnonymousUser [line 3141]

GalleryStatus _createAnonymousUser(
GalleryModule
$module 
)

Create the initial anonymous user.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createEverybodyGroup [line 3101]

GalleryStatus _createEverybodyGroup(
GalleryModule
$module 
)

Create the everybody group.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createRootAlbumItem [line 3257]

GalleryStatus _createRootAlbumItem(
GalleryModule
$module 
)

Create the root album item.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_createSiteAdminsGroup [line 3061]

GalleryStatus _createSiteAdminsGroup(
GalleryModule
$module 
)

Create the site admins group.

Parameters:

GalleryModule

$module:

the core module

API Tags:

Return:

a status code

[ Top ]

_prepareConfigUpgrade [line 2616]

array _prepareConfigUpgrade(
string
$currentVersion 
)

Determine what changes to config.php are required for this upgrade.

Parameters:

string

$currentVersion:

current core version

API Tags:

Return:	of array('remove' => array of string regexp removals, 'add' => array of string additions)
Access:	private

[ Top ]

_sortSchemaTableLast [line 3585]

void _sortSchemaTableLast(

$a, 
$b 
)

Sort an associative array where the key is the name of the table. Force the schema table to be last in line.

Parameters:

	$a:
	$b:

[ Top ]

	GalleryCore

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

Class: CoreModuleExtras

Class CoreModuleExtras