PHP Class Xpressengine\DynamicField\AbstractType

Author: XE Team (developers) ([email protected])

Inheritance: implements Xpressengine\Plugin\ComponentInterface, use trait Xpressengine\Plugin\ComponentTrait

Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property	Type	Description
$columns	ColumnEntity[]	database table's column ColumnEntity 의 array
$config	Xpressengine\Config\ConfigEntity
$description	string	field type description
$handler	DynamicFieldHandler
$name	string	field type name
$rules	array	validation rules
$settingsRules	array	validation settings rules
$skin	AbstractSkin

Public Methods

Method	Description
__construct ( DynamicFieldHandler $handler )	create instance
boot ( ) : void	boot
create ( ColumnEntity $column ) : void	Dynamic Field 생성 시 처리해야 할 사항들
delete ( array $wheres ) : void	생성된 Dynamic Field 테이블에 데이터 삭제
description ( ) : string	get field type description
drop ( ) : void	Dynamic Field 삭제 시 처리해야 할 사항들
first ( DynamicQuery $query ) : Builder	$query 에 outer join 된 쿼리를 리턴
get ( DynamicQuery $query ) : Builder	$query 에 inner join 된 쿼리를 리턴
getColumns ( ) : ColumnEntity[]	return columns
getConfig ( ) : ConfigEntity	get dynamic field config
getRules ( ) : array	return rules
getSettingsRules ( ) : array	다이나믹필스 생성할 때 타입 설정에 적용될 rule 반환
getSettingsURI ( ) : null \| string	get manage uri
getSettingsView ( ConfigEntity $config = null ) : string	Dynamic Field 설정 페이지에서 각 fieldType 에 필요한 설정 등록 페이지 반환 return html tag string
getSkin ( ) : AbstractSkin	get skin
insert ( array $args ) : void	생성된 Dynamic Field 테이블에 데이터 입력
insertRevision ( array $args ) : void	생성된 Dynamic Field revision 테이블에 데이터 입력
join ( DynamicQuery $query, ConfigEntity $config = null ) : Builder	table join
joinRevision ( DynamicQuery $query ) : Builder	$query 에 join 된 쿼리를 리턴
name ( ) : string	get field type name
orders ( DynamicQuery $query, array $params ) : Builder	query order 처리
setConfig ( ConfigEntity $config ) : void	set config
setSkin ( AbstractSkin $skin ) : void	set skin instance
update ( array $args, array $wheres ) : void	생성된 Dynamic Field 테이블에 데이터 수정
wheres ( DynamicQuery $query, array $params ) : Builder	query where 처리

Private Methods

Method	Description
createField ( ) : void	Dynamic Field 생성 시 alter table 로 처리 이 기능은 관리자에서 지원하지 않음 테이블 수정 시 발생항할 수있는 문제가 있기 때문에 기능만 제공 이 기능을 사용하면서 방생하는 문제는 사용자 책임
createFieldRevision ( ) : void	Dynamic Field 생성 시 alter table 로 revision table 처리 이 기능은 관리자에서 지원하지 않음 테이블 수정 시 발생항할 수있는 문제가 있기 때문에 기능만 제공 이 기능을 사용하면서 방생하는 문제는 사용자 책임
createRevisionTable ( ColumnEntity $column ) : void	Dynamic Field Type revision 테이블 생성
createTable ( ColumnEntity $column ) : void	Dynamic Field Type 테이블 생성
dropField ( ) : void	Dynamic Field 삭제 시 alter table 로 처리
dropTable ( ) : void	Dynamic Field 삭제 시 테이블 삭제
parseWhere ( array $wheres ) : array	update, delete 처리 시 전달되는 wheres 에서 id를 추출 한다.

Method Details

__construct() public method

create instance

public __construct ( DynamicFieldHandler $handler )
$handler	DynamicFieldHandler	dynamic field handler

boot() public static method

boot

public static boot ( ) : void
return	void

create() public method

Dynamic Field 생성 시 처리해야 할 사항들

public create ( ColumnEntity $column ) : void
$column	ColumnEntity	join column entity
return	void

delete() public method

