1. XpressEngine
Module제작가이드
작성자:오봉근,김예솔
소속팀/상위부서:XE개발팀
작성년월일:2011.11.26
ⓒ 2010NHNCORPORATION

2. 1.XE동작구조

3. index.php

4. Context
ModuleHandler
ProcModule
DisplayHandler
HTMLResponse

5. Context
ModuleHandler
ProcModule
DisplayHandler
HTMLResponse

6. 2.Memo모듈

7. Memo모듈기능
1. 메모쓰기
2. 메모리스트보기
3. 메모내용보기

8. 기능을Action으로!
1. 메모쓰기(화면):dispMemoWrite
2. 메모쓰기(DB삽입):procMemoInsert
3. 메모리스트보기(화면):dispMemoList
4. 메모내용보기(화면):dispMemoView

10. 3.Memo모듈구조

11. XE설치디렉토리/modules/memo/
conf memo.class.php
lang memo.controller.php
queries memo.model.php
rulesets memo.view.php
schemas
skins
tpl

12. memo.class.php
=memo모듈의최상위class
모듈설치시,모듈업데이트시

13. memo.controller.php
=memoControllerClass
DB/File에데이터저장,수정,삭제

14. memo.model.php
=memoModelClass
DB/File에서데이터읽기

15. memo.view.php
=memoViewClass
템플릿과연결하여화면출력

16. 4.기본파일생성

17. ./conf/info.xml
moduleversion=0.2
titlexml:lang=ko메모/title
descriptionxml:lang=ko메모모듈입니다./description
version0.1/version
date2011-10-14/date
categorycontent/category
authoremail_address=developers@xpressengine.com
link=http://xpressengine.com/
namexml:lang=koNHN/name
namexml:lang=jpNHN/name
namexml:lang=enNHN/name
/author
/module

18. ./conf/module.xml
module
grants/
permissions/
actions/
menus/
/module
http://code.google.com/p/xe-core/wiki/module_xml

19. memo.class.php
classmemoextendsModuleObject{
functionmoduleInstall(){}
functionmoduleUninstall(){}
functioncheckUpdate(){}
functionmoduleUpdate(){}
functionrecompileCache(){}
}

20. 5.본격적인개발

21. 5-1.Memo쓰기화면

23. /index.php?module=memoact=dispMemoWrite
Context memo.view.php
dispMemoWrite()
ModuleHandler
memo_view.html

24. /index.php?module=memoact=dispMemoWrite
Context memo.view.php
dispMemoWrite()
ModuleHandler
memo_view.html
module.xml

25. ./conf/module.xml
module
grants/
permissions/
actions
actionname=dispMemoWritetype=viewstandalone=true/
/actions
menus/
/module

26. /index.php?module=memoact=dispMemoWrite
Context memo.view.php
dispMemoWrite()
ModuleHandler
memo_write.html

27. memo.view.php
classMemoViewextendsmemo
{
functioninit()
{
$template_path=sprintf(%sskins/%s/,$this-module_path,
$this-module_info-skin);
if(!is_dir($template_path)||!$this-module_info-skin){
$this-module_info-skin=‘xe_default';
$template_path=sprintf(%sskins/%s/,$this-module_path,
$this-module_info-skin);
}
$this-setTemplatePath($template_path);
}
}

28. memo.view.php
classMemoViewextendsmemo
{
…⋯
functiondispMemoWrite()
{
if(!Context::get('is_logged'))
returnnewObject(-1,'msg_invalid_request');
$logged_info=Context::get('logged_info');
$this-setTemplateFile('memo_write');
}
}

29. /index.php?module=memoact=dispMemoWrite
Context memo.view.php
dispMemoWrite()
ModuleHandler
Template memo_write.html

30. ./skins/xe_default/memo_write.html
formruleset=insertMemoname=memo_writemethod=postaction=./
inputtype=hiddenname=modulevalue=memo/
inputtype=hiddenname=actvalue=procMemoInsert/
textareaname=contentcols=100rows=15/textarea
inputtype=submitvalue=등록
/form

31. c

32. c

33. /index.php?module=memoact=dispMemoWrite
Context memo.view.php
dispMemoWrite()
ModuleHandler
memo_write.html
ruleset insertMemo.xml

34. ./rulesets/insertMemo.xml
rulesetversion=1.5.0
customrules/
fields
fieldname=contentrequired=true/
/fields
/ruleset
http://code.google.com/p/xe-core/wiki/ValidateFormInput

