====== ScriptlogExporter ======

**Layer:** ''Utility'' · **Source:** ''lib/utility/export-scriptlog.php:17'' (lines 17–283)

----
<code>
class ScriptlogExporter
</code>

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 (4) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$siteUrl'' |  | 19 |
| ''private'' | ''(untyped)'' | ''$siteTitle'' |  | 20 |
| ''private'' | ''(untyped)'' | ''$siteDescription'' |  | 21 |
| ''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() ========

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

//lines 24–31 (8)//

//Takes no parameters.//


======== export() ========

<code>
public function export(&amp;$exportStats, $authorId = null)
</code>

//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() ========

<code>
private function getUsers($authorId = null)
</code>

//lines 98–129 (32)//

Get users for export

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

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


======== getTopics() ========

<code>
private function getTopics()
</code>

//lines 136–145 (10)//

Get topics/categories for export

//Takes no parameters.//

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


======== getPosts() ========

<code>
private function getPosts($authorId = null)
</code>

//lines 153–180 (28)//

Get posts for export

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

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


======== getPages() ========

<code>
private function getPages($authorId = null)
</code>

//lines 188–215 (28)//

Get pages for export

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

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


======== getComments() ========

<code>
private function getComments()
</code>

//lines 222–233 (12)//

Get comments for export

//Takes no parameters.//

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


======== getMenus() ========

<code>
private function getMenus()
</code>

//lines 240–247 (8)//

Get menus for export

//Takes no parameters.//

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


======== getPostTopics() ========

<code>
private function getPostTopics()
</code>

//lines 254–261 (8)//

Get post-topic relationships

//Takes no parameters.//

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


======== getSettings() ========

<code>
private function getSettings()
</code>

//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.//