MLFileItem Class Reference

File item of Module Library Item. More...

Inheritance diagram for MLFileItem:

Public Member Functions
	__construct ($name, $folder, $path, $url)
	initialise ()
	get ($_libObjId)
	save ($_libObjId)
	delete ($_libObjId)
	reset ()
	install ()
	uninstall ()
	get_fromHeader ($prefix='')
	get_exportedValue ()
	exists ($path, $filebase)
	get_uploadedFileName ()
	get_temporaryFileName ()
	get_folder ($_libObjId=0)
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...
	$url
	Folder url for files. More...
	$upload = false
	Is file in upload process. More...
	$uploadedFileName = ''
	File original name. More...
	$uploadedTempName = ''
	File temporary name. More...
	$delete = false
	Is file in delete process. 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...

Protected Member Functions
	update_orientation ($picture='')
Protected Member Functions inherited from ModuleLibraryItem
	compile_listValue ($value)
	uncompile_listValue ($value)

Detailed Description

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

Date

Creation: Jul 2007

Modification: Sep 2023

Copyright

2007 - 2023 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. MLFileItem 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

__construct()

MLFileItem::__construct	(		$name,
			$folder,
			$path,
			$url
	)

Class constructor.

Parameters

string	$name
string	$folder
string	$path
string	$url

Returns

void

Reimplemented in MLFileLocalizedItem.

Member Function Documentation

initialise()

MLFileItem::initialise

(

)

Initialise object with empty value.

Returns

void

Reimplemented in MLFileLocalizedItem.

get()

MLFileItem::get

(

$_libObjId

)

Load object value.

Parameters

integer

$_libObjId

the parent object id

Returns

boolean

save()

MLFileItem::save

(

$_libObjId

)

Save file item.

Parameters

integer

$_libObjId

the parent object id

Returns

boolean

Reimplemented in MLFileLocalizedItem.

delete()

MLFileItem::delete

(

$_libObjId

)

Delete file.

Parameters

integer

$_libObjId

the parent object id

Returns

boolean

reset()

MLFileItem::reset

(

)

Reset file folder by deleting all files.

Returns

boolean

install()

MLFileItem::install

(

)

Install item by creating folders.

Returns

boolean

uninstall()

MLFileItem::uninstall

(

)

Uninstall item.

Returns

boolean

get_fromHeader()

MLFileItem::get_fromHeader

(

$prefix = ''

)

Load object value from header.

Parameters

string

$prefix

Returns

void

Reimplemented in MLFileLocalizedItem.

get_exportedValue()

MLFileItem::get_exportedValue

(

)

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

Returns

array

Reimplemented in MLFileLocalizedItem.

exists()

MLFileItem::exists	(		$path,
			$filebase
	)

Return item file existence.

Parameters

string	$path	the folder path
string	$filebase	the file name base

Returns

string

get_uploadedFileName()

MLFileItem::get_uploadedFileName

(

)

Return real file name while uploading it.

Returns

string

get_temporaryFileName()

MLFileItem::get_temporaryFileName

(

)

Return temporary file name while uploading it

Returns

string

get_folder()

MLFileItem::get_folder

(

$_libObjId = 0

)

Return updated folder with parent id.

Parameters

integer

$_libObjId

Returns

string

update_orientation()

MLFileItem::update_orientation (   $picture = '' )

protected

Check orientation and auto rotate picture.

Parameters

string

$picture

Returns

boolean sucess

Member Data Documentation

$folder

string MLFileItem::$folder

Folder repository for files.

$path

string MLFileItem::$path

Folder path for files.

$url

string MLFileItem::$url

Folder url for files.

$upload

boolean MLFileItem::$upload = false

Is file in upload process.

$uploadedFileName

string MLFileItem::$uploadedFileName = ''

File original name.

$uploadedTempName

string MLFileItem::$uploadedTempName = ''

File temporary name.

$delete

boolean MLFileItem::$delete = false

Is file in delete process.

---

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

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