PHP Class Xpressengine\Plugin\PluginEntity

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: implements Illuminate\Contracts\Support\Arrayable, implements Illuminate\Contracts\Support\Jsonable
Mostra file Open project: xpressengine/xpressengine Class Usage Examples

Public Properties

Property Type Description
$collection PluginCollection

Protected Properties

Property Type Description
$class string | AbstractPlugin 플러그인의 클래스명(네임스페이스 포함)
$componentInfo array 플러그인에 포함된 ComponentInterface 의 설정 정보
$id string 플러그인의 ID, 플러그인의 저장된 디렉토리명과 동일하다.
$installedVersion null
$metaData array
$object AbstractPlugin 플러그인의 인스턴스.
$pluginFile string 플러그인의 경로
$remoteData
$status string

Public Methods

Method Description
__call ( string $method, mixed $arguments ) : mixed 이 PluginEntity의 메소드가 호출될 경우, 플러그인 인스턴스의 메소드가 호출되도록 한다.
__construct ( string $id, string $path, string $class, array $metaData, AbstractPlugin $object = null ) 플러그인의 정보를 전달받아 Entity 클래스를 생성한다.
bootComponents ( ) : void call component boot interface
getAuthor ( ) : array 플러그인 제작자 정보를 조회한다. 제작자가 여러명일 경우 첫번째 제작자만 반환한다.
getAuthors ( ) : array 플러그인 제작자 정보를 조회한다.
getChangeLog ( ) : string 플러그인의 change log 파일 내용을 반환한다.
getClass ( ) : string 플러그인의 클래스명을 반환한다.
getCollection ( ) : PluginCollection getCollection
getComponentList ( string $type = null ) : array 플러그인이 소유한 컴포넌트 목록을 조회한다. type이 지정돼 있을 경우 해당 type의 컴포넌트를 조회한다.
getComponentType ( string $id ) : string 주어진 컴포넌트 아이디에서 컴포넌트 타입정보를 조회한다.
getDependencies ( ) : string[] 플러그인의 의존성정보를 조회한다.
getDescription ( ) : string 플러그인 설명을 조회한다.
getIcon ( ) : string 플러그인의 아이콘 url을 반환한다.
getId ( ) : string 플러그인의 ID를 반환한다.
getInstalledVersion ( ) : string 플러그인의 설치 버전을 조회한다. 설치 버전은 XpressEngine에 적용되어 있는 플러그인의 버전이다.
getKeywords ( ) : array 플러그인의 검색 키워드를 조회한다.
getLatestVersion ( ) : string 플러그인의 최신 업데이트 버전을 Xpressengine의 서버에서 조회하여 반환한다.
getLicense ( ) : string 플러그인의 라이선스 정보를 조회한다.
getMetaData ( string $field = null ) : array | mixed 플러그인의 메타데이터 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
getName ( ) : string 플러그인의 이름을 조회한다. 이름은 composer에서 사용하는 패키지명과 일치한다.
getObject ( ) : AbstractPlugin 플러그인의 인스턴스를 반환한다.
getPath ( string $path = '' ) : string 해당 플러그인의 설치 경로를 반환한다.
getReadMe ( ) : string 플러그인의 readme 파일 내용을 반환한다.
getRemoteData ( ) : null 자료실에 등록된 플러그인의 정보가 설정돼 있을 경우 반환한다.
getScreenshots ( ) : string 플러그인의 아이콘 url을 반환한다.
getStatus ( ) : string 플러그인 상태를 조회한다.
getSupport ( string $field = null ) : array | string Support 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
getTitle ( ) : array | mixed 플러그인 제목을 조회한다.
getVersion ( ) : string 플러그인 버전을 조회한다.
hasRemoteData ( ) : boolean 자료실에 등록된 자료 정보가 있는지 검사
hasUpdate ( ) : boolean 플러그인의 업데이트가 Xpressengine의 서버에 존재하고, 아직 다운로드되어 있지 않은 상태인지 체크한다.
isActivated ( ) : boolean 플러그인이 활성화된 상태인지 조사한다.
isDeactivated ( ) : boolean 플러그인이 비활성화된 상태인지 조사한다
isDevelopMode ( ) : boolean 개발모드 플러그인인지 검사한다. vendor 디렉토리를 가지고 있는지의 유무로 판단한다.
needUpdateInstall ( ) : boolean 플러그인의 새로운 업데이트가 서버에 다운로드 되어 있는 상태인지 확인한다.
setCollection ( PluginCollection $collection ) : void PluginCollection을 지정한다.
setInstalledVersion ( string $version ) : void 플러그인의 설치 버전을 지정한다.
setMetaData ( array $data ) : void 플러그인의 메타정보를 지정한다.
setRemoteData ( array $data ) : void 자료실에 등록된 플러그인의 정보를 설정한다.
setStatus ( string $status ) : void 플러그인 상태를 지정한다.
toArray ( ) : array 플러그인 정보를 array형식으로 반환한다.
toJson ( integer $options ) : string 플러그인 정보를 json 형식으로 반환한다.

