플러그인 개발 시작하기

Last updated 29 days ago

플러그인 생성 커맨드

처음 플러그인 개발을 시작할 때 부딪히는 난관은 플러그인에 필요한 기본적인 디렉토리와 파일들을 직접 생성하는 것입니다. 만약 my_plugin이라는 플러그인을 하나 만들기 시작한다면, 우선 plugins 디렉토리에 my_plugin이라는 이름의 디렉토리를 만들고, 그 안에 plugin.php, composer.json 파일을 만드는 것부터 시작해야 합니다. 이러한 수고를 줄이기 위하여 XE는 플러그인 생성 커맨드를 제공합니다.

플러그인 생성 커맨드를 사용해서 만든 플러그인은 웹페이지를 출력하는 기본적인 기능을 샘플로 포함하고 있습니다. 원치 않을 경우 샘플 웹페이지 출력 기능을 삭제하시고, 플러그인 개발을 시작하시기 바랍니다.

터미널에서 아래와 같이 명령어를 실행하십시오.

$ php artisan make:plugin <name> <vendor>

name 파라메터는 플러그인의 고유 id입니다. 플러그인의 디렉토리 이름으로도 사용됩니다.

vendor 파라메터에는 플러그인 클래스의 네임스페이스 첫자리를 지정합니다. 지정한 네임스페이스는 플러그인 클래스 뿐만 아니라 플러그인 내에 존재하는 모든 PHP 클래스의 네임스페이스로도 사용됩니다. 이 네임스페이스는 다른 개발자가 작성한 클래스와 클래스명이 동일할 때 서로 구분하기 위해 사용됩니다. 다른 사람과 중복되지 않는 자신만의 고유한 vendor를 지정하십시오. 가능하면 자신의 이름이나 소속회사명을 사용하시길 권장합니다.

예를 들어, 본인의 이름이 'GilDongHong'이면 GildongHong\HwalbinDang 또는 GilDongHong를 vendor로 사용하십시오. 만약 GilDongHong 을vendor로 사용하고 name이 my_plugin 인 플러그인을 생성하는 명령어

$ php artisan make:plugin my_plugin GilDongHong

를 실행한다면, 생성커맨드는 자동으로 GildongHong\XePlugin\MyPlugin를 네임스페이스로 생성할 것입니다.

XE의 다양한 기능(서비스) 사용하기

플러그인을 개발하려면 플러그인의 목적에 따라 XE에서 회원이나 문서, 이벤트, 세션 등의 매우 많은 기능을 사용해야 합니다. 가령 로그인한 회원의 정보를 얻거나, 작성된 문서의 목록을 가져올 때, 사이트 관리 페이지의 메뉴를 추가하기 위해서도 XE에서 제공하는 기능을 사용해야 합니다. 본 매뉴얼의 '서비스' 섹션에서는 플러그인 개발시 도움이 될 수 있는 많은 기능(서비스)에 대한 사용법을 제공하고 있습니다. 참고하시기 바랍니다.