PHP 클래스 Xpressengine\Editor\AbstractEditor

저자: XE Developers ([email protected])
상속: implements Xpressengine\Plugin\ComponentInterface, use trait Xpressengine\Plugin\ComponentTrait, use trait Xpressengine\Support\MobileSupportTrait
파일 보기 프로젝트 열기: xpressengine/xpressengine 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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

공개 메소드들

메소드 설명
__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

보호된 메소드들

메소드 설명
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

비공개 메소드들

메소드 설명
createCrawler ( string $content ) : Crawler Create crawler instance
getData ( string $content, string $selector, array $attributes = [] ) : array Get html node data

메소드 상세

__construct() 공개 메소드

AbstractEditor constructor.
public __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 )
$editors EditorHandler EditorHandler instance
$urls Illuminate\Contracts\Routing\UrlGenerator UrlGenerator instance
$gate Illuminate\Contracts\Auth\Access\Gate Gate instance
$skins Xpressengine\Skin\SkinHandler SkinHandler instance
$events Illuminate\Contracts\Events\Dispatcher Dispatcher instance
$frontend Xpressengine\Presenter\Html\FrontendHandler FrontendHandler instance
$instanceId string Instance identifier

buildOptions() 보호된 메소드

Build options
protected buildOptions ( ) : array
리턴 array

compile() 공개 메소드

Compile the raw content to be useful
public compile ( string $content, boolean $htmlable = false ) : string
$content string content
$htmlable boolean content is htmlable
리턴 string

compileBody() 추상적인 보호된 메소드

Compile content body
abstract protected compileBody ( string $content ) : string
$content string content
리턴 string

getActivateToolIds() 공개 메소드

Get activated tool's identifier for the editor
public getActivateToolIds ( ) : array
리턴 array

getArguments() 공개 메소드

Get arguments for the editor
public getArguments ( ) : array
리턴 array

getConfig() 공개 메소드

Get config for the editor
public getConfig ( ) : null | ConfigEntity
리턴 null | Xpressengine\Config\ConfigEntity

getContentDomHtmlOption() 보호된 메소드

Get attributes string for content html tag
protected getContentDomHtmlOption ( array $domOptions ) : string
$domOptions array dom options
리턴 string

getContentHtml() 보호된 메소드

Get a content html tag string
protected getContentHtml ( ) : string
리턴 string

getCustomOptions() 공개 메소드

Get options for some editor only
public getCustomOptions ( ) : array
리턴 array

getDynamicOption() 보호된 메소드

Get dynamic option data for the editor
protected getDynamicOption ( ) : array
리턴 array

getEditorScript() 보호된 메소드

Get script for running the editor
protected getEditorScript ( array $options ) : mixed
$options array options
리턴 mixed

getFileClassName() 공개 메소드

Get the file class name
public getFileClassName ( ) : string
리턴 string

getFileIdentifierAttrName() 공개 메소드

Get the file identifier attribute name

getFileInputName() 공개 메소드

Get the file input name
public getFileInputName ( ) : string
리턴 string

getImageClassName() 공개 메소드

Get the image class name
public getImageClassName ( ) : string
리턴 string

getImageIdentifierAttrName() 공개 메소드

Get the image identifier attribute name

getInstanceId() 공개 메소드

Get instance id for the editor
public getInstanceId ( ) : string
리턴 string

getInstanceSettingURI() 공개 정적인 메소드

Get uri for custom setting
public static getInstanceSettingURI ( string $instanceId ) : string | null
$instanceId string instance identifier
리턴 string | null

getMentionClassName() 공개 메소드

Get the mention class name
public getMentionClassName ( ) : string
리턴 string

getMentionIdentifierAttrName() 공개 메소드

Get the mention identifier attribute name

getMentionInputName() 공개 메소드

Get the mention input name
public getMentionInputName ( ) : string
리턴 string

getName() 추상적인 공개 메소드

Get a editor name
abstract public getName ( ) : string
리턴 string

getOptions() 공개 메소드

Get options
public getOptions ( ) : array
리턴 array

getStaticOption() 보호된 메소드

Get static option data for the editor
protected getStaticOption ( ) : array
리턴 array

getTagClassName() 공개 메소드

Get the tag class name
public getTagClassName ( ) : string
리턴 string

getTagInputName() 공개 메소드

Get the tag input name
public getTagInputName ( ) : string
리턴 string

getTools() 공개 메소드

Get activated tools for the editor
public getTools ( ) : AbstractTool[]
리턴 AbstractTool[]

hashTag() 보호된 메소드

Compile tags in content body
protected hashTag ( string $content ) : string
$content string content
리턴 string

htmlable() 추상적인 공개 메소드

Determine if a editor html usable.
abstract public htmlable ( ) : boolean
리턴 boolean

