dcThemeEditor Class Reference

Public Member Functions
	__construct ()
	filesList (string $type, string $item='%1$s', bool $split=true)
	getFileContent (string $type, string $f)
	writeFile (string $type, string $f, string $content)
	deletableFile (string $type, string $f)
	deleteFile ($type, $f)

Data Fields
	$tpl = []
	$css = []
	$js = []
	$po = []
	$php = []

Protected Member Functions
	getDestinationFile (string $type, string $f)
	getFilesFromType (string $type)
	updateFileInList (string $type, string $f, string $file)
	findTemplates ()
	findStyles ()
	findScripts ()
	findLocales ()
	findCodes ()
	sortFilesHelper (string $a, string $b)
	getFilesInDir (string $dir, ?string $ext=null, string $prefix='', ?string $model=null)

Protected Attributes
	$user_theme
	$parent_theme
	$tplset_theme
	$parent_name
	$tplset_name
	$tpl_model = []

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructs a new instance.

References $parent_theme, dcCore\app(), DC_DEFAULT_TPLSET, DC_ROOT, findCodes(), findLocales(), findScripts(), findStyles(), findTemplates(), and path\real().

Member Function Documentation

filesList()

filesList	(	string	$type,
		string	$item = '%1$s',
		bool	$split = true
	)

Display a file list

Parameters

string	$type	The type of file
string	$item	The item pattern
bool	$split	Split from source?

Returns

string

References html\escapeHTML(), and getFilesFromType().

getFileContent()

getFileContent	(	string	$type,
		string	$f
	)

Gets the file content.

Parameters

string	$type	The type
string	$f	The file ID

Exceptions

Exception

Returns

array The file content.

References getDestinationFile(), and getFilesFromType().

writeFile()

writeFile	(	string	$type,
		string	$f,
		string	$content
	)

Writes a file.

Parameters

string	$type	The type
string	$f	The file ID
string	$content	The content

Exceptions

Exception

References getDestinationFile(), getFilesFromType(), files\makeDir(), and updateFileInList().

deletableFile()

deletableFile	(	string	$type,
		string	$f
	)

Check if a file is deletable

Parameters

string	$type	The type
string	$f	The file ID

Returns

bool

References getDestinationFile(), and getFilesFromType().

deleteFile()

deleteFile	(		$type,
			$f
	)

Delete a file

Parameters

string	$type	The type
string	$f	The file ID

Exceptions

Exception

References findTemplates(), getDestinationFile(), and getFilesFromType().

getDestinationFile()

getDestinationFile ( string  $type, string  $f  )

protected

Gets the destination file.

Parameters

string	$type	The type
string	$f	The file ID

Returns

bool|string The destination file.

Referenced by deletableFile(), deleteFile(), getFileContent(), and writeFile().

getFilesFromType()

getFilesFromType ( string  $type )

protected

Gets the files list from type.

Parameters

string

$type

The type

Returns

array The list.

References $css, $js, $php, $po, and $tpl.

Referenced by deletableFile(), deleteFile(), filesList(), getFileContent(), and writeFile().

updateFileInList()

updateFileInList ( string  $type, string  $f, string  $file  )

protected

Update a file in a list

Parameters

string	$type	The type
string	$f	The file ID
string	$file	The file

References $css, $js, $php, $po, and $tpl.

Referenced by writeFile().

findTemplates()

findTemplates ( )

protected

Get template files of theme.

References $tpl, dcCore\app(), and getFilesInDir().

Referenced by __construct(), and deleteFile().

findStyles()

findStyles ( )

protected

Get CSS files of theme.

References getFilesInDir().

Referenced by __construct().

findScripts()

findScripts ( )

protected

Get Javascript files of theme.

References getFilesInDir().

Referenced by __construct().

findLocales()

findLocales ( )

protected

Get translations files of theme.

References getFilesInDir(), and l10n\getISOcodes().

Referenced by __construct().

findCodes()

findCodes ( )

protected

Get PHP files of theme.

References getFilesInDir().

Referenced by __construct().

sortFilesHelper()

sortFilesHelper ( string  $a, string  $b  )

protected

Stack files sorting helper

Sort by file extension first, then by file name

Parameters

string	$a	1st file
string	$b	2nd file

Returns

int

References files\getExtension().

getFilesInDir()

getFilesInDir ( string  $dir, ?string  $ext = null, string  $prefix = '', ?string  $model = null  )

protected

Gets the files in dir.

Parameters

string	$dir	The dir
null | string	$ext	The search extension
string	$prefix	The key prefix
null | string	$model	The model

Returns

array The files in dir.

References path\real().

Referenced by findCodes(), findLocales(), findScripts(), findStyles(), and findTemplates().

Field Documentation

$user_theme

$user_theme

protected

$parent_theme

$parent_theme

protected

Referenced by __construct().

$tplset_theme

$tplset_theme

protected

$parent_name

$parent_name

protected

$tplset_name

$tplset_name

protected

$tpl_model

$tpl_model = []

protected

$tpl

$tpl = []

Referenced by findTemplates(), getFilesFromType(), and updateFileInList().

$css

$css = []

Referenced by getFilesFromType(), and updateFileInList().

$js

$js = []

Referenced by getFilesFromType(), and updateFileInList().

$po

$po = []

Referenced by getFilesFromType(), and updateFileInList().

$php

$php = []

Referenced by getFilesFromType(), and updateFileInList().

---

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

• plugins/themeEditor/inc/themeEditor.php