생성된 Dynamic Field 테이블에 데이터 삭제

public delete ( array $wheres ) : void
$wheres	array	Illuminate\Database\Query\Builder's wheres attribute wheres attribute
return	void

description() abstract public method

get field type description

abstract public description ( ) : string
return	string

drop() public method

Dynamic Field 삭제 시 처리해야 할 사항들

public drop ( ) : void
return	void

first() public method

$query 에 outer join 된 쿼리를 리턴

public first ( DynamicQuery $query ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
return	Illuminate\Database\Query\Builder

get() public method

$query 에 inner join 된 쿼리를 리턴

public get ( DynamicQuery $query ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
return	Illuminate\Database\Query\Builder

getColumns() abstract public method

return columns

abstract public getColumns ( ) : ColumnEntity[]
return	ColumnEntity[]

getConfig() public method

get dynamic field config

public getConfig ( ) : ConfigEntity
return	Xpressengine\Config\ConfigEntity

getRules() abstract public method

return rules

abstract public getRules ( ) : array
return	array

getSettingsRules() abstract public method

다이나믹필스 생성할 때 타입 설정에 적용될 rule 반환

abstract public getSettingsRules ( ) : array
return	array

getSettingsURI() public static method

get manage uri

public static getSettingsURI ( ) : null \| string
return	null \| string

getSettingsView() abstract public method

Dynamic Field 설정 페이지에서 각 fieldType 에 필요한 설정 등록 페이지 반환 return html tag string

abstract public getSettingsView ( ConfigEntity $config = null ) : string
$config	Xpressengine\Config\ConfigEntity	config entity
return	string

getSkin() public method

get skin

public getSkin ( ) : AbstractSkin
return	AbstractSkin

insert() public method

생성된 Dynamic Field 테이블에 데이터 입력

public insert ( array $args ) : void
$args	array	parameters
return	void

insertRevision() public method

생성된 Dynamic Field revision 테이블에 데이터 입력

public insertRevision ( array $args ) : void
$args	array	parameters
return	void

join() public method

table join

public join ( DynamicQuery $query, ConfigEntity $config = null ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
$config	Xpressengine\Config\ConfigEntity	config entity
return	Illuminate\Database\Query\Builder

joinRevision() public method

$query 에 join 된 쿼리를 리턴

public joinRevision ( DynamicQuery $query ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
return	Illuminate\Database\Query\Builder

name() abstract public method

get field type name

abstract public name ( ) : string
return	string

orders() public method

query order 처리

public orders ( DynamicQuery $query, array $params ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
$params	array	parameters for search
return	Illuminate\Database\Query\Builder

setConfig() public method

set config

public setConfig ( ConfigEntity $config ) : void
$config	Xpressengine\Config\ConfigEntity	dynamic field config entity
return	void

setSkin() public method

set skin instance

public setSkin ( AbstractSkin $skin ) : void
$skin	AbstractSkin	skin
return	void

update() public method

생성된 Dynamic Field 테이블에 데이터 수정

public update ( array $args, array $wheres ) : void
$args	array	parameters
$wheres	array	Illuminate\Database\Query\Builder's wheres attribute
return	void

wheres() public method

query where 처리

public wheres ( DynamicQuery $query, array $params ) : Builder
$query	Xpressengine\Database\DynamicQuery	query builder
$params	array	parameters for search
return	Illuminate\Database\Query\Builder

Property Details

$columns protected property

database table's column ColumnEntity 의 array

protected ColumnEntity[],Xpressengine\DynamicField $columns
return	ColumnEntity[]

$config protected property

protected ConfigEntity,Xpressengine\Config $config
return	Xpressengine\Config\ConfigEntity

$description protected property

field type description

protected string $description
return	string

$handler protected property

protected DynamicFieldHandler,Xpressengine\DynamicField $handler
return	DynamicFieldHandler

$name protected property

field type name

protected string $name
return	string

$rules protected property

validation rules

protected array $rules
return	array

$settingsRules protected property

validation settings rules

protected array $settingsRules
return	array

$skin protected property

protected AbstractSkin,Xpressengine\DynamicField $skin
return	AbstractSkin