Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:model:archivesmodel

This is an old revision of the document!


ArchivesModel

Layer: Model · Source: lib/model/ArchivesModel.php:21 (lines 21–147)


class ArchivesModel extends BaseModel

Docblock Metadata

^ Tag ^ Value ^
| ''@category'' | Model class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |

Inheritance

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

Constants (0)

None.

Properties (0)

None declared.

Methods (4)

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''getArchivesOnSidebar()'' | getArchivesOnSidebar | 39 |
| public | ''getArchiveIndex()'' | getArchiveIndex | 64 |
| public | ''getPostsByArchive()'' | getPostsByArchive | 97 |
| private | ''totalPostsByArchives()'' | totalPostsByArchives | 141 |

getArchivesOnSidebar()

public function getArchivesOnSidebar()

lines 39–55 (17)

getArchivesOnSidebar

retrieves archives of posts by month and year and list it on sidebar

Takes no parameters.

Returns: (none declared) — mixed

getArchiveIndex()

public function getArchiveIndex()

lines 64–80 (17)

getArchiveIndex

retrieves all archives with post counts for index page

Takes no parameters.

Returns: (none declared) — mixed

getPostsByArchive()

public function getPostsByArchive(Paginator $perPage, Sanitize $sanitize, $values)

lines 97–135 (39)

getPostsByArchive

^ Parameter ^ Type ^ Default ^ Description ^
| ''$perPage'' | [[scriptlog:lib:core:paginator|''Paginator'']] | //required// | //none// |
| ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// |
| ''$values'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — mixed

totalPostsByArchives()

private function totalPostsByArchives($data)

lines 141–146 (6)

totalPostsByArchives

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

Returns: (none declared)

Imports

^ Alias ^ Fully-qualified name ^
| ''BaseModel'' | [[scriptlog:lib:core:basemodel|''Scriptlog\Core\BaseModel'']] |
| ''Paginator'' | [[scriptlog:lib:core:paginator|''Scriptlog\Core\Paginator'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |

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

scriptlog/lib/model/archivesmodel.1790413761.txt.gz · Last modified: by admin