Scriptlog Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== BlogspotImporter ======

**Layer:** ''Utility'' &middot; **Source:** ''lib/utility/import-blogspot.php:16'' (lines 16–451)

----
<code>
class BlogspotImporter
</code>

Blogspot/Blogger XML Importer Utility

Parses Blogger/Ghost export XML 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 (5) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$xml'' |  | 18 |
| ''private'' | ''(untyped)'' | ''$feedId'' |  | 19 |
| ''private'' | ''(untyped)'' | ''$title'' |  | 20 |
| ''private'' | ''(untyped)'' | ''$subtitle'' |  | 21 |
| ''private'' | ''(untyped)'' | ''$url'' |  | 22 |

======= Methods (10) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 24 |
| public | ''parse()'' | Parse XML file from string | 39 |
| private | ''extractFeedInfo()'' | Extract feed information | 68 |
| public | ''getSiteInfo()'' | Get site information | 112 |
| public | ''getPosts()'' | Extract all posts from Blogger XML | 127 |
| public | ''getPages()'' | Extract all pages from Blogger XML | 295 |
| public | ''getCategories()'' | Extract all categories/labels from Blogger XML | 357 |
| private | ''generateSlug()'' | Generate unique slug | 404 |
| private | ''formatDate()'' | Format date string | 421 |
| private | ''cleanXmlContent()'' | Clean XML content | 437 |


======== __construct() ========

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

//lines 24–30 (7)//

//Takes no parameters.//


======== parse() ========

<code>
public function parse($content)
</code>

//lines 39–61 (23)//

Parse XML file from string

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

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

**Throws:** ''ImportException''


======== extractFeedInfo() ========

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

//lines 68–105 (38)//

Extract feed information

//Takes no parameters.//

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


======== getSiteInfo() ========

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

//lines 112–120 (9)//

Get site information

//Takes no parameters.//

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


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

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

//lines 127–288 (162)//

Extract all posts from Blogger XML

//Takes no parameters.//

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


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

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

//lines 295–350 (56)//

Extract all pages from Blogger XML

//Takes no parameters.//

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


======== getCategories() ========

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

//lines 357–395 (39)//

Extract all categories/labels from Blogger XML

//Takes no parameters.//

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


======== generateSlug() ========

<code>
private function generateSlug($title, $id = &#039;&#039;)
</code>

//lines 404–413 (10)//

Generate unique slug

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

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


======== formatDate() ========

<code>
private function formatDate($date)
</code>

//lines 421–429 (9)//

Format date string

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

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


======== cleanXmlContent() ========

<code>
private function cleanXmlContent($content)
</code>

//lines 437–450 (14)//

Clean XML content

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

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


----

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