This is an old revision of the document!
Table of Contents
ScriptlogExporter
Layer: Utility · Source: lib/utility/export-scriptlog.php:17 (lines 17–283)
class ScriptlogExporter
Scriptlog Exporter Utility
Exports Blogware/Scriptlog content to native Scriptlog JSON format This format can be imported directly into another Scriptlog installation
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 (1)
| Visibility | Type | Name | Default | Line |
|---|---|---|---|---|
private | (untyped) | $version | '1.0'; | 22 |
Methods (10)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | (undocumented) | 24 |
| public | export() | Export content to Scriptlog JSON format | 41 |
| private | getUsers() | Get users for export | 98 |
| private | getTopics() | Get topics/categories for export | 136 |
| private | getPosts() | Get posts for export | 153 |
| private | getPages() | Get pages for export | 188 |
| private | getComments() | Get comments for export | 222 |
| private | getMenus() | Get menus for export | 240 |
| private | getPostTopics() | Get post-topic relationships | 254 |
| private | getSettings() | Get settings for export | 268 |
__construct()
public function __construct()
lines 24–31 (8)
Takes no parameters.
export()
public function export(&$exportStats, $authorId = null)
lines 41–90 (50)
Export content to Scriptlog JSON format
| Parameter | Type | Default | Description |
|---|---|---|---|
$exportStats (by reference) | (untyped) | required | Reference to stats array to update |
$authorId | (untyped) | null | Filter by author ID (null for all) |
Returns: (none declared) — string Scriptlog JSON content
Throws: ExportException
getUsers()
private function getUsers($authorId = null)
lines 98–129 (32)
Get users for export
| Parameter | Type | Default | Description |
|---|---|---|---|
$authorId | (untyped) | null | none |
Returns: (none declared) — array
getTopics()
private function getTopics()
lines 136–145 (10)
Get topics/categories for export
Takes no parameters.
Returns: (none declared) — array
getPosts()
private function getPosts($authorId = null)
lines 153–180 (28)
Get posts for export
| Parameter | Type | Default | Description |
|---|---|---|---|
$authorId | (untyped) | null | none |
Returns: (none declared) — array
getPages()
private function getPages($authorId = null)
lines 188–215 (28)
Get pages for export
| Parameter | Type | Default | Description |
|---|---|---|---|
$authorId | (untyped) | null | none |
Returns: (none declared) — array
getComments()
private function getComments()
lines 222–233 (12)
Get comments for export
Takes no parameters.
Returns: (none declared) — array
getMenus()
private function getMenus()
lines 240–247 (8)
Get menus for export
Takes no parameters.
Returns: (none declared) — array
getPostTopics()
private function getPostTopics()
lines 254–261 (8)
Get post-topic relationships
Takes no parameters.
Returns: (none declared) — array
getSettings()
private function getSettings()
lines 268–282 (15)
Get settings for export
Takes no parameters.
Returns: (none declared) — array
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.