Layer: Service · Source: lib/service/MediaService.php:23 (lines 23–611)

class MediaService

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

No parent, interface or trait. This is a root type.

None.

None declared.

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | Initialize an intanciates of class properties or method | 166 |
| public | ''setMediaId()'' | set media id | 181 |
| public | ''setMediaFilename()'' | set media filename | 192 |
| public | ''setMediaCaption()'' | set media caption | 203 |
| public | ''setMediaType()'' | Set media type | 214 |
| public | ''setMediaTarget()'' | Set media target | 225 |
| public | ''setMediaUser()'' | Set media user | 236 |
| public | ''setMediaAccess()'' | Set media access | 247 |
| public | ''setMediaStatus()'' | Set media status | 258 |
| public | ''setMediaKey()'' | Set media metadata key | 269 |
| public | ''setMediaValue()'' | Set media metadata value | 280 |
| public | ''setMediaIdentifier()'' | setMediaIdentifier | 291 |
| public | ''setBeforeExpired()'' | setBeforeExpired | 302 |
| public | ''setIpAddress()'' | setIpAddress | 313 |
| public | ''grabAllMedia()'' | Grab all media | 325 |
| public | ''grabMedia()'' | GrabMedia | 339 |
| public | ''grabMediaMeta()'' | Grab media meta | 352 |
| public | ''addMedia()'' | Add media | 364 |
| public | ''addMediaMeta()'' | AddMediaMeta() | 386 |
| public | ''addMediaDownload()'' | addMediaDownload | 403 |
| public | ''modifyMedia()'' | Updating media record | 422 |
| public | ''modifyMediaMeta()'' | ModifyMetaMedia() | 453 |
| public | ''modifyMediaDownload()'' | modifyMediaDownload | 469 |
| public | ''removeMedia()'' | Removes media record | 485 |
| public | ''mediaTargetDropDown()'' | Drop down media target | 558 |
| public | ''mediaAccessDropDown()'' | Drop down media access | 570 |
| public | ''mediaStatusDropDown()'' | Drop down media status | 582 |
| public | ''isMediaUser()'' | isMediaUser | 595 |
| public | ''totalMedia()'' | Total media libray on database record | 607 |

public function __construct(MediaDao $mediaDao, DownloadModel $downloadModel, FormValidator $validator, Sanitize $sanitizer)

lines 166–173 (8)

Initialize an intanciates of class properties or method

^ Parameter ^ Type ^ Default ^ Description ^
| ''$mediaDao'' | [[scriptlog:lib:dao:mediadao|''MediaDao'']] | //required// | //none// |
| ''$downloadModel'' | [[scriptlog:lib:model:downloadmodel|''DownloadModel'']] | //required// | //none// |
| ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// |
| ''$sanitizer'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// |

public function setMediaId($mediaId)

lines 181–184 (4)

set media id

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

Returns: (none declared)

public function setMediaFilename($filename)

lines 192–195 (4)

set media filename

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

Returns: (none declared)

public function setMediaCaption($caption)

lines 203–206 (4)

set media caption

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

Returns: (none declared)

public function setMediaType($type)

lines 214–217 (4)

Set media type

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

Returns: (none declared)

public function setMediaTarget($target)

lines 225–228 (4)

Set media target

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

Returns: (none declared)

public function setMediaUser($user)

lines 236–239 (4)

Set media user

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

Returns: (none declared)

public function setMediaAccess($access)

lines 247–250 (4)

Set media access

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

Returns: (none declared)

public function setMediaStatus($status)

lines 258–261 (4)

Set media status

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

Returns: (none declared)

public function setMediaKey($meta_key)

lines 269–272 (4)

Set media metadata key

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

Returns: (none declared)

public function setMediaValue($value)

lines 280–283 (4)

Set media metadata value

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

Returns: (none declared)

public function setMediaIdentifier($media_identifier)

lines 291–294 (4)

setMediaIdentifier

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

Returns: (none declared)

public function setBeforeExpired($before_expired)

lines 302–305 (4)

setBeforeExpired

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

Returns: (none declared)

public function setIpAddress($ip_address)

lines 313–316 (4)

setIpAddress

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

Returns: (none declared)

public function grabAllMedia($orderBy = 'ID', $user_level = null)

lines 325–329 (5)

Grab all media

retrieve all media records

^ Parameter ^ Type ^ Default ^ Description ^
| ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// |
| ''$user_level'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared)

public function grabMedia($id)

lines 339–342 (4)

GrabMedia

retrieve a single record of media

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

Returns: (none declared) — mixed

public function grabMediaMeta($id, $filename)

lines 352–355 (4)

Grab media meta

retrieve a single record of media properties(meta)

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

Returns: (none declared) — mixed

public function addMedia()

lines 364–380 (17)

Add media

create new media record

Takes no parameters.

Returns: (none declared) — mixed

public function addMediaMeta()

lines 386–397 (12)

AddMediaMeta()

Takes no parameters.

Returns: (none declared)

public function addMediaDownload()

lines 403–414 (12)

addMediaDownload

Takes no parameters.

Returns: (none declared)

public function modifyMedia()

lines 422–445 (24)

Updating media record

Takes no parameters.

Returns: (none declared) — object

public function modifyMediaMeta()

lines 453–463 (11)

ModifyMetaMedia()

Takes no parameters.

Returns: (none declared) — void

public function modifyMediaDownload()

lines 469–478 (10)

modifyMediaDownload

Takes no parameters.

Returns: (none declared)

public function removeMedia()

lines 485–549 (65)

Removes media record

if there is a file inside media directory, delete it

Takes no parameters.

Returns: (none declared)

public function mediaTargetDropDown($selected = "")

lines 558–561 (4)

Drop down media target

^ Parameter ^ Type ^ Default ^ Description ^
| ''$selected'' | ''(untyped)'' | ''""'' | //none// |

Returns: (none declared) — string

public function mediaAccessDropDown($selected = "")

lines 570–573 (4)

Drop down media access

^ Parameter ^ Type ^ Default ^ Description ^
| ''$selected'' | ''(untyped)'' | ''""'' | //none// |

Returns: (none declared) — string

public function mediaStatusDropDown($selected = "")

lines 582–585 (4)

Drop down media status

^ Parameter ^ Type ^ Default ^ Description ^
| ''$selected'' | ''(untyped)'' | ''""'' | //none// |

Returns: (none declared) — string

public function isMediaUser()

lines 595–598 (4)

isMediaUser

Checking if user's session level available then return it

Takes no parameters.

Returns: (none declared) — string

public function totalMedia(array $data = [])

lines 607–610 (4)

Total media libray on database record

^ Parameter ^ Type ^ Default ^ Description ^
| ''$data'' | ''array'' | ''[]'' | default value = null |

Returns: (none declared) — integer|number

^ Alias ^ Fully-qualified name ^
| ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''MediaDao'' | [[scriptlog:lib:dao:mediadao|''Scriptlog\Dao\MediaDao'']] |
| ''DownloadModel'' | [[scriptlog:lib:model:downloadmodel|''Scriptlog\Model\DownloadModel'']] |

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