PHP 클래스 Xpressengine\Document\ConfigHandler

## 사용법 ### Default config 조회 php $config = $configHandler->getDefault(); ### Config 조회 php $config = $configHandler->get('instance-id'); ### Config 목록 조회 php $configs = $configHandler->gets(); ### Config 생성 * 인스턴스 생성할 때 Document Config 추가가 php $params = []; $config = $configHandler->makeEntity('instance-id', $params); $config = $configHandler->add($config); ### Config 수정 php $config = $config; $configHandler->put($config); ### Config 삭제 php $config = $config; $configHandler->remove($config);
저자: XE Team (developers) ([email protected])
파일 보기 프로젝트 열기: xpressengine/xpressengine 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$configManager Xpressengine\Config\ConfigManager ConfigManager instance
$default array

공개 메소드들

메소드 설명
__construct ( ConfigManager $configManager ) create instance
add ( ConfigEntity $config ) : ConfigEntity create document instance
get ( string $instanceId = null ) : ConfigEntity get config Entity $instanceId 가 없을 경우 default config 반환
getConfigManager ( ) : ConfigManager get config handler instance
getDefault ( ) : ConfigEntity get default config
getOrDefault ( string $instanceId ) : ConfigEntity Return default config when cannot found config
gets ( ) : array config entity list 반환 list of ConfigEntity
make ( string $instanceId, array $params ) : ConfigEntity 새로운 document config entity 를 만들어 반환
put ( ConfigEntity $config ) : ConfigEntity update document instance config * Cannot changed 'division', 'revision' configure.
remove ( ConfigEntity $config ) : void drop document instance

메소드 상세

__construct() 공개 메소드

create instance
public __construct ( ConfigManager $configManager )
$configManager Xpressengine\Config\ConfigManager ConfigManager instance

add() 공개 메소드

create document instance
public add ( ConfigEntity $config ) : ConfigEntity
$config Xpressengine\Config\ConfigEntity document instance config
리턴 Xpressengine\Config\ConfigEntity

get() 공개 메소드

get config Entity $instanceId 가 없을 경우 default config 반환
public get ( string $instanceId = null ) : ConfigEntity
$instanceId string instance id
리턴 Xpressengine\Config\ConfigEntity

getConfigManager() 공개 메소드

get config handler instance
public getConfigManager ( ) : ConfigManager
리턴 Xpressengine\Config\ConfigManager

getDefault() 공개 메소드

get default config
public getDefault ( ) : ConfigEntity
리턴 Xpressengine\Config\ConfigEntity

getOrDefault() 공개 메소드

Return default config when cannot found config
public getOrDefault ( string $instanceId ) : ConfigEntity
$instanceId string instance id
리턴 Xpressengine\Config\ConfigEntity

gets() 공개 메소드

config entity list 반환 list of ConfigEntity
public gets ( ) : array
리턴 array

make() 공개 메소드

새로운 document config entity 를 만들어 반환
public make ( string $instanceId, array $params ) : ConfigEntity
$instanceId string instance id
$params array parameters
리턴 Xpressengine\Config\ConfigEntity

put() 공개 메소드

update document instance config * Cannot changed 'division', 'revision' configure.
public put ( ConfigEntity $config ) : ConfigEntity
$config Xpressengine\Config\ConfigEntity document instance config
리턴 Xpressengine\Config\ConfigEntity

remove() 공개 메소드

drop document instance
public remove ( ConfigEntity $config ) : void
$config Xpressengine\Config\ConfigEntity config
리턴 void

프로퍼티 상세

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

ConfigManager instance
protected ConfigManager,Xpressengine\Config $configManager
리턴 Xpressengine\Config\ConfigManager

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

protected array $default
리턴 array