PluginEntity
class PluginEntity implements Arrayable, Jsonable
이 클래스는 XE에 존재하는 플러그인의 Entity 클래스이다. 이 클래스는 XE3에서 플러그인당 하나씩 생성된다.
Properties
| static PluginCollection | $collection | ||
| protected string | $id | 플러그인의 ID, 플러그인의 저장된 디렉토리명과 동일하다. | |
| protected string | $pluginFile | 플러그인의 경로 | |
| protected string|AbstractPlugin | $class | 플러그인의 클래스명(네임스페이스 포함) | |
| protected AbstractPlugin | $object | 플러그인의 인스턴스. | |
| protected string | $status | ||
| protected null | $installedVersion | ||
| protected array | $componentInfo | 플러그인에 포함된 ComponentInterface 의 설정 정보 | |
| protected array | $metaData | ||
| protected | $remoteData |
Methods
플러그인의 정보를 전달받아 Entity 클래스를 생성한다.
플러그인의 클래스명을 반환한다.
플러그인의 ID를 반환한다.
플러그인의 인스턴스를 반환한다.
해당 플러그인의 설치 경로를 반환한다.
플러그인이 활성화된 상태인지 조사한다.
플러그인이 비활성화된 상태인지 조사한다
플러그인 상태를 조회한다.
플러그인 상태를 지정한다.
플러그인의 아이콘 url을 반환한다.
플러그인의 아이콘 url을 반환한다.
플러그인의 설치 버전을 조회한다. 설치 버전은 XpressEngine에 적용되어 있는 플러그인의 버전이다.
플러그인의 설치 버전을 지정한다.
자료실에 등록된 자료 정보가 있는지 검사
자료실에 등록된 플러그인의 정보를 설정한다.
자료실에 등록된 플러그인의 정보가 설정돼 있을 경우 반환한다.
플러그인의 새로운 업데이트가 서버에 다운로드 되어 있는 상태인지 확인한다.
플러그인의 업데이트가 Xpressengine의 서버에 존재하고, 아직 다운로드되어 있지 않은 상태인지 체크한다.
플러그인의 최신 업데이트 버전을 Xpressengine의 서버에서 조회하여 반환한다.
플러그인의 메타정보를 지정한다.
플러그인의 메타데이터 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
플러그인 제목을 조회한다.
플러그인 설명을 조회한다.
Support 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
플러그인의 readme 파일 내용을 반환한다.
플러그인의 change log 파일 내용을 반환한다.
getStoreLink
플러그인의 이름을 조회한다. 이름은 composer에서 사용하는 패키지명과 일치한다.
플러그인의 검색 키워드를 조회한다.
플러그인 제작자 정보를 조회한다.
플러그인 제작자 정보를 조회한다. 제작자가 여러명일 경우 첫번째 제작자만 반환한다.
플러그인 버전을 조회한다.
플러그인의 라이선스 정보를 조회한다.
플러그인의 의존성정보를 조회한다.
플러그인이 소유한 컴포넌트 목록을 조회한다. type이 지정돼 있을 경우 해당 type의 컴포넌트를 조회한다.
주어진 컴포넌트 아이디에서 컴포넌트 타입정보를 조회한다.
플러그인 정보를 array형식으로 반환한다.
플러그인 정보를 json 형식으로 반환한다.
이 PluginEntity의 메소드가 호출될 경우, 플러그인 인스턴스의 메소드가 호출되도록 한다.
getCollection
플러그인이 composer autoload 파일을 가지고 있을 경우 autoload를 등록한다.
개발모드 플러그인인지 검사한다. vendor 디렉토리를 가지고 있는지의 유무로 판단한다.
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
at line 110
__construct(string $id, string $path, string $class, array $metaData, AbstractPlugin $object = null)
플러그인의 정보를 전달받아 Entity 클래스를 생성한다.
at line 126
string
getClass()
플러그인의 클래스명을 반환한다.
at line 136
string
getId()
플러그인의 ID를 반환한다.
at line 146
AbstractPlugin
getObject()
플러그인의 인스턴스를 반환한다.
at line 172
string
getPath(string $path = '')
해당 플러그인의 설치 경로를 반환한다.
path가 주어질 경우, 주어진 path정보를 추가하여 반환한다.
at line 183
bool
isActivated()
플러그인이 활성화된 상태인지 조사한다.
at line 193
bool
isDeactivated()
플러그인이 비활성화된 상태인지 조사한다
at line 203
string
getStatus()
플러그인 상태를 조회한다.
at line 215
void
setStatus(string $status)
플러그인 상태를 지정한다.
at line 225
string
getIcon()
플러그인의 아이콘 url을 반환한다.
at line 252
string
getScreenshots()
플러그인의 아이콘 url을 반환한다.
at line 282
string
getInstalledVersion()
플러그인의 설치 버전을 조회한다. 설치 버전은 XpressEngine에 적용되어 있는 플러그인의 버전이다.
한번도 활성화된 적이 없다면 다운로드된 플러그인의 버전을 반환한다.
at line 294
void
setInstalledVersion(string $version)
플러그인의 설치 버전을 지정한다.
at line 304
bool
hasRemoteData()
자료실에 등록된 자료 정보가 있는지 검사
at line 319
void
setRemoteData(array $data)
자료실에 등록된 플러그인의 정보를 설정한다.
at line 329
null
getRemoteData()
자료실에 등록된 플러그인의 정보가 설정돼 있을 경우 반환한다.
at line 339
boolean
needUpdateInstall()
플러그인의 새로운 업데이트가 서버에 다운로드 되어 있는 상태인지 확인한다.
at line 350
boolean
hasUpdate()
플러그인의 업데이트가 Xpressengine의 서버에 존재하고, 아직 다운로드되어 있지 않은 상태인지 체크한다.
at line 364
string
getLatestVersion()
플러그인의 최신 업데이트 버전을 Xpressengine의 서버에서 조회하여 반환한다.
at line 379
void
setMetaData(array $data)
플러그인의 메타정보를 지정한다.
at line 391
array|mixed
getMetaData(string $field = null)
플러그인의 메타데이터 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
at line 405
array|mixed
getTitle()
플러그인 제목을 조회한다.
at line 415
string
getDescription()
플러그인 설명을 조회한다.
at line 427
array|string
getSupport(string $field = null)
Support 정보를 조회한다. 만약 필드명이 주어질 경우 해당 필드명의 정보를 조회한다.
at line 453
string
getReadMe()
플러그인의 readme 파일 내용을 반환한다.
at line 474
string
getChangeLog()
플러그인의 change log 파일 내용을 반환한다.
at line 500
string
getStoreLink()
getStoreLink
at line 513
string
getName()
플러그인의 이름을 조회한다. 이름은 composer에서 사용하는 패키지명과 일치한다.
at line 523
array
getKeywords()
플러그인의 검색 키워드를 조회한다.
at line 533
array
getAuthors()
플러그인 제작자 정보를 조회한다.
at line 548
array
getAuthor()
플러그인 제작자 정보를 조회한다. 제작자가 여러명일 경우 첫번째 제작자만 반환한다.
at line 564
string
getVersion()
플러그인 버전을 조회한다.
at line 574
string
getLicense()
플러그인의 라이선스 정보를 조회한다.
at line 584
string[]
getDependencies()
플러그인의 의존성정보를 조회한다.
at line 611
array
getComponentList(string $type = null)
플러그인이 소유한 컴포넌트 목록을 조회한다. type이 지정돼 있을 경우 해당 type의 컴포넌트를 조회한다.
at line 642
void
bootComponents(PluginRegister $container)
call component boot interface
at line 660
static string
getComponentType(string $id)
주어진 컴포넌트 아이디에서 컴포넌트 타입정보를 조회한다.
at line 675
array
toArray()
플러그인 정보를 array형식으로 반환한다.
at line 693
string
toJson(int $options)
플러그인 정보를 json 형식으로 반환한다.
at line 706
mixed
__call(string $method, mixed $arguments)
이 PluginEntity의 메소드가 호출될 경우, 플러그인 인스턴스의 메소드가 호출되도록 한다.
at line 716
static PluginCollection
getCollection()
getCollection
at line 728
static void
setCollection(PluginCollection $collection)
PluginCollection을 지정한다.
at line 739
protected void
registerPluginAutoload()
플러그인이 composer autoload 파일을 가지고 있을 경우 autoload를 등록한다.
autoload 파일을 각 플러그인 디렉토리 내에 vendor/autoload.php 파일이다.
at line 752
bool
isDevelopMode()
개발모드 플러그인인지 검사한다. vendor 디렉토리를 가지고 있는지의 유무로 판단한다.