Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:utility:scriptlogexporter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
scriptlog:lib:utility:scriptlogexporter [2026/09/26 09:09] – admin adminscriptlog:lib:utility:scriptlogexporter [2026/09/26 09:34] (current) – admin admin
Line 15: Line 15:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Utility | +| ''@category'' | Utility | 
-  | ''@author'' | M.Noermoehammad | +| ''@author'' | M.Noermoehammad | 
-  | ''@license'' | MIT | +| ''@license'' | MIT | 
-  | ''@version'' | 1.0 | +| ''@version'' | 1.0 | 
-  | ''@since'' | Since Release 1.0 |+| ''@since'' | Since Release 1.0 |
  
 ======= Inheritance ======= ======= Inheritance =======
Line 30: Line 30:
 //None.// //None.//
  
-======= Properties (1) =======+======= Properties (4) =======
  
-  ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ +^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
-  | ''private'' | ''(untyped)'' | ''$version'' | '''1.0';'' | 22 |+| ''private'' | ''(untyped)'' | ''$siteUrl'' |  | 19 | 
 +| ''private'' | ''(untyped)'' | ''$siteTitle'' |  | 20 | 
 +| ''private'' | ''(untyped)'' | ''$siteDescription'' |  | 21 | 
 +| ''private'' | ''(untyped)'' | ''$version'' | '''1.0''' | 22 |
  
 ======= Methods (10) ======= ======= Methods (10) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | (undocumented) | 24 | +| public | ''__construct()'' | (undocumented) | 24 | 
-  | public | ''export()'' | Export content to Scriptlog JSON format | 41 | +| public | ''export()'' | Export content to Scriptlog JSON format | 41 | 
-  | private | ''getUsers()'' | Get users for export | 98 | +| private | ''getUsers()'' | Get users for export | 98 | 
-  | private | ''getTopics()'' | Get topics/categories for export | 136 | +| private | ''getTopics()'' | Get topics/categories for export | 136 | 
-  | private | ''getPosts()'' | Get posts for export | 153 | +| private | ''getPosts()'' | Get posts for export | 153 | 
-  | private | ''getPages()'' | Get pages for export | 188 | +| private | ''getPages()'' | Get pages for export | 188 | 
-  | private | ''getComments()'' | Get comments for export | 222 | +| private | ''getComments()'' | Get comments for export | 222 | 
-  | private | ''getMenus()'' | Get menus for export | 240 | +| private | ''getMenus()'' | Get menus for export | 240 | 
-  | private | ''getPostTopics()'' | Get post-topic relationships | 254 | +| private | ''getPostTopics()'' | Get post-topic relationships | 254 | 
-  | private | ''getSettings()'' | Get settings for export | 268 |+| private | ''getSettings()'' | Get settings for export | 268 |
  
  
Line 71: Line 74:
 Export content to Scriptlog JSON format Export content to Scriptlog JSON format
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$exportStats (by reference)'' | ''(untyped)'' | //required// | Reference to stats array to update | +|  ''$exportStats (by reference)'' |  ''(untyped)'' |  //required// |  Reference to stats array to update | 
-  | ''$authorId'' | ''(untyped)'' | ''null'' | Filter by author ID (null for all) |+|  ''$authorId'' |  ''(untyped)'' |  ''null'' |  Filter by author ID (null for all) |
  
 **Returns:** ''(none declared)'' — string Scriptlog JSON content **Returns:** ''(none declared)'' — string Scriptlog JSON content
Line 90: Line 93:
 Get users for export Get users for export
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$authorId'' | ''(untyped)'' | ''null'' | //none// |+|  ''$authorId'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 121: Line 124:
 Get posts for export Get posts for export
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$authorId'' | ''(untyped)'' | ''null'' | //none// |+|  ''$authorId'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 137: Line 140:
 Get pages for export Get pages for export
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$authorId'' | ''(untyped)'' | ''null'' | //none// |+|  ''$authorId'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
scriptlog/lib/utility/scriptlogexporter.1790413763.txt.gz · Last modified: by admin