LEPTON CMS 7.0.0
feel free to keep it strictly simple...
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Member Functions
LEPTON_abstract Class Reference

Inherited by LEPTON_request, and LEPTON_secure.

Public Member Functions

 getHeadInfo ()
 
 showmodinfo (array $modvalues=[], bool $bPrompt=true)
 
 getEditorSettings ()
 
 getAdditionalClass (string $basename="settings", string $classname="")
 

Static Public Member Functions

static getInstance ()
 
static saveLastEditSection (int $iSectionID=0)
 
static getConstants ()
 

Data Fields

const NOT_SET_IN_INFO = "(unknown - not set in info.php)"
 
array $language = []
 
array $parents = []
 
string $module_directory = ""
 
string $module_name = ""
 
string $module_function = ""
 
string $module_version = ""
 
string $module_platform = ""
 
int $module_delete = 1
 
string $module_author = ""
 
string $module_license = ""
 
string $module_license_terms = ""
 
string $module_description = ""
 
string $module_guid = ""
 
string $module_home = ""
 

Static Public Attributes

static $instance
 

Protected Member Functions

 getParents ()
 
 getModuleInfo ()
 
 getLanguageFile ()
 
 getMainClassNames ( $sAnyClassname)
 
 initialize ()
 

Detailed Description

This file is part of LEPTON Core, released under the GNU GPL Please see LICENSE and COPYING files in your package for details, specially for terms and warranties.

NOTICE:LEPTON CMS Package has several different licenses. Please see the individual license in the header of each single file or info.php of modules and templates.

Author
LEPTON Project
Copyright
2010-2023 LEPTON Project https://gnu.org/licenses/gpl.html please see LICENSE and COPYING files in your package This is only an abstract class for LEPTON specific classes and inside modules.

Definition at line 24 of file lepton_abstract.php.

Member Function Documentation

◆ getAdditionalClass()

getAdditionalClass ( string  $basename = "settings",
string  $classname = "" 
)

[7.2] L* V.5: like [7.1] but more flexible. Useful to get information from other classes/modules out of this context.

Since
5.5.0
Parameters
string$basenameDefault is "settings".
string$classnameDefault is "" - looking for the parent of this instance.
Returns
mixed Instance of the (custom-) class, or NULL if none found.

Definition at line 533 of file lepton_abstract.php.

◆ getConstants()

static getConstants ( )
static

Definition at line 359 of file lepton_abstract.php.

◆ getEditorSettings()

getEditorSettings ( )

[7.1] L* V.5: additional custom-classes Try to get an instance from a "setting"-class or the "settings_custom" of the parent.

Since
5.5.0
Returns
mixed Instance of the (custom-) class, or NULL if none found.

Definition at line 502 of file lepton_abstract.php.

◆ getHeadInfo()

getHeadInfo ( )

Needed for modules like e.g. "news", "topics", "bakery", "forum", "xDisplay". To be overwritten by the module(-child) itself.

Returns
array Assoc array with at last three keys for (additional) "title","description" and "keywords"

Definition at line 296 of file lepton_abstract.php.

◆ getInstance()

static getInstance ( )
static

Return the instance of this class.

Definition at line 141 of file lepton_abstract.php.

◆ getLanguageFile()

getLanguageFile ( )
protected

Try to get a module-specific language file.

Definition at line 231 of file lepton_abstract.php.

◆ getMainClassNames()

getMainClassNames (   $sAnyClassname)
protected

Private function to "handle" sub_class-names

Definition at line 309 of file lepton_abstract.php.

◆ getModuleInfo()

getModuleInfo ( )
protected

Try to read the module specific info.php from the module-Directory and update the current class-properties.

Definition at line 175 of file lepton_abstract.php.

◆ getParents()

getParents ( )
protected

Try to get all parents form the current instance as a simple linear list.

Definition at line 157 of file lepton_abstract.php.

◆ initialize()

initialize ( )
abstractprotected

Abstract declarations - to be overwritten by the child-instance.

Reimplemented in LEPTON_request, and LEPTON_secure.

◆ saveLastEditSection()

static saveLastEditSection ( int  $iSectionID = 0)
static

Public function to "store" a given section_id into the $_SESSION (superglobal).

Parameters
int$iSectionIDA valid section_id. If not given or NULL parsed, the last global "section_id" is used!.
Returns
void
$this->saveLastEditSection( $section_id);
// or looking into global scope.
$this->saveLastEditSection();
// or static
LEPTON_abstract::saveLastEditSection();
LEPTON_abstract\saveLastEditSection
static saveLastEditSection(int $iSectionID=0)
Definition lepton_abstract.php:346

Definition at line 346 of file lepton_abstract.php.

◆ showmodinfo()

showmodinfo ( array  $modvalues = [],
bool  $bPrompt = true 
)

Show the module info

@access public

Parameters
array$modvaluesAs optional array containing module specialized values
bool$bPromptTrue for direct output via echo, false for returning the generated source.
Returns
mixed Depending on the $bPrompt param: boolean or string.

Definition at line 379 of file lepton_abstract.php.

Field Documentation

◆ $instance

$instance
static

Definition at line 135 of file lepton_abstract.php.

◆ $language

array $language = []

Array with the language(-array) of the child-object. @type array

Definition at line 38 of file lepton_abstract.php.

◆ $module_author

string $module_author = ""

The module author from the info.php of the child. @type string

Definition at line 94 of file lepton_abstract.php.

◆ $module_delete

int $module_delete = 1

The module delete from the info.php of the child. @type boolean

Definition at line 87 of file lepton_abstract.php.

◆ $module_description

string $module_description = ""

The module description from the info.php of the child. @type string

Definition at line 115 of file lepton_abstract.php.

◆ $module_directory

string $module_directory = ""

The module directory from the info.php of the child. @type string

Definition at line 52 of file lepton_abstract.php.

◆ $module_function

string $module_function = ""

The module function from the info.php of the child. @type string

Definition at line 66 of file lepton_abstract.php.

◆ $module_guid

string $module_guid = ""

The module guid from the info.php of the child. @type string

Definition at line 122 of file lepton_abstract.php.

◆ $module_home

string $module_home = ""

The module home from the info.php of the child. @type string

Definition at line 129 of file lepton_abstract.php.

◆ $module_license

string $module_license = ""

The module license from the info.php of the child. @type string

Definition at line 101 of file lepton_abstract.php.

◆ $module_license_terms

string $module_license_terms = ""

The module license terms from the info.php of the child. @type string

Definition at line 108 of file lepton_abstract.php.

◆ $module_name

string $module_name = ""

The module name from the info.php of the child. @type string

Definition at line 59 of file lepton_abstract.php.

◆ $module_platform

string $module_platform = ""

The module platform from the info.php of the child. @type string

Definition at line 80 of file lepton_abstract.php.

◆ $module_version

string $module_version = ""

The module version from the info.php of the child. @type string

Definition at line 73 of file lepton_abstract.php.

◆ $parents

array $parents = []

Array with the names of all parents (desc. order) @type array

Definition at line 45 of file lepton_abstract.php.

◆ NOT_SET_IN_INFO

const NOT_SET_IN_INFO = "(unknown - not set in info.php)"

Default string if a value is not set in the info.php of the module. @type string

Definition at line 31 of file lepton_abstract.php.

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