CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
MLTextItem Class Reference
Inheritance diagram for MLTextItem:
Inheritance graph
[legend]
Collaboration diagram for MLTextItem:
Collaboration graph
[legend]

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...
 

Additional Inherited Members

- Protected Member Functions inherited from ModuleLibraryItem
 compile_listValue ($value)
 
 uncompile_listValue ($value)
 

Detailed Description

MLTextItem class.

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

Constructor & Destructor Documentation

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

Class constructor.

Parameters
string$name
string$folder
string$path
string$default
Returns
void

Member Function Documentation

MLTextItem::delete ( )

Delete text file.

Returns
boolean
MLTextItem::get (   $_libObjId)

Load object value, the text file path

Parameters
integer$_libObjIdthe parent object id
Returns
boolean
MLTextItem::get_exportedValue ( )

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

Returns
array
MLTextItem::get_fromHeader (   $prefix = '')

Load object value from header.

Parameters
string$prefix
Returns
void
MLTextItem::initialise ( )

Initialise object with default value.

Returns
void
MLTextItem::install ( )

Install object

Returns
boolean
MLTextItem::reset ( )

Delete files folder and its content.

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

Save text as file.

Parameters
integer$_libObjIdthe parent object id
string$_libNamethe file header title
Returns
boolean
MLTextItem::uninstall ( )

Uninstall object library.

Returns
boolean

Member Data Documentation

string MLTextItem::$folder

Folder repository for files.

string MLTextItem::$path

Folder path for files.


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