EasyBlogDocument
extends EasyBlog
in package
Table of Contents
Properties
- $app : mixed
- $blocks : mixed
- $config : mixed
- $content : array<string|int, mixed>
- Contains blocks placed in the content section
- $db : mixed
- $doc : mixed
- $input : mixed
- $intro : array<string|int, mixed>
- Contains blocks placed in the intro section
- $jconfig : mixed
- $lang : mixed
- $my : mixed
- $permalink : string
- The permalink of the document
- $string : mixed
- $title : string
- The title of the document
- $type : string
- Determines the document type
- $version : string
- The version of this document
Methods
- __construct() : mixed
- extractMedia() : mixed
- Retrieves the media from a document
- getAMPContent() : mixed
- Retrieves the document content by rendering the blocks
- getBlocks() : mixed
- Retrieves the blocks from a document
- getContent() : mixed
- Retrieves the document content by rendering the blocks
- getContentWithoutIntro() : mixed
- Retrieves the content which is separated from the intro
- getDiffContent() : mixed
- Retrieves the document content that is used for diff
- getEditableContent() : mixed
- Retrieves the editable html codes for each blocks
- getError() : mixed
- getErrors() : mixed
- getInstantContent() : mixed
- Retrieves the document content by rendering the blocks
- getIntro() : mixed
- Retrieves the intro text part of a document
- getUids() : mixed
- Retrieves all the block uid's within a document
- getUniqueBlocks() : mixed
- Retrieves a list of unique blocks from the document
- hasError() : mixed
- hasErrors() : mixed
- hasReadmore() : mixed
- Determines if this document has read more
- isMobile() : mixed
- Determines if this is a mobile layout
- isTablet() : mixed
- Determines if this is a tablet layout
- load() : mixed
- Loads the json string of a document
- loadLanguage() : mixed
- Helper method to load language
- processContent() : mixed
- Retrieves the intro text part of a document
- processCopy() : mixed
- processIntro() : mixed
- Retrieves the intro text part of a document
- removeInvisibleCharacter() : mixed
- At times redactor would inject zero width invisible characters and this could cause integrity issue to the content.
- replaceTabId() : mixed
- setError() : mixed
- toJSON() : mixed
- Exports a document object into a json string
- traverseBlocks() : mixed
Properties
$app
public
mixed
$app
= \null
$blocks
public
mixed
$blocks
= []
$config
public
mixed
$config
= \null
$content
Contains blocks placed in the content section
public
array<string|int, mixed>
$content
= []
$db
public
mixed
$db
= \null
$doc
public
mixed
$doc
= \null
$input
public
mixed
$input
= \null
$intro
Contains blocks placed in the intro section
public
array<string|int, mixed>
$intro
= []
$jconfig
public
mixed
$jconfig
= \null
$lang
public
mixed
$lang
= \null
$my
public
mixed
$my
= \null
$permalink
The permalink of the document
public
string
$permalink
= ''
$string
public
mixed
$string
= \null
$title
The title of the document
public
string
$title
= ''
$type
Determines the document type
public
string
$type
= 'ebd'
$version
The version of this document
public
string
$version
= '1.0'
Methods
__construct()
public
__construct([mixed $json = null ]) : mixed
Parameters
- $json : mixed = null
extractMedia()
Retrieves the media from a document
public
extractMedia() : mixed
Tags
getAMPContent()
Retrieves the document content by rendering the blocks
public
getAMPContent() : mixed
Tags
getBlocks()
Retrieves the blocks from a document
public
getBlocks() : mixed
Tags
getContent()
Retrieves the document content by rendering the blocks
public
getContent() : mixed
Tags
getContentWithoutIntro()
Retrieves the content which is separated from the intro
public
getContentWithoutIntro([mixed $stripTags = false ]) : mixed
Parameters
- $stripTags : mixed = false
Tags
getDiffContent()
Retrieves the document content that is used for diff
public
getDiffContent(EasyBlogDocument $target) : mixed
Parameters
- $target : EasyBlogDocument
Tags
getEditableContent()
Retrieves the editable html codes for each blocks
public
getEditableContent([mixed $postTemplateIsLocked = false ]) : mixed
Parameters
- $postTemplateIsLocked : mixed = false
Tags
getError()
public
getError() : mixed
getErrors()
public
getErrors() : mixed
getInstantContent()
Retrieves the document content by rendering the blocks
public
getInstantContent() : mixed
Tags
getIntro()
Retrieves the intro text part of a document
public
getIntro([mixed $stripTags = false ][, mixed $limit = null ][, mixed $options = [] ]) : mixed
Parameters
- $stripTags : mixed = false
- $limit : mixed = null
- $options : mixed = []
Tags
getUids()
Retrieves all the block uid's within a document
public
getUids() : mixed
Tags
getUniqueBlocks()
Retrieves a list of unique blocks from the document
public
getUniqueBlocks() : mixed
Tags
hasError()
public
hasError() : mixed
hasErrors()
public
hasErrors() : mixed
hasReadmore()
Determines if this document has read more
public
hasReadmore() : mixed
Tags
isMobile()
Determines if this is a mobile layout
public
isMobile() : mixed
Tags
isTablet()
Determines if this is a tablet layout
public
isTablet() : mixed
Tags
load()
Loads the json string of a document
public
load(mixed $json) : mixed
Parameters
- $json : mixed
Tags
loadLanguage()
Helper method to load language
public
loadLanguage([mixed $admin = false ]) : mixed
Parameters
- $admin : mixed = false
Tags
processContent()
Retrieves the intro text part of a document
public
processContent([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Tags
processCopy()
public
processCopy() : mixed
processIntro()
Retrieves the intro text part of a document
public
processIntro([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Tags
removeInvisibleCharacter()
At times redactor would inject zero width invisible characters and this could cause integrity issue to the content.
public
removeInvisibleCharacter(mixed $content) : mixed
Parameters
- $content : mixed
Tags
replaceTabId()
public
replaceTabId(mixed $blocks) : mixed
Parameters
- $blocks : mixed
setError()
public
setError(mixed $msg) : mixed
Parameters
- $msg : mixed
toJSON()
Exports a document object into a json string
public
toJSON() : mixed
Tags
traverseBlocks()
private
traverseBlocks(mixed $block, mixed &$container) : mixed
Parameters
- $block : mixed
- $container : mixed