Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:dao:pagedao

This is an old revision of the document!


PageDao

Layer: DAO · Source: lib/dao/PageDao.php:21 (lines 21–291)


class PageDao extends Dao

Page class extends Dao

Docblock Metadata

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

Inheritance

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

Constants (0)

None.

Properties (0)

None declared.

Methods (11)

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 23 |
| public | ''findPages()'' | Find pages | 35 |
| public | ''findPageById()'' | Find page by id | 99 |
| public | ''createPage()'' | createPage() | 135 |
| public | ''updatePage()'' | UpdatePage | 173 |
| public | ''deletePage()'' | deletePage | 211 |
| public | ''checkPageId()'' | Check page id | 228 |
| public | ''dropDownPostStatus()'' | Set post status | 243 |
| public | ''dropDownCommentStatus()'' | Set comment status | 257 |
| public | ''totalPageRecords()'' | Total page records | 271 |
| public | ''dropDownLocale()'' | Drop down locale | 287 |

__construct()

public function __construct()

lines 23–26 (4)

Takes no parameters.

findPages()

public function findPages($type, $orderBy = 'ID', $author = null)

lines 35–90 (56)

Find pages

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

Returns: (none declared) — boolean|array|object

findPageById()

public function findPageById($ID, $sanitize)

lines 99–125 (27)

Find page by id

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

Returns: (none declared) — boolean|array|object

createPage()

public function createPage($bind): void

lines 135–161 (27)

createPage()

Insert new page record

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

Returns: void

updatePage()

public function updatePage($sanitize, $bind, $ID): void

lines 173–200 (28)

UpdatePage

Updating an existing page record

^ Parameter ^ Type ^ Default ^ Description ^
| ''$sanitize'' | ''(untyped)'' | //required// | //none// |
| ''$bind'' | ''(untyped)'' | //required// | //none// |
| ''$ID'' | ''(untyped)'' | //required// | //none// |

Returns: void

deletePage()

public function deletePage($ID, $sanitize, $type): void

lines 211–219 (9)

deletePage

Deleting an existing record based on it's ID

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

Returns: void

checkPageId()

public function checkPageId($id, $sanitizing)

lines 228–235 (8)

Check page id

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

Returns: (none declared) — numeric

dropDownPostStatus()

public function dropDownPostStatus($selected = "")

lines 243–249 (7)

Set post status

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

Returns: (none declared) — string

dropDownCommentStatus()

public function dropDownCommentStatus($selected = '')

lines 257–263 (7)

Set comment status

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

Returns: (none declared) — string

totalPageRecords()

public function totalPageRecords(array $data = []): ?int

lines 271–278 (8)

Total page records

^ Parameter ^ Type ^ Default ^ Description ^
| ''$data'' | ''array'' | ''[]'' | //none// |

Returns: ?int — numeric

dropDownLocale()

public function dropDownLocale($selected = "")

lines 287–290 (4)

Drop down locale

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

Returns: (none declared) — string

Imports

^ Alias ^ Fully-qualified name ^
| ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |

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

scriptlog/lib/dao/pagedao.1790413760.txt.gz · Last modified: by admin