Protected Methods

Method Description
registerPluginAutoload ( ) : void 플러그인이 composer autoload 파일을 가지고 있을 경우 autoload를 등록한다.

Method Details

__call() public method

이 PluginEntity의 메소드가 호출될 경우, 플러그인 인스턴스의 메소드가 호출되도록 한다.
public __call ( string $method, mixed $arguments ) : mixed
$method string 호출될 메소드
$arguments mixed 호출시 파라메터
return mixed

__construct() public method

플러그인의 정보를 전달받아 Entity 클래스를 생성한다.
public __construct ( string $id, string $path, string $class, array $metaData, AbstractPlugin $object = null )
$id string 플러그인의 ID
$path string 플러그인의 경로
$class string 플러그인의 클래스명
$metaData array 플러그인 부가정보
$object AbstractPlugin 플러그인의 인스턴스

bootComponents() public method

call component boot interface
public bootComponents ( ) : void
return void

getAuthor() public method

플러그인 제작자 정보를 조회한다. 제작자가 여러명일 경우 첫번째 제작자만 반환한다.
public getAuthor ( ) : array
return array

getAuthors() public method

플러그인 제작자 정보를 조회한다.
public getAuthors ( ) : array
return array

getChangeLog() public method

플러그인의 change log 파일 내용을 반환한다.
public getChangeLog ( ) : string
return string

getClass() public method

플러그인의 클래스명을 반환한다.
public getClass ( ) : string
return string

getCollection() public static method

getCollection
public static getCollection ( ) : PluginCollection
return PluginCollection

getComponentList() public method

플러그인이 소유한 컴포넌트 목록을 조회한다. type이 지정돼 있을 경우 해당 type의 컴포넌트를 조회한다.
public getComponentList ( string $type = null ) : array
$type string component type
return array

getComponentType() public static method

주어진 컴포넌트 아이디에서 컴포넌트 타입정보를 조회한다.
public static getComponentType ( string $id ) : string
$id string 컴포넌트 아이디
return string

getDependencies() public method

플러그인의 의존성정보를 조회한다.
public getDependencies ( ) : string[]
return string[]

getDescription() public method

플러그인 설명을 조회한다.
public getDescription ( ) : string
return string

getIcon() public method

플러그인의 아이콘 url을 반환한다.
public getIcon ( ) : string
return string

getId() public method

플러그인의 ID를 반환한다.
public getId ( ) : string
return string

getInstalledVersion() public method

한번도 활성화된 적이 없다면 다운로드된 플러그인의 버전을 반환한다.
public getInstalledVersion ( ) : string
return string

getKeywords() public method

플러그인의 검색 키워드를 조회한다.
public getKeywords ( ) : array
return array

getLatestVersion() public method

플러그인의 최신 업데이트 버전을 Xpressengine의 서버에서 조회하여 반환한다.
public getLatestVersion ( ) : string
return string latest version

getLicense() public method

플러그인의 라이선스 정보를 조회한다.
public getLicense ( ) : string
return string

getMetaData() public method

플러그인의 메타데이터 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
public getMetaData ( string $field = null ) : array | mixed
$field string 조회할 필드명
return array | mixed

getName() public method

플러그인의 이름을 조회한다. 이름은 composer에서 사용하는 패키지명과 일치한다.
public getName ( ) : string
return string

getObject() public method

플러그인의 인스턴스를 반환한다.
public getObject ( ) : AbstractPlugin
return AbstractPlugin

getPath() public method

