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

**Layer:** ''Controller'' &middot; **Source:** ''lib/controller/api/MediaApiController.php:14'' (lines 14–181)

----
<code>
final class MediaApiController extends ApiController
</code>

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

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:controller:apicontroller|''ApiController'']] | parent class/interface |

======= Constants (0) =======

//None.//

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

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$mediaDao'' |  | 19 |
| ''private'' | ''(untyped)'' | ''$userDao'' |  | 24 |

======= Methods (3) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | Constructor | 35 |
| public | ''upload()'' | Upload image for Summernote | 48 |
| private | ''authenticateAdminSession()'' | Authenticate via admin session or auth cookie | 144 |


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

<code>
public function __construct(?MediaDao $mediaDao = null, ?UserDao $userDao = null)
</code>

//lines 35–41 (7)//

Constructor

All dependencies are optional so ApiRouter can keep building this
controller with no arguments; tests pass mocks instead.

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$mediaDao'' |  [[scriptlog:lib:dao:mediadao|''?MediaDao'']] |  ''null'' |  Data access for media records |
|  ''$userDao'' |  [[scriptlog:lib:dao:userdao|''?UserDao'']] |  ''null'' |  Data access for user lookups |


======== upload() ========

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

//lines 48–134 (87)//

Upload image for Summernote

POST /api/v1/media/upload

//Takes no parameters.//

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


======== authenticateAdminSession() ========

<code>
private function authenticateAdminSession()
</code>

//lines 144–180 (37)//

Authenticate via admin session or auth cookie

Sets ApiAuth state on success so that ApiAuth::getUser()
and related methods work consistently.

//Takes no parameters.//

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

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

^ Alias ^ Fully-qualified name ^
| ''ApiController'' | [[scriptlog:lib:controller:apicontroller|''Scriptlog\Controller\ApiController'']] |
| ''ApiAuth'' | [[scriptlog:lib:core:apiauth|''Scriptlog\Core\ApiAuth'']] |
| ''ApiResponse'' | [[scriptlog:lib:core:apiresponse|''Scriptlog\Core\ApiResponse'']] |
| ''ScriptlogCryptonize'' | [[scriptlog:lib:core:scriptlogcryptonize|''Scriptlog\Core\ScriptlogCryptonize'']] |
| ''MediaDao'' | [[scriptlog:lib:dao:mediadao|''Scriptlog\Dao\MediaDao'']] |
| ''UserDao'' | [[scriptlog:lib:dao:userdao|''Scriptlog\Dao\UserDao'']] |


----

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