image() 보호된 메소드

Compile images in content body
protected image ( string $content ) : string
$content string content
리턴 string

loadTools() 보호된 메소드

Load tools
protected loadTools ( ) : void
리턴 void

mention() 보호된 메소드

Compile mentions in content body
protected mention ( string $content ) : string
$content string content
리턴 string

render() 공개 메소드

Get the evaluated contents of the object.
public render ( ) : string
리턴 string

resolveImage() 공개 정적인 메소드

Resolve image instances
public static resolveImage ( array $ids = [] ) : array
$ids array identifier list
리턴 array

setArguments() 공개 메소드

Set arguments for the editor
public setArguments ( array $arguments = [] )
$arguments array arguments

setConfig() 공개 메소드

Set config for the editor
public setConfig ( ConfigEntity $config )
$config Xpressengine\Config\ConfigEntity config instance

setFiles() 공개 메소드

Set files the editor used
public setFiles ( array $files = [] ) : void
$files array file instances
리턴 void

setImageResolver() 공개 정적인 메소드

Set the image resolver
public static setImageResolver ( callable $resolver ) : void
$resolver callable resolver
리턴 void

프로퍼티 상세

$arguments 보호되어 있는 프로퍼티

Given arguments for the editor
protected array $arguments
리턴 array

$config 보호되어 있는 프로퍼티

ConfigEntity instance
protected ConfigEntity,Xpressengine\Config|null $config
리턴 Xpressengine\Config\ConfigEntity | null

$defaultArguments 보호되어 있는 프로퍼티

Default editor arguments
protected array $defaultArguments
리턴 array

$editors 보호되어 있는 프로퍼티

EditorHandler instance
protected EditorHandler,Xpressengine\Editor $editors
리턴 EditorHandler

$events 보호되어 있는 프로퍼티

Dispatcher instance
protected Dispatcher,Illuminate\Contracts\Events $events
리턴 Illuminate\Contracts\Events\Dispatcher

$fileClassName 보호되어 있는 프로퍼티

The file class name
protected string $fileClassName
리턴 string

$fileIdentifierAttrName 보호되어 있는 프로퍼티

The file identifier attribute name
protected string $fileIdentifierAttrName
리턴 string

$fileInputName 보호되어 있는 프로퍼티

The file input name
protected string $fileInputName
리턴 string

$files 보호되어 있는 프로퍼티

Used files
protected array $files
리턴 array

$frontend 보호되어 있는 프로퍼티

FrontendHandler instance
protected FrontendHandler,Xpressengine\Presenter\Html $frontend
리턴 Xpressengine\Presenter\Html\FrontendHandler

$gate 보호되어 있는 프로퍼티

Gate instance
protected Gate,Illuminate\Contracts\Auth\Access $gate
리턴 Illuminate\Contracts\Auth\Access\Gate

$imageClassName 보호되어 있는 프로퍼티

The image class name
protected string $imageClassName
리턴 string

$imageIdentifierAttrName 보호되어 있는 프로퍼티

The image identifier attribute name
protected string $imageIdentifierAttrName
리턴 string

$imageResolver 보호되어 있는 정적으로 프로퍼티

The image resolver
protected static callable $imageResolver
리턴 callable

$instanceId 보호되어 있는 프로퍼티

Instance identifier
protected string $instanceId
리턴 string

$mentionClassName 보호되어 있는 프로퍼티

The mention class name
protected string $mentionClassName
리턴 string

$mentionIdentifierAttrName 보호되어 있는 프로퍼티

The mention identifier attribute name
protected string $mentionIdentifierAttrName
리턴 string

$mentionInputName 보호되어 있는 프로퍼티

The mention input name
protected string $mentionInputName
리턴 string

$options 보호되어 있는 프로퍼티

Options for the editor
protected null $options
리턴 null

$scriptOnly 보호되어 있는 프로퍼티

Indicates if used only javascript.
protected bool $scriptOnly
리턴 boolean

$skins 보호되어 있는 프로퍼티

SkinHandler instance
protected SkinHandler,Xpressengine\Skin $skins
리턴 Xpressengine\Skin\SkinHandler

$tagClassName 보호되어 있는 프로퍼티

The tag class name
protected string $tagClassName
리턴 string

$tagInputName 보호되어 있는 프로퍼티

The tag input name
protected string $tagInputName
리턴 string

$tools 보호되어 있는 프로퍼티

The registered tools for the editor
protected AbstractTool[],Xpressengine\Editor $tools
리턴 AbstractTool[]

$urls 보호되어 있는 프로퍼티

UrlGenerator instance
protected UrlGenerator,Illuminate\Contracts\Routing $urls
리턴 Illuminate\Contracts\Routing\UrlGenerator