Scriptlog Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== MediaController ======

**Layer:** ''Controller'' &middot; **Source:** ''lib/controller/MediaController.php:27'' (lines 27–635)

----
<code>
class MediaController extends BaseApp
</code>

======= Docblock Metadata =======

^ Tag ^ Value ^
| ''@category'' | Class MediaController extends BaseApp |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

======= Inheritance =======

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface |

======= Constants (1) =======

^ Visibility ^ Name ^ Value ^ Line ^
| ''-'' | ''TIME_BEFORE_EXPIRED'' | ''8;'' | 45 |

======= Properties (2) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$view'' |  | 35 |
| ''private'' | ''(untyped)'' | ''$mediaService'' |  | 43 |

======= Methods (15) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | Initialize object properties | 53 |
| public | ''listItems()'' | Retrieve all media items | 65 |
| public | ''insert()'' | abstract method insert | 119 |
| private | ''validateMediaUpload()'' | (undocumented) | 182 |
| private | ''buildMediaMetadata()'' | (undocumented) | 246 |
| private | ''saveMediaRecord()'' | (undocumented) | 269 |
| private | ''renderUploadForm()'' | (undocumented) | 297 |
| public | ''update()'' | update | 325 |
| private | ''validateMediaEdit()'' | (undocumented) | 415 |
| private | ''handleMediaFileUpdate()'' |  | 441 |
| private | ''updateMediaWithFile()'' | (undocumented) | 503 |
| private | ''updateMediaMetaOnly()'' | (undocumented) | 526 |
| private | ''renderEditForm()'' | (undocumented) | 535 |
| public | ''remove()'' | Abstract method remove | 566 |
| protected | ''setView()'' | setView | 631 |


======== __construct() ========

<code>
public function __construct(MediaService $mediaService)
</code>

//lines 53–56 (4)//

Initialize object properties

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$mediaService'' |  [[scriptlog:lib:service:mediaservice|''MediaService'']] |  //required// |  //none// |


======== listItems() ========

<code>
public function listItems()
</code>

//lines 65–110 (46)//

Retrieve all media items

//Takes no parameters.//

**Returns:** ''(none declared)''


======== insert() ========

<code>
public function insert()
</code>

//lines 119–180 (62)//

Documentation inherited from [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']].

abstract method insert

//Takes no parameters.//

**Returns:** ''(none declared)''


======== validateMediaUpload() ========

<code>
private function validateMediaUpload($file_location, $file_error, $file_size, $filters, $form_fields, &amp;$errors, $checkError)
</code>

//lines 182–244 (63)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$file_location'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_error'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_size'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$form_fields'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$errors (by reference)'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$checkError'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== buildMediaMetadata() ========

<code>
private function buildMediaMetadata($file_extension, $file_name, $file_type, $file_size, $file_location)
</code>

//lines 246–267 (22)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$file_extension'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_name'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_type'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_size'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_location'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== saveMediaRecord() ========

<code>
private function saveMediaRecord($new_filename, $file_type, $filters, $media_metavalue)
</code>

//lines 269–295 (27)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$new_filename'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_type'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$media_metavalue'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== renderUploadForm() ========

<code>
private function renderUploadForm($errors = array(), $formData = null)
</code>

//lines 297–315 (19)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$errors'' |  ''(untyped)'' |  ''array()'' |  //none// |
|  ''$formData'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)''


======== update() ========

<code>
public function update($id)
</code>

//lines 325–413 (89)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== validateMediaEdit() ========

<code>
private function validateMediaEdit($filters, $form_fields, &amp;$errors, $checkError)
</code>

//lines 415–438 (24)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$form_fields'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$errors (by reference)'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$checkError'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== handleMediaFileUpdate() ========

<code>
private function handleMediaFileUpdate($file_location, $file_error, $file_size, $file_name, $file_type, $file_extension, $new_filename, $filters, &amp;$errors, $checkError)
</code>

//lines 441–501 (61)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$file_location'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_error'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_size'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_name'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_type'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_extension'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$new_filename'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$errors (by reference)'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$checkError'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== updateMediaWithFile() ========

<code>
private function updateMediaWithFile($new_filename, $file_type, $filters, $media_metavalue)
</code>

//lines 503–524 (22)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$new_filename'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$file_type'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$media_metavalue'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== updateMediaMetaOnly() ========

<code>
private function updateMediaMetaOnly($filters)
</code>

//lines 526–533 (8)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$filters'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== renderEditForm() ========

<code>
private function renderEditForm($errors = null, $data_media = null, $media_properties = null, $getMedia = null)
</code>

//lines 535–556 (22)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$errors'' |  ''(untyped)'' |  ''null'' |  //none// |
|  ''$data_media'' |  ''(untyped)'' |  ''null'' |  //none// |
|  ''$media_properties'' |  ''(untyped)'' |  ''null'' |  //none// |
|  ''$getMedia'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)''


======== remove() ========

<code>
public function remove($id)
</code>

//lines 566–623 (58)//

Documentation inherited from [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']].

Abstract method remove

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setView() ========

<code>
protected function setView($viewName)
</code>

//lines 631–634 (4)//

setView

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$viewName'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''

======= Imports =======

^ Alias ^ Fully-qualified name ^
| ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] |
| ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] |
| ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] |
| ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] |
| ''MediaService'' | [[scriptlog:lib:service:mediaservice|''Scriptlog\Service\MediaService'']] |


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//