PHP Class Xpressengine\Plugin\AbstractPlugin

See link: https://xpressengine.io
Author: XE Developers ([email protected])
ファイルを表示 Open project: xpressengine/xpressengine Class Usage Examples

Public Methods

Method Description
__construct ( ) 플러그인 인스턴스를 생성한다 기본적으로 그 디렉토리명을 id로 사용한다.
activate ( string | null $installedVersion = null ) : void 플러그인을 활성화한다. 플러그인이 활성화될 때 실행할 코드를 여기에 작성한다.
asset ( string $path, string $secure = null ) : string 해당 플러그인의 asset 파일 주소를 반환한다.
boot ( ) : void 이 메소드는 활성화(activate) 된 플러그인이 부트될 때 항상 실행된다.
checkInstalled ( ) : boolean 해당 플러그인이 설치된 상태라면 true, 설치되어있지 않다면 false를 반환한다.
checkUpdated ( ) : boolean 해당 플러그인이 최신 상태로 업데이트가 된 상태라면 true, 업데이트가 필요한 상태라면 false를 반환함.
deactivate ( string | null $installedVersion = null ) : void 플러그인을 비활성화한다. 플러그인이 비활성화될 때 실행할 코드를 여기에 작성한다
getId ( ) : array | mixed
getIdWith ( string $postfix = '', string $delimiter = '::' ) : string 플러그인의 id에 주어진 인자를 덧붙여서 반환한다.
getPath ( string $path = '' ) : string 해당 플러그인의 설치 경로를 반환한다.
getSettingsURI ( ) : string 플러그인의 설정페이지 주소를 반환한다.
install ( ) : void 플러그인을 설치한다. 플러그인이 설치될 때 실행할 코드를 여기에 작성한다
path ( string $path = '' ) : string 해당 플러그인의 설치 경로를 반환한다.
uninstall ( ) : void 플러그인을 설치해제한다. 플러그인 디렉토리가 XpressEngine에서 삭제되기 전에 실행될 코드를 여기에 추가한다.
update ( ) : void 플러그인을 업데이트한다. 플러그인의 소스코드가 XpressEngine에 적용돼 있는 버전보다 최신일 경우 실행된다.
view ( string $view ) : string view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.

Method Details

__construct() public method

플러그인 인스턴스를 생성한다 기본적으로 그 디렉토리명을 id로 사용한다.
public __construct ( )

activate() public method

플러그인을 활성화한다. 플러그인이 활성화될 때 실행할 코드를 여기에 작성한다.
public activate ( string | null $installedVersion = null ) : void
$installedVersion string | null 현재 XpressEngine에 설치된 플러그인의 버전정보
return void

asset() public static method

해당 플러그인의 asset 파일 주소를 반환한다.
public static asset ( string $path, string $secure = null ) : string
$path string path가 주어질 경우 주어진 파일의 URL을 반환한다. path는 해당 플러그인 디렉토리 내에서의 상대 경로이어야 한다.
$secure string https 여부
return string

boot() abstract public method

이 메소드는 활성화(activate) 된 플러그인이 부트될 때 항상 실행된다.
abstract public boot ( ) : void
return void

checkInstalled() public method

이 메소드를 구현하지 않았다면 기본적으로 XE에 설치된 것으로 간주한다.
public checkInstalled ( ) : boolean
return boolean 플러그인의 설치 유무

checkUpdated() public method

이 메소드를 구현하지 않았다면 기본적으로 최신업데이트 상태임(true)을 반환함.
public checkUpdated ( ) : boolean
return boolean 플러그인의 설치 유무,

deactivate() public method

플러그인을 비활성화한다. 플러그인이 비활성화될 때 실행할 코드를 여기에 작성한다
public deactivate ( string | null $installedVersion = null ) : void
$installedVersion string | null 현재 XpressEngine에 설치된 플러그인의 버전정보
return void

getId() public static method

public static getId ( ) : array | mixed
return array | mixed

getIdWith() public static method

플러그인의 id에 주어진 인자를 덧붙여서 반환한다.
public static getIdWith ( string $postfix = '', string $delimiter = '::' ) : string
$postfix string 아이디 뒤에 추가할 문자열
$delimiter string 아이디와 추가할 문자열 사이의 구분자
return string 플러그인 id

getPath() public static method

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

getSettingsURI() public method

플러그인 목록에서 플러그인의 '관리' 버튼을 누를 경우 이 페이지에서 반환하는 주소로 연결된다.
public getSettingsURI ( ) : string
return string

install() public method

플러그인을 설치한다. 플러그인이 설치될 때 실행할 코드를 여기에 작성한다
public install ( ) : void
return void

path() public static method

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

uninstall() public method

플러그인을 설치해제한다. 플러그인 디렉토리가 XpressEngine에서 삭제되기 전에 실행될 코드를 여기에 추가한다.
public uninstall ( ) : void
return void

update() public method

플러그인을 업데이트한다. 플러그인의 소스코드가 XpressEngine에 적용돼 있는 버전보다 최신일 경우 실행된다.
public update ( ) : void
return void

view() public static method

view name을 반환한다. 템플릿 파일 작성시 편의를 위해 사용한다.
public static view ( string $view ) : string
$view string view name
return string