• Home
• Xpressengine
• Editor
• AbstractEditor

PHP Class Xpressengine\Editor\AbstractEditor

Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property	Type	Description
$arguments	array	Given arguments for the editor
$config	Xpressengine\Config\ConfigEntity | null	ConfigEntity instance
$defaultArguments	array	Default editor arguments
$editors	EditorHandler	EditorHandler instance
$events	Illuminate\Contracts\Events\Dispatcher	Dispatcher instance
$fileClassName	string	The file class name
$fileIdentifierAttrName	string	The file identifier attribute name
$fileInputName	string	The file input name
$files	array	Used files
$frontend	Xpressengine\Presenter\Html\FrontendHandler	FrontendHandler instance
$gate	Illuminate\Contracts\Auth\Access\Gate	Gate instance
$imageClassName	string	The image class name
$imageIdentifierAttrName	string	The image identifier attribute name
$imageResolver	callable	The image resolver
$instanceId	string	Instance identifier
$mentionClassName	string	The mention class name
$mentionIdentifierAttrName	string	The mention identifier attribute name
$mentionInputName	string	The mention input name
$options	null	Options for the editor
$scriptOnly	boolean	Indicates if used only javascript.
$skins	Xpressengine\Skin\SkinHandler	SkinHandler instance
$tagClassName	string	The tag class name
$tagInputName	string	The tag input name
$tools	AbstractTool[]	The registered tools for the editor
$urls	Illuminate\Contracts\Routing\UrlGenerator	UrlGenerator instance

Public Methods

Method	Description
__construct ( EditorHandler $editors, Illuminate\Contracts\Routing\UrlGenerator $urls, Illuminate\Contracts\Auth\Access\Gate $gate, Xpressengine\Skin\SkinHandler $skins, Illuminate\Contracts\Events\Dispatcher $events, FrontendHandler $frontend, string $instanceId )	AbstractEditor constructor.
compile ( string $content, boolean $htmlable = false ) : string	Compile the raw content to be useful
getActivateToolIds ( ) : array	Get activated tool's identifier for the editor
getArguments ( ) : array	Get arguments for the editor
getConfig ( ) : null | ConfigEntity	Get config for the editor
getCustomOptions ( ) : array	Get options for some editor only
getFileClassName ( ) : string	Get the file class name
getFileIdentifierAttrName ( ) : string	Get the file identifier attribute name
getFileInputName ( ) : string	Get the file input name
getImageClassName ( ) : string	Get the image class name
getImageIdentifierAttrName ( ) : string	Get the image identifier attribute name
getInstanceId ( ) : string	Get instance id for the editor
getInstanceSettingURI ( string $instanceId ) : string | null	Get uri for custom setting
getMentionClassName ( ) : string	Get the mention class name
getMentionIdentifierAttrName ( ) : string	Get the mention identifier attribute name
getMentionInputName ( ) : string	Get the mention input name
getName ( ) : string	Get a editor name
getOptions ( ) : array	Get options
getTagClassName ( ) : string	Get the tag class name
getTagInputName ( ) : string	Get the tag input name
getTools ( ) : AbstractTool[]	Get activated tools for the editor
htmlable ( ) : boolean	Determine if a editor html usable.
render ( ) : string	Get the evaluated contents of the object.
resolveImage ( array $ids = [] ) : array	Resolve image instances
setArguments ( array $arguments = [] )	Set arguments for the editor
setConfig ( ConfigEntity $config )	Set config for the editor
setFiles ( array $files = [] ) : void	Set files the editor used
setImageResolver ( callable $resolver ) : void	Set the image resolver

Protected Methods

Method	Description
buildOptions ( ) : array	Build options
compileBody ( string $content ) : string	Compile content body
getContentDomHtmlOption ( array $domOptions ) : string	Get attributes string for content html tag
getContentHtml ( ) : string	Get a content html tag string
getDynamicOption ( ) : array	Get dynamic option data for the editor
getEditorScript ( array $options ) : mixed	Get script for running the editor
getStaticOption ( ) : array	Get static option data for the editor
hashTag ( string $content ) : string	Compile tags in content body
image ( string $content ) : string	Compile images in content body
link ( string $content ) : string	Compile links in content body
loadTools ( ) : void	Load tools
mention ( string $content ) : string	Compile mentions in content body

Private Methods

Method	Description
createCrawler ( string $content ) : Crawler	Create crawler instance
getData ( string $content, string $selector, array $attributes = [] ) : array	Get html node data

Method Details

Property Details