MLTextItem Class Reference

Text item of Module Library item. More...

Inheritance diagram for MLTextItem:

Public Member Functions
	__construct ($name, $folder, $path, $default='')
	initialise ()
	get ($_libObjId)
	save ($_libObjId, $_libName='Generic Content')
	delete ()
	reset ()
	install ()
	uninstall ()
	get_fromHeader ($prefix='')
	get_exportedValue ()
Public Member Functions inherited from ModuleLibraryItem
	get_fromArray ($data)
	get_valueFromHeader ($name)
	get_dateFromHeader ($name)
	parse_PHPTags ($value)

Public Attributes
	$folder
	Folder repository for files. More...
	$path
	Folder path for files. More...
Public Attributes inherited from ModuleLibraryItem
	$name
	Item name. More...
	$default
	Item default value. More...
	$value
	Item current value. More...
	$type
	Item type. More...
	$datadesc
	Item data description. More...
	$datadesc2
	Item data description. More...

Additional Inherited Members
Protected Member Functions inherited from ModuleLibraryItem
	compile_listValue ($value)
	uncompile_listValue ($value)

Detailed Description

Text item of Module Library item.

Engine / Object Library

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.0.1

Date

Creation: Apr 2007

Modification: Jul 2025

Copyright

2007 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. MLTextItem class.

Constructor & Destructor Documentation

__construct()

MLTextItem::__construct	(		$name,
			$folder,
			$path,
			$default = ''
	)

Class constructor.

Parameters

string	$name
string	$folder
string	$path
string	$default

Reimplemented in MLTextLocalizedItem.

Member Function Documentation

initialise()

MLTextItem::initialise

(

)

Initialise object with default value.

Returns

void

Reimplemented in MLTextLocalizedItem.

get()

MLTextItem::get

(

$_libObjId

)

Load object value, the text file path

Parameters

integer

$_libObjId

the parent object id

Returns

boolean

save()

MLTextItem::save	(		$_libObjId,
			$_libName = 'Generic Content'
	)

Save text as file.

Parameters

integer	$_libObjId	the parent object id
string	$_libName	the file header title

Returns

boolean

Reimplemented in MLTextLocalizedItem.

delete()

MLTextItem::delete

(

)

Delete text file.

Returns

boolean

reset()

MLTextItem::reset

(

)

Delete files folder and its content.

Returns

boolean

install()

MLTextItem::install

(

)

Install object

Returns

boolean

uninstall()

MLTextItem::uninstall

(

)

Uninstall object library.

Returns

boolean

get_fromHeader()

MLTextItem::get_fromHeader

(

$prefix = ''

)

Load object value from header.

Parameters

string

$prefix

Returns

void

Reimplemented in MLTextLocalizedItem.

get_exportedValue()

MLTextItem::get_exportedValue

(

)

Return values as structured array $name => $value.

Returns

array

Reimplemented in MLTextLocalizedItem.

Member Data Documentation

$folder

string MLTextItem::$folder

Folder repository for files.

$path

string MLTextItem::$path

Folder path for files.

---

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

• CaMykS/engine/lib/object/MLTextItem.php.inc