CMSimple_XH
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XH\CoreArrayFileEdit Class Reference

The abstract base class for editing of core config and text files. More...

Inheritance diagram for XH\CoreArrayFileEdit:
XH\ArrayFileEdit XH\FileEdit XH\CoreConfigFileEdit XH\CoreLangFileEdit

Public Member Functions

 __construct ()
 Constructs an instance.
 
- Public Member Functions inherited from XH\ArrayFileEdit
 form ()
 Returns the form to edit the file contents. More...
 
 submit ()
 Handles the form submission. More...
 

Protected Member Functions

 asString ()
 Returns the the file contents as string for saving. More...
 
- Protected Member Functions inherited from XH\ArrayFileEdit
 save ()
 Saves the file and returns whether that succeeded. More...
 
 translate ($key)
 Returns the localization of the given config or language key. More...
 
 splitKey ($key)
 Returns a key split to category and rest. More...
 
 hasVisibleFields (array $options, $advanced)
 Returns whether all options are hidden. More...
 
 formField ($cat, $name, array $opt)
 Returns a form field. More...
 
 renderFormFields ($advanced)
 Renders the form fields grouped by category. More...
 
 option ($mcf, $val, $hint)
 Returns an option array. More...
 

Protected Attributes

string $varName
 
- Protected Attributes inherited from XH\ArrayFileEdit
array $cfg
 The configuration.
 
array $lang
 A dictionary which maps from config and languages keys to their localization.
 
string $metaLangFile
 The path of the meta language file, which contains localization of config and language keys.
 
- Protected Attributes inherited from XH\FileEdit
array $params
 Additional POST parameters.
 
string $plugin
 The name of the plugin.
 
string $caption
 The caption of the form.
 
string $filename
 The name of the file to edit.
 
string $redir
 URL for redirecting after successful submission (PRG pattern).
 

Detailed Description

The abstract base class for editing of core config and text files.

Author
Peter Harteg peter.nosp@m.@har.nosp@m.teg.d.nosp@m.k
The CMSimple_XH developers devs@.nosp@m.cmsi.nosp@m.mple-.nosp@m.xh.o.nosp@m.rg
Since
1.6

Member Function Documentation

◆ asString()

XH\CoreArrayFileEdit::asString ( )
protected

Returns the the file contents as string for saving.

Returns
string

Reimplemented from XH\FileEdit.

Member Data Documentation

◆ $varName

string XH\CoreArrayFileEdit::$varName
protected

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