35. ./skins/xe_default/memo_write.html
divcond=$XE_VALIDATOR_MESSAGE
class=message{$XE_VALIDATOR_MESSAGE_TYPE}
p{$XE_VALIDATOR_MESSAGE}/p
/div
formruleset=insertMemoname=memo_writemethod=postaction=./
inputtype=hiddenname=modulevalue=memo/
inputtype=hiddenname=actvalue=procMemoInsert/
textareaname=contentcols=100rows=15/textarea
inputtype=submitvalue=등록
/form

36. ./skins/xe_default/memo_write.html
divcond=$XE_VALIDATOR_MESSAGE
class=message{$XE_VALIDATOR_MESSAGE_TYPE}
p{$XE_VALIDATOR_MESSAGE}/p
/div
formruleset=insertMemoname=memo_writemethod=postaction=./
inputtype=hiddenname=modulevalue=memo/
inputtype=hiddenname=actvalue=procMemoInsert/
textareaname=contentcols=100rows=15/textarea
inputtype=submitvalue=등록
/form

37. 5-2.MemoDB저장

39. 메모등록!!
Context
memo.controller.php
procMemoInsert()
ModuleHandler
insertMemo.xml(xmlquery)
memo

40. ./conf/module.xml
module
grants/
permissions/
actions
actionname=dispMemoWritetype=viewstandalone=true/
actionname=procMemoInserttype=controller
standalone=trueruleset=insertMemo/
/actions
menus/
/module

41. 메모등록!!
Context
memo.controller.php
procMemoInsert()
ModuleHandler
insertMemo.xml(xmlquery)
memo

42. insertMemo.xml(XMLQuery)
queryid=insertMemoaction=insert
tables
tablename=memo/
/tables
columns
columnname=memo_srlvar=memoSrl“
notnull=notnullfilter=number/
columnname=member_srlvar=memberSrl“
notnull=notnullfilter=number/
columnname=contentvar=content/
columnname=regdatevar=regdatedefault=curdate()/
columnname=last_updatevar=lastUpdatedefault=curdate()/
columnname=ipaddressvar=ipaddressdefault=ipaddress()/
/columns
/query

43. 메모등록!!
Context
memo.controller.php
procMemoInsert()
ModuleHandler
insertMemo.xml(xmlquery)
memo

