dcThemes Class Reference

Inheritance diagram for dcThemes:

Public Member Functions
	safeMode ()
	registerModule (string $name, string $desc, string $author, string $version, $properties=[])
	cloneModule (string $id)
	loadNsFile (string $id, ?string $ns=null)
Public Member Functions inherited from dcModules
	checkDependencies ()
	disableDepModules (string $redirect_url)
	safeMode ()
	loadModules (string $path, ?string $ns=null, ?string $lang=null)
	requireDefine (string $dir, string $id)
	registerModule (string $name, string $desc, string $author, string $version, $properties=[])
	resetModulesList ()
	installModules ()
	installModule (string $id, string &$msg)
	deleteModule (string $id, bool $disabled=false)
	deactivateModule (string $id)
	activateModule (string $id)
	cloneModule (string $id)
	loadModuleL10N (string $id, ?string $lang, string $file)
	loadModuleL10Nresources (string $id, ?string $lang)
	getModules (?string $id=null)
	getAnyModules (?string $id=null)
	moduleExists (string $id)
	getDisabledModules ()
	getHardDisabledModules ()
	getSoftDisabledModules ()
	moduleRoot (string $id)
	moduleInfo (string $id, string $info)
	loadNsFiles (?string $ns=null)
	loadNsFile (string $id, ?string $ns=null)
	getErrors ()

Static Protected Attributes
static	$type = 'theme'
Static Protected Attributes inherited from dcModules
static	$superglobals
static	$_k
static	$_n
static	$type = null

Additional Inherited Members
Static Public Member Functions inherited from dcModules
static	installPackage (string $zip_file, dcModules &$modules)
Data Fields inherited from dcModules
const	PACKAGE_INSTALLED = 1
const	PACKAGE_UPDATED = 2
const	DEFAULT_PRIORITY = 1000
const	MODULE_FILE_INSTALL = '_install.php'
const	MODULE_FILE_INIT = '_init.php'
const	MODULE_FILE_DEFINE = '_define.php'
const	MODULE_FILE_PREPEND = '_prepend.php'
const	MODULE_FILE_ADMIN = '_admin.php'
const	MODULE_FILE_PUBLIC = '_public.php'
const	MODULE_FILE_XMLRPC = '_xmlrpc.php'
const	MODULE_FILE_DISABLED = '_disabled'
	$safe_mode = false
Protected Member Functions inherited from dcModules
	parsePathModules (string $root)
	loadModuleFile (string $________, bool $catch=true)
Protected Attributes inherited from dcModules
	$path
	$ns
	$modules = []
	$disabled = []
	$hard_disabled = []
	$soft_disabled = []
	$errors = []
	$modules_names = []
	$all_modules = []
	$disabled_mode = false
	$disabled_meta = []
	$to_disable = []
	$id
	$mroot

Member Function Documentation

safeMode()

safeMode

(

)

Should run in safe mode?

Returns

bool

Reimplemented from dcModules.

registerModule()

registerModule	(	string	$name,
		string	$desc,
		string	$author,
		string	$version,
			$properties = []
	)

This method registers a theme in modules list. You should use this to register a new theme.

$parent is a optional value to indicate them inheritance.

$priority is an integer. Modules are sorted by priority and name. Lowest priority comes first. This property is currently ignored when dealing with themes.

Parameters

string	$name	The name
string	$desc	The description
string	$author	The author
string	$version	The version
mixed	$properties	The properties

Reimplemented from dcModules.

References $version, dcCore\app(), DC_DEFAULT_TPLSET, and dcAuth\PERMISSION_ADMIN.

cloneModule()

cloneModule

(

string

$id

)

Clone a theme module

Parameters

string

$id

The identifier

Exceptions

Exception

Reimplemented from dcModules.

References dcModules\$id, dcModules\$ns, files\deltree(), files\getDirList(), and files\makeDir().

loadNsFile()

loadNsFile	(	string	$id,
		?string	$ns = null
	)

Loads namespace $ns specific file for module with ID $id Note: currently, only 'public' namespace is supported with themes.

Parameters

string	$id	Module ID
string	$ns	Namespace name

Reimplemented from dcModules.

References dcModules\$id, dcModules\$ns, and dcModules\loadModuleFile().

Field Documentation

$type

$type = 'theme'

staticprotected

---

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

• inc/core/class.dc.themes.php