Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:utility:scriptlogimporter

This is an old revision of the document!


ScriptlogImporter

Layer: Utility · Source: lib/utility/import-scriptlog.php:16 (lines 16–187)


class ScriptlogImporter

Scriptlog Importer Utility

Parses Scriptlog native export JSON files

Docblock Metadata

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

Inheritance

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

Constants (0)

None.

Properties (0)

None declared.

Methods (12)

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 23 |
| public | ''parse()'' | Parse JSON file from string | 37 |
| public | ''getSiteInfo()'' | Get site information | 68 |
| public | ''getUsers()'' | Get all users | 83 |
| public | ''getTopics()'' | Get all topics/categories | 93 |
| public | ''getPosts()'' | Get all posts | 103 |
| public | ''getPages()'' | Get all pages | 113 |
| public | ''getComments()'' | Get all comments | 123 |
| public | ''getMenus()'' | Get all menus | 133 |
| public | ''getSettings()'' | Get all settings | 143 |
| public | ''getPostTopics()'' | Get post-topic relationships | 153 |
| public | ''getTags()'' | Get tags (extracted from posts) | 163 |

__construct()

public function __construct()

lines 23–28 (6)

Takes no parameters.

parse()

public function parse($content)

lines 37–61 (25)

Parse JSON file from string

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

Returns: (none declared) — bool

Throws: ImportException

getSiteInfo()

public function getSiteInfo()

lines 68–76 (9)

Get site information

Takes no parameters.

Returns: (none declared) — array

getUsers()

public function getUsers()

lines 83–86 (4)

Get all users

Takes no parameters.

Returns: (none declared) — array

getTopics()

public function getTopics()

lines 93–96 (4)

Get all topics/categories

Takes no parameters.

Returns: (none declared) — array

getPosts()

public function getPosts()

lines 103–106 (4)

Get all posts

Takes no parameters.

Returns: (none declared) — array

getPages()

public function getPages()

lines 113–116 (4)

Get all pages

Takes no parameters.

Returns: (none declared) — array

getComments()

public function getComments()

lines 123–126 (4)

Get all comments

Takes no parameters.

Returns: (none declared) — array

getMenus()

public function getMenus()

lines 133–136 (4)

Get all menus

Takes no parameters.

Returns: (none declared) — array

getSettings()

public function getSettings()

lines 143–146 (4)

Get all settings

Takes no parameters.

Returns: (none declared) — array

getPostTopics()

public function getPostTopics()

lines 153–156 (4)

Get post-topic relationships

Takes no parameters.

Returns: (none declared) — array

getTags()

public function getTags()

lines 163–186 (24)

Get tags (extracted from posts)

Takes no parameters.

Returns: (none declared) — array


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

scriptlog/lib/utility/scriptlogimporter.1790413763.txt.gz · Last modified: by admin