Layer: Controller · Source: lib/controller/MediaController.php:27 (lines 27–635)

class MediaController extends BaseApp

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

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

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

None declared.

^ 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()'' | @SuppressWarnings(PHPMD.ExcessiveParameterList) | 441 |
| private | ''updateMediaWithFile()'' | (undocumented) | 503 |
| private | ''updateMediaMetaOnly()'' | (undocumented) | 526 |
| private | ''renderEditForm()'' | (undocumented) | 535 |
| public | ''remove()'' | Abstract method remove | 566 |
| protected | ''setView()'' | setView | 631 |

public function __construct(MediaService $mediaService)

lines 53–56 (4)

Initialize object properties

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

public function listItems()

lines 65–110 (46)

Retrieve all media items

Takes no parameters.

Returns: (none declared)

public function insert()

lines 119–180 (62)

Documentation inherited from ''Scriptlog\Core\BaseApp''.

abstract method insert

Takes no parameters.

Returns: (none declared)

private function validateMediaUpload($file_location, $file_error, $file_size, $filters, $form_fields, &$errors, $checkError)

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)

private function buildMediaMetadata($file_extension, $file_name, $file_type, $file_size, $file_location)

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)

private function saveMediaRecord($new_filename, $file_type, $filters, $media_metavalue)

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)

private function renderUploadForm($errors = array(), $formData = null)

lines 297–315 (19)

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

Returns: (none declared)

public function update($id)

lines 325–413 (89)

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

Returns: (none declared)

private function validateMediaEdit($filters, $form_fields, &$errors, $checkError)

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)

private function handleMediaFileUpdate($file_location, $file_error, $file_size, $file_name, $file_type, $file_extension, $new_filename, $filters, &$errors, $checkError)

lines 441–501 (61)

@SuppressWarnings(PHPMD.ExcessiveParameterList)

^ 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)

private function updateMediaWithFile($new_filename, $file_type, $filters, $media_metavalue)

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)

private function updateMediaMetaOnly($filters)

lines 526–533 (8)

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

Returns: (none declared)

private function renderEditForm($errors = null, $data_media = null, $media_properties = null, $getMedia = null)

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)

public function remove($id)

lines 566–623 (58)

Documentation inherited from ''Scriptlog\Core\BaseApp''.

Abstract method remove

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

Returns: (none declared)

protected function setView($viewName)

lines 631–634 (4)

setView

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

Returns: (none declared)

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