44. memo.controller.php
ClassmemoControllerextendsmemo
{
functionprocMemoInsert()
{
if(!Context::get('is_logged'))returnnewObject(-1,'msg_invalid_request');
$logged_info=Context::get('logged_info');
$vars=Context::getRequestVars();
$args-memoSrl=getNextSequence();
$args-memberSrl=$logged_info-member_srl;
$args-content=htmlspecialchars($vars-content);
$output=executeQuery('memo.insertMemo',$args);
if(!$output-toBool())returnnewObject(-1,'msg_error');
if(!in_array(Context::getRequestMethod(),array('XMLRPC','JSON'))){
$returnUrl=Context::get('success_return_url')?
Context::get('success_return_url'):
getNotEncodedUrl('','module','memo','act','dispMemoList');
$this-setRedirectUrl($returnUrl);
return;
}
return$output;
}

45. memo.controller.php
functionprocMemoInsert()
{
if(!Context::get('is_logged'))returnnewObject(-1,'msg_invalid_request');
$logged_info=Context::get('logged_info');
$vars=Context::getRequestVars();
$args-memoSrl=getNextSequence();
$args-memberSrl=$logged_info-member_srl;
$args-content=htmlspecialchars($vars-content);
$output=executeQuery('memo.insertMemo',$args);
if(!$output-toBool())returnnewObject(-1,'msg_error');

46. memo.controller.php
…⋯
if(!in_array(Context::getRequestMethod(),array('XMLRPC','JSON'))){
$returnUrl=Context::get('success_return_url')?
Context::get('success_return_url'):
getNotEncodedUrl('','module','memo','act','dispMemoList');
$this-setRedirectUrl($returnUrl);
return;
}
return$output;
}

47. 5-3.Memo목록화면

49. /index.php?module=memoact=dispMemoList
Context memo.view.php
dispMemoList()
ModuleHandler
memo_list.html

50. ./conf/module.xml
module
grants/
permissions/
actions
actionname=dispMemoWritetype=viewstandalone=true/
actionname=procMemoInserttype=controller“
standalone=trueruleset=insertMemo/
actionname=dispMemoListtype=viewstandalone=true/
/actions
menus/
/module

51. memo.model.php
memo.view.php
getMemoList()
dispMemoList()
getMemoList.xml
memo_list.html
memo

52. memo.model.php
classmemoModelextendsmemo
{
functiongetMemoList($member_srl,$page=1)
{
$args-memberSrl=$member_srl;
$args-page=$page;
$output=executeQuery('memo.getMemoList',$args);
if(!$output-toBool())returnnewObject(-1,'msg_error');
return$output;
}

53. ./queries/getMemoList.xml
queryid=getMemoListaction=select
tables
tablename=memo/
/tables
columns
columnname=*/
/columns
conditions
conditionoperation=equalcolumn=member_srl“
var=memberSrlfilter=numbernotnull=notnull/
/conditions
navigation
indexvar=list_orderdefault=memo_srlorder=desc/
list_countvar=list_countdefault=5/
page_countvar=page_countdefault=5/
pagevar=pagedefault=1/
/navigation
/query

54. memo.model.php
memo.view.php
getMemoList()
dispMemoList()
getMemoList.xml
memo_list.html
memo

55. memo.view.php
classmemoViewextendsmemo
{
…⋯
functiondispMemoList()
{
if(!Context::get('is_logged'))returnnewObject(-1,'msg_invalid_request');
$logged_info=Context::get('logged_info');
$oMemoModel=getModel('memo');
$output=$oMemoModel-getMemoList(
$logged_info-member_srl,Context::get('page'));
Context::set('memo_list',$output-data);
Context::set('total_count',$output-total_count);
Context::set('total_page',$output-total_page);
Context::set('page',$output-page);
Context::set('page_navigation',$output-page_navigation);
$this-setTemplateFile('memo_list');
}

56. memo.view.php
classmemoViewextendsmemo
{
…⋯
functiondispMemoList()
{
if(!Context::get('is_logged'))returnnewObject(-1,'msg_invalid_request');
$logged_info=Context::get('logged_info');
$oMemoModel=getModel('memo');
$output=$oMemoModel-getMemoList(
$logged_info-member_srl,Context::get('page'));
Context::set('memo_list',$output-data);
Context::set('total_count',$output-total_count);
Context::set('total_page',$output-total_page);
Context::set('page',$output-page);
Context::set('page_navigation',$output-page_navigation);
$this-setTemplateFile('memo_list');
}

57. memo.model.php
memo.view.php
getMemoList()
dispMemoList()
getMemoList.xml
memo_list.html
memo

58. memo_list.html
tbody
trloop=$memo_list=$key,$value
td{$value-memo_srl}/td
td
ahref={getUrl('','module','memo',
'act','dispMemoView','memo_srl',$value-memo_srl)}
{$value-content}/a/td
td{date('Y-m-dH:i:s',strtotime($value-regdate))}/td
td{date('Y-m-dH:i:s',strtotime($value-last_update))}/td
td
ahref={getUrl('','module','memo',
'act','procMemoDelete','memo_srl',$value-memo_srl)}
Delete/a/td
/tr
/tbody

59. 5-4.Memo보기

60. ./conf/module.xml
module
grants/
permissions/
actions
actionname=dispMemoWritetype=viewstandalone=true/
actionname=procMemoInserttype=controller“
standalone=trueruleset=insertMemo/
actionname=dispMemoListtype=viewstandalone=true/
actionname=dispMemoViewtype=viewstandalone=true/
/actions
menus/
/module

61. memo.view.php
classmemoViewextendsmemo
{
…⋯
functiondispMemoView()
{
$memo_srl=Context::get('memo_srl');
$oMemoModel=getModel('memo');
$output=$oMemoModel-getMemo($memo_srl);
Context::set('memo',$output-data);
$this-setTemplateFile('memo_view');
}

62. memo.model.php
classmemoModelextendsmemo
{
…⋯
functiongetMemo($memo_srl)
{
$args-memoSrl=$memo_srl;
$output=executeQuery('memo.getMemo',$args);
if(!$output-toBool())returnnewObject(-1,'msg_error');
return$output;
}

63. ./skins/xe_default/memo_view.html
ul
limemo_srl:{$memo-memo_srl}/li
limember_srl:{$memo-member_srl}/li
licontent:{$memo-content}/li
liregdate:{$memo-regdate}/li
lilast_update:{$memo-last_update}/li
liipaddress:{$memo-ipaddress}/li
liother_column:{$memo-other_column}/li
/ul
br/
ahref={getUrl('','module','memo',
'act','dispMemoModify','memo_srl',$memo_srl)}수정/a

64. 6.memo모듈정리

65. memo.class.php ./conf/info.xml
memo.view.php
./conf/module.xml
memo.model.php
./ruleset/insertMemo.xml
memo.controller.php
./queries/insertMemo.xml
./skins/xe_default/*.html

66. Thankyou.