path가 주어질 경우, 주어진 path정보를 추가하여 반환한다.
public getPath ( string $path = '' ) : string
$path string path
return string

getReadMe() public method

플러그인의 readme 파일 내용을 반환한다.
public getReadMe ( ) : string
return string

getRemoteData() public method

자료실에 등록된 플러그인의 정보가 설정돼 있을 경우 반환한다.
public getRemoteData ( ) : null
return null

getScreenshots() public method

플러그인의 아이콘 url을 반환한다.
public getScreenshots ( ) : string
return string

getStatus() public method

플러그인 상태를 조회한다.
public getStatus ( ) : string
return string

getSupport() public method

Support 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
public getSupport ( string $field = null ) : array | string
$field string 조회할 필드명
return array | string

getTitle() public method

플러그인 제목을 조회한다.
public getTitle ( ) : array | mixed
return array | mixed

getVersion() public method

플러그인 버전을 조회한다.
public getVersion ( ) : string
return string

hasRemoteData() public method

자료실에 등록된 자료 정보가 있는지 검사
public hasRemoteData ( ) : boolean
return boolean

hasUpdate() public method

플러그인의 업데이트가 Xpressengine의 서버에 존재하고, 아직 다운로드되어 있지 않은 상태인지 체크한다.
public hasUpdate ( ) : boolean
return boolean 새버전이 서버에 존재할 경우 true를 반환

isActivated() public method

플러그인이 활성화된 상태인지 조사한다.
public isActivated ( ) : boolean
return boolean

isDeactivated() public method

플러그인이 비활성화된 상태인지 조사한다
public isDeactivated ( ) : boolean
return boolean

isDevelopMode() public method

개발모드 플러그인인지 검사한다. vendor 디렉토리를 가지고 있는지의 유무로 판단한다.
public isDevelopMode ( ) : boolean
return boolean

needUpdateInstall() public method

플러그인의 새로운 업데이트가 서버에 다운로드 되어 있는 상태인지 확인한다.
public needUpdateInstall ( ) : boolean
return boolean 설치가 필요할 경우 true를 반환

registerPluginAutoload() protected method

autoload 파일을 각 플러그인 디렉토리 내에 vendor/autoload.php 파일이다.
protected registerPluginAutoload ( ) : void
return void

setCollection() public static method

PluginCollection을 지정한다.
public static setCollection ( PluginCollection $collection ) : void
$collection PluginCollection plugin collection
return void

setInstalledVersion() public method

플러그인의 설치 버전을 지정한다.
public setInstalledVersion ( string $version ) : void
$version string 설치버전
return void

setMetaData() public method

플러그인의 메타정보를 지정한다.
public setMetaData ( array $data ) : void
$data array 메타정보
return void

setRemoteData() public method

자료실에 등록된 플러그인의 정보를 설정한다.
public setRemoteData ( array $data ) : void
$data array 자료실에 등록된 플러그인 정보
return void

setStatus() public method

플러그인 상태를 지정한다.
public setStatus ( string $status ) : void
$status string 플러그인 상태
return void

toArray() public method

플러그인 정보를 array형식으로 반환한다.
public toArray ( ) : array
return array

toJson() public method

플러그인 정보를 json 형식으로 반환한다.
public toJson ( integer $options ) : string
$options integer JSON Decode options.
return string

Property Details

$class protected_oe property

플러그인의 클래스명(네임스페이스 포함)
protected string|AbstractPlugin,Xpressengine\Plugin $class
return string | AbstractPlugin

$collection public_oe static_oe property

public static PluginCollection,Xpressengine\Plugin $collection
return PluginCollection

$componentInfo protected_oe property

플러그인에 포함된 ComponentInterface 의 설정 정보
protected array $componentInfo
return array

$id protected_oe property

플러그인의 ID, 플러그인의 저장된 디렉토리명과 동일하다.
protected string $id
return string

$installedVersion protected_oe property

protected null $installedVersion
return null

$metaData protected_oe property

protected array $metaData
return array

$object protected_oe property

플러그인의 인스턴스.
protected AbstractPlugin,Xpressengine\Plugin $object
return AbstractPlugin

$pluginFile protected_oe property

플러그인의 경로
protected string $pluginFile
return string

$remoteData protected_oe property

protected $remoteData

$status protected_oe property

protected string $status
return string