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

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

Protected Member Functions

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

Detailed Description

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

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

Class constructor.

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

Member Function Documentation

MLFileItem::delete (   $_libObjId)

Delete file.

Parameters
integer$_libObjIdthe parent object id
Returns
boolean
MLFileItem::exists (   $path,
  $filebase 
)

Return item file existence.

Parameters
string$paththe folder path
string$filebasethe file name base
Returns
string
MLFileItem::get (   $_libObjId)

Load object value.

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

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

Returns
array
MLFileItem::get_folder (   $_libObjId = 0)

Return updated folder with parent id.

Parameters
integer$_libObjId
Returns
string
MLFileItem::get_fromHeader (   $prefix = '')

Load object value from header.

Parameters
string$prefix
Returns
void
MLFileItem::get_temporaryFileName ( )

Return temporary file name while uploading it

Returns
string
MLFileItem::get_uploadedFileName ( )

Return real file name while uploading it.

Returns
string
MLFileItem::initialise ( )

Initialise object with empty value.

Returns
void
MLFileItem::install ( )

Install item by creating folders.

Returns
boolean
MLFileItem::reset ( )

Reset file folder by deleting all files.

Returns
boolean
MLFileItem::save (   $_libObjId)

Save file item.

Parameters
integer$_libObjIdthe parent object id
Returns
boolean
MLFileItem::uninstall ( )

Uninstall item.

Returns
boolean
MLFileItem::update_orientation (   $picture = '')
protected

Check orientation and auto rotate picture.

Parameters
string$picture
Returns
boolean sucess

Member Data Documentation

boolean MLFileItem::$delete = false

Is file in delete process.

string MLFileItem::$folder

Folder repository for files.

string MLFileItem::$path

Folder path for files.

boolean MLFileItem::$upload = false

Is file in upload process.

string MLFileItem::$uploadedFileName = ''

File original name.

string MLFileItem::$uploadedTempName = ''

File temporary name.

string MLFileItem::$url

Folder url for files.


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