====== ArchivesApiController ======

**Layer:** ''Controller'' · **Source:** ''lib/controller/api/ArchivesApiController.php:29'' (lines 29–265)

----
<code>
class ArchivesApiController extends ApiController
</code>

Archives API Controller

Handles API requests for post archives (by date)

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

^ Tag ^ Value ^
| ''@category'' | Controller Class |
| ''@author'' | Blogware Team |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

======= 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)'' | ''$hateoas'' |  | 34 |
| ''private'' | ''(untyped)'' | ''$postService'' |  | 39 |

======= Methods (5) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | Constructor | 44 |
| public | ''index()'' | Get list of available archive dates (public endpoint) | 63 |
| public | ''year()'' | Get posts from a specific year (public endpoint) | 115 |
| public | ''month()'' | Get posts from a specific month (public endpoint) | 177 |
| private | ''getMonthName()'' | Get month name | 246 |


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

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

//lines 44–51 (8)//

Constructor

//Takes no parameters.//


======== index() ========

<code>
public function index($_params = [])
</code>

//lines 63–105 (43)//

Get list of available archive dates (public endpoint)

GET /api/v1/archives

Returns a list of years and months that have published posts

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$_params'' |  ''(untyped)'' |  ''[]'' |  //none// |

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


======== year() ========

<code>
public function year($params = [])
</code>

//lines 115–167 (53)//

Get posts from a specific year (public endpoint)

GET /api/v1/archives/{year}

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$params'' |  ''(untyped)'' |  ''[]'' |  Route parameters including 'year' |

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


======== month() ========

<code>
public function month($params = [])
</code>

//lines 177–238 (62)//

Get posts from a specific month (public endpoint)

GET /api/v1/archives/{year}/{month}

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$params'' |  ''(untyped)'' |  ''[]'' |  Route parameters including 'year' and 'month' |

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


======== getMonthName() ========

<code>
private function getMonthName($month)
</code>

//lines 246–264 (19)//

Get month name

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

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

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

^ Alias ^ Fully-qualified name ^
| ''ApiController'' | [[scriptlog:lib:controller:apicontroller|''Scriptlog\Controller\ApiController'']] |
| ''ApiHateoas'' | [[scriptlog:lib:core:apihateoas|''Scriptlog\Core\ApiHateoas'']] |
| ''ApiResponse'' | [[scriptlog:lib:core:apiresponse|''Scriptlog\Core\ApiResponse'']] |
| ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''PostDao'' | [[scriptlog:lib:dao:postdao|''Scriptlog\Dao\PostDao'']] |
| ''PostApiDto'' | [[scriptlog:lib:dto:postapidto|''Scriptlog\Dto\Api\PostApiDto'']] |
| ''PostService'' | [[scriptlog:lib:service:postservice|''Scriptlog\Service\PostService'']] |


----

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