모듈 확장과 모델(Model)
관리자를 위한 백 엔드 뷰(View)가 실행되면 관리자-인덱스로 설정했던 dispExampleAdminList 액션이 작동하고 그 진행과정을 설명한 그림이다. 또한 앞으로 만들게 될 관리자 목록 보기를 위한 설계도이다. 이 과정에서는 어드민 모델(example.admin.model.php)을 이용할 계획이다. 실제로 게시판(Board) 모듈에서는 2번이 생략되고 곧장 쿼리(query)를 실행하여 xe_modules 테이블에서 필요한 값을 찾아 온다. 하지만 학습에 필요한 예제이기 때문에 모델(Model)을 활용하는 방법으로 진행하고자 한다.
XE코어의 모듈 중에는 모듈(module)이라는 이름의 모듈이 있다.(혼동하기 않기 위해 앞으로 module 이라고 표기한다.)
이 module이 하는 일은 다른 모듈들이 만든 모듈의 식별 번호(module_srl) 또는 모듈의 아이디(mid)를 등록하고 관리하는 일을 한다. 즉 module을 확장(extends)하여 사용한다는 것은 추가된 모듈(example 모듈)이 앞으로 만들게 될 모듈의 아이디(mid)를 module이 관리하는 테이블(xe_modules)에 등록하고 사용할 수 있도록 module의 도움을 받겠다는 뜻이다.
예를 들어, 게시판 모듈을 1개 생성하면 새로운 모듈 고유 번호(module_srl)와 모듈의 아이디(mid)가 만들어지고 이 게시판에서 작성된 글은 새로운 문서 고유 번호(document_srl)가 붙게 된다. 그런데 이 문서는 어디를 가든지 부모의 이름을 가지고 다닌다. 즉 어느 부모의 자식인지 알 수 있도록 모듈 번호(module_srl)를 함께 저장해 두었다는 뜻이다. (옛날 주민등록증에는 자신의 이름 밑에 부모의 이름이 함께 기록되어 있었다...^^)
관리자 목록은 module을 확장하여 앞으로 example 모듈이 생성하게 될 모듈의 아이디와 모듈 번호, 즉 모듈의 정보를 module 테이블에 등록하고 조회/수정/삭제하는 기능을 하게 된다.
1. 관리자 목록
최종적인 결과물을 목록으로 출력하는 관리자 페이지를 먼저 만들어 보자. 6번에서 처럼 $example_list 변수가 값을 받아 올 것이다. $example_list 변수는 배열의 형태이고 foreach 문을 이용해 루프 형식으로 각각 값에 접근하여 출력한다. tpl/index.html에 다음의 내용을 추가하고 업로드한다.
tpl/index.html
<!-- 목록 -->
<table cellspacing="0" class="rowTable">
<thead>
<tr>
<th scope="col"><div>{$lang->no}</div></th>
<th scope="col" class="half_wide"><div>{$lang->mid}</div></th>
<th scope="col" class="half_wide"><div>{$lang->browser_title}</div></th>
<th scope="col"><div>{$lang->regdate}</div></th>
<th scope="col" colspan="2"><div> </div></th>
</tr>
</thead>
<tbody>
<!-- 모듈의 관리자 목록 시작 -->
<!--@foreach($example_list as $no => $val)-->
<tr class="row{$cycle_idx}">
<td class="center number">{$no}</td>
<td>{htmlspecialchars($val->mid)}</td>
<td><a href="{getUrl('','mid',$val->mid)}">{$val->browser_title}</a></td>
<td class="nowrap">{zdate($val->regdate,"Y-m-d")}</td>
<td><a href="{getUrl('act','dispExampleAdminInfo','module_srl',$val->module_srl)}" class="buttonSet buttonSetting" title="{$lang->cmd_setup}"><span>{$lang->cmd_setup}</span></a></td>
<td><a href="{getUrl('act','dispExampleAdminDelete','module_srl', $val->module_srl)}" class="buttonSet buttonDelete" title="{$lang->cmd_delete}"><span>{$lang->cmd_delete}</span></a></td>
</tr>
<!--@end-->
<!-- // 모듈의 관리자 목록 끝 -->
</tbody>
</table>
| 언어팩 | {$lang->no} | {$lang->mid} | {$lang->browser_title} | {$lang->regdate} |
|---|---|---|---|---|
| lang/ko.lank.php | 번호 | 모듈 이름 | 브라우저 제목 | 등록일 |
| 변수 출력 | {$no} | {htmlspecialchars($val->mid)} | {$val->browser_title} | {zdate($val->regdate,"Y-m-d")} |
모듈은 언어팩(lang)을 사용한다. 지금은 관리자 페이지를 만들고 있기 때문에 대부분의 단어들은 xe/common/lang/ko.lang.php 파일의 지원을 받을 수 있다. 만약 공통 언어로 등록되어 있는 단어가 아닌 새로운 단어를 추가하고 사용하려면 example 모듈에 lang/ 폴더를 새로 만들고 ko.lang.php 파일에 미리 추가해 두어야 한다.(example/lang/ko.lang.php) foreach 문을 이용해 키와 값으로 분리된 변수의 값을 해당 셀(cell)에 출력한다는 내용이다.
모듈의 설정과 삭제에 대한 액션은 다음 과정에서 진행하기 때문에 우선 넣어 두도록 한다.
2. example.admin.view.php
이전에 작성했던 어드민 뷰 파일에서 템플릿 설정 부분과 함께 추가된 내용을 포함하여 업로드 한다.
<?php
/**
* @class exampleAdminView
* @author XE스쿨 모듈 만들기 예제
* @brief example 모듈의 admin view class
**/
class exampleAdminView extends example {
/**
* @brief 초기화
**/
function init() {
// module_srl이 있으면 미리 체크하여 존재하는 모듈이면 module_info 세팅
$module_srl = Context::get('module_srl');
if(!$module_srl && $this->module_srl) {
$module_srl = $this->module_srl;
Context::set('module_srl', $module_srl);
}
// module model 객체 생성
$oModuleModel = &getModel;('module');
// module_srl이 넘어오면 해당 모듈의 정보를 미리 구해 놓음
// 브라우져 타이틀, 관리자, 레이아웃 등 xe_modules table의 값과 정보
if($module_srl) {
$module_info = $oModuleModel->getModuleInfoByModuleSrl($module_srl);
$this->module_info = $module_info;
Context::set('module_info',$module_info);
}
// 관리자 템플릿 파일의 경로 설정 (tpl)
$template_path = sprintf("%stpl/",$this->module_path);
$this->setTemplatePath($template_path);
}
/**
* @brief 관리자 목록
**/
function dispExampleAdminList() {
// 페이지 네비게시션을 위한 설정
$page = Context::get('page');
if(!$page) $page = 1;
$args->page = $page;
// example admin model 객체 생성
$oExampleAdminModel = &getAdminModel;('example');
// example module_srl 목록 가져옴
$output = $oExampleAdminModel->getExampleAdminList($args);
// 템플릿에 전해주기 위해 set함
Context::set('example_list', $output->data);
Context::set('page_navigation', $output->page_navigation);
// 관리자 목록(mid) 보기 템플릿 지정(tpl/index.html)
$this->setTemplateFile('index');
}
}
?>
module이 가지고 있는 모델(model)의 객체를 생성한다는 것은 module이 사용하는 방법(메소드)을 나도(example) 여기에서(exampleAdminView) 도움을 받고 싶다는 뜻이다. 당연히 module이 사용하는 모델의 메소드는 자신이 관리하고 있는 xe_modules 테이블을 조회하고 모듈의 다양한 정보들을 확인하고 체크하는 일일 것이다. 그러한 준비가 되었다면 구해온 모듈의 정보($module_info)를 템플릿 파일에 보내기 위해 URL 뒤에 붙인다. 이것이 Context::set() 이다.
다시말해서 초기화(init) 부분에서는 일단 요청이 들어온 URL 뒤에 $module_srl 이 있는지 확인해 보고, 있다면 module 모델을 확장하여 어떤 모듈인지 정보를 달라고 module 모델의 메소드를 실행해 보고, 반환된 모듈의 정보 값을 템플릿에 보내기 위해 예쁘게 세팅해 둔다...^^
관리자 메뉴에서 모듈(example)을 클릭하면 dispExampleAdminList() 함수를 찾아서 실행한다. dispExampleAdminList 액션은 이미 module.xml 파일에서 어드민-인덱스로 작성해 두었기 때문이다. 목록을 만들 준비를 하기 위해 페이지에 대한 사전 작업을 해 둔다. 이번에는 내가(example) 사용하는 모델(Model)을 확장한다. 왜냐하면 xe_modules 테이블에서 module 컬럼을 확인하고 example 이라고 등록된 모듈이 있는지 조회하고 그 결과를 반환 받기 위해서다.
따라서 example.admin.model.php 파일을 만들고 목록을 조회할 수 있는 방법(메소드)를 포함시켜야 하는데 getExampleAdminList() 함수가 그 메소드이다. 이때 페이지 변수는 우선 "1"이라고 초기화하여 함께 보낸다. 결과값은 $output 변수로 반환 받는데 일단 같은 이름으로 $output 변수에 대입해 둔다. 반환 받은 값은 다차원 배열이기 때문에 그 중에서 실제로 원하는 값은 $output->data 에 역시 배열의 형태로 들어 있다. 이것을 URL 에 붙여 보내기 위해 $output->data 값만 뽑아서 $example_list 변수에 대입하여 보내는 것이다. 반환 받은 값에는 페이지에 대한 정보도 포함되어 있을 것이다. 이것도 같이 세팅해 보낸다...^^
목록을 가져오기 위해서 모델(Model)을 사용하지 않고 $output = executeQueryArray('example.getExampleList', $args); 의 형태로 직접 쿼리를 호출할 수도 있다. 물론 example 모듈이 queries 폴더에 가지고 있는 getExampleList.xml 쿼리 파일을 찾는다.(모델을 경유하지 않고 찾는 것이다.) 어떤 방법을 사용해도 좋지만 여기서는 모델(Model)을 애용(?)하는 방법에 대해 공부하고 있다...^^
3. example.admin.model.php
example 모듈의 어드민 모델(Model) 파일이다. 새로 작성하여 업로드 한다.
<?php
/**
* @class exampleAdminModel
* @author XE스쿨 모듈 만들기 예제
* @brief example 모듈의 admin model class
**/
class exampleAdminModel extends example {
/**
* @brief 초기화
**/
function init() {
}
function getExampleAdminList($args){
$output = executeQueryArray('example.getExampleList', $args);
return $output;
}
}
?>
위에서 설명했던 것 처럼 모델을 경유하는 것만 다를 뿐 같은 쿼리 요청이다. 모듈이 가지고 있는 queries 폴더에서 getExampleList.xml 파일을 찾아 실행하라는 뜻이다. 쿼리문은 XML 형식으로 작성되어 있다.(p.41) 따라온 인자들($args)은 계속 같이 전달해 준다...^^ 쿼리를 실행한 결과값은 $output으로 반환한다.
4. XML 쿼리
queries/getExampleList.xml
<query id="getExampleList" action="select">
<tables>
<table name="modules" />
</tables>
<columns>
<column name="*" />
</columns>
<conditions>
<condition operation="equal" column="module" default="example" />
</conditions>
<navigation>
<index var="sort_index" default="module_srl" order="desc" />
<list_count var="list_count" default="20" />
<page_count var="page_count" default="10" />
<page var="page" default="1" />
</navigation>
</query>
XML 쿼리에 사용되는 요소와 속성에 대한 설명은 개발자 메뉴얼 p.41에 자세히 기술되어 있다. 중요한 것은 쿼리 파일의 이름이 요청 함수에서 설정한 이름과 항상 똑같아야 하고 쿼리 ID 역시 같아야 한다는 것, 그리고 함수에서 요청된 쿼리 파일은 항상 queries 폴더 안을 찾게 된다는 것이다. 기타 속성에 대한 설명은 모두 열거할 수 없기 때문에 다음과 같이 우선 간단히 정리하자.
위의 쿼리문은 다음과 같은 내용이다.
SELECT * FROM xe_modules WHERE ( module = 'example');
XE코어의 데이터베이스(DB)에 접속하여 xe_modules 테이블에 있는 모든(*) 내용을 선택하라는 뜻이다. 그런데 단 조건이 1개 있다. module 컬럼에 example 이라는 문자열이 있는 row 데이터만 골라 오라는 것이다...^^ 예를 들어 게시판(Board) 모듈이 만든 모듈은 board라고 적어 두었을 것이다. 그것은 제외하고..., 페이지(Page) 모듈이 만든것은 page라고 적어 두었을 것이다. 그것도 제외하고..., 외부페이지(Opage) 그것도 제외하고 내 것만 가져오라는 뜻이다...^^
이렇게 골라온 내용에다가 한 페이지에서 보여줄 목록의 갯수와 나누어지는 페이지의 갯수를 정리하고 모듈의 고유 번호(module_srl)를 기준으로 정렬하여 돌려 보낸다. 결과적으로 이렇게 구한 값은 $output 으로 반환되고 그 중에서 실제로 필요한 내용이 담긴 $output->data 를 $example_list 에 대입하여 관리자 뷰(View) 파일로 보낸다. 그리고 처음에 만들었던 관리자 목록에서 배열을 키와 값($val)으로 분해한 뒤 목록을 만들어 출력하는 것이다.
5. 결과 확인
당연히 아무것도 출력되지 않는다...^^ 입력된 내용이 없으니까...^^
정말로 궁금하면 default="example"에서 example을 board 또는 page로 수정해 보고 목록이 출력 되는지 확인해 보자...^^
