• Home
• Xpressengine
• Document
• DocumentHandler

PHP Class Xpressengine\Document\DocumentHandler

## app binding * xe.document 로 바인딩 되어 있음 * Document facade 제공 ## 사용법 ### Instance 생성 php $documentHandler = app('xe.document'); $configEntity = $documentHandler->createInstance('newInstanceId'); $instanceManager->add($configEntity); ### 문서 등록 php $id = (new Keygen())->generate(); $inputs = ['id'=>$id', 'instanceId'=>'instance-id', 'title'=>'title', 'content'=>'content' ...]; $doc = new DocumentEntity($inputs); $documentHandler->add($doc); ### 문서 수정 php $doc = $documentHandler->get('document-id', 'instance-id'); $doc->title = 'changed title'; app('xe.document')->update($doc); ### 문서 삭제 php $doc = $documentHandler->get('document-id', 'instance-id'); app('xe.document')->remove($doc); ### 문서 조회 php instance id, document id 로 문서 갖고오기 $doc = $documentHandler->get('document-id', 'instance-id'); document id 로 문서 조회 $doc = $documentHandler->getById('document-id'); ### 문서 수 조회 php 전체 문서 수 조회회 $count = $documentHandler->count(); 인스턴스의 전체 문서 수 조회 $count = $documentHandler->countByInstanceId('instance-id'); ### 문서 목록 조회 php $wheres, $orders 는 Repository\DocumentRepository 참고 $wheres = []; $orders = []; $docs = $documentHandler->gets($wheres, $orders, 20); $paginate = $documentHandler->paginate($wheres, $orders, 20); ## 기타 ### Interception * Comment count 를 위해 DocumentServiceProvider 에서 Interception 등록 Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property	Type	Description
$configHandler	ConfigHandler
$conn	Xpressengine\Database\VirtualConnectionInterface
$instanceManager	InstanceManager
$model		model class
$request	Illuminate\Http\Request
$revisionModel		model class

Public Methods

Method	Description
__construct ( Xpressengine\Database\VirtualConnectionInterface $conn, ConfigHandler $configHandler, InstanceManager $instanceManager, Illuminate\Http\Request $request )
add ( array $attributes ) : Document	add document
addRevision ( Document $doc ) : boolean	add revision
createInstance ( string $instanceId, array $params = [] ) : ConfigEntity	create document instance
destroyInstance ( string $instanceId, integer $chunk = 100 ) : void	destroy document instance
get ( string $id, string $instanceId = null ) : Document	get document
getConfig ( string $instanceId ) : ConfigEntity	get document config
getConfigHandler ( ) : ConfigHandler	get config handler
getDivisionTableName ( ConfigEntity $config ) : string	get division table name
getInstanceManager ( ) : InstanceManager	get repository
getModel ( string $instanceId = null ) : Document	Proxy, Division 관련 설정이 된 Document model 반환 Document 는 config 를 설정해야 정상 사용 가능함 document model 를 직접 반환하지 않음
proxyOption ( ConfigEntity $config = null ) : array	get database proxy options
put ( Document $doc ) : Document	update document
remove ( Document $doc ) : boolean	delete document
setModelConfig ( Document $doc, string $instanceId ) : Document	set model's config

Protected Methods

Method	Description
getRevisionModel ( ) : Revision	get revision model
newModel ( ) : Document	create document model config 없이 모델을 직접 생성할 경우 문제가 발생하므로 접근을 제한함
newRevisionModel ( array $attributes = [] ) : Revision	create revision model
removeDivision ( Document $doc ) : void	인스턴스 아이디가 변경된 경우 이전 인스턴스의 디비전 테이블 데이터 삭제

Method Details

Property Details