라이믹스 모듈 만들기
라이믹스에 기능을 추가하거나 확장하기위해 모듈을 이용할 수 있다.
모듈 크게 모듈의 정보와 설정을 담은 XML 포맷의 Manifest 파일과 동작을 구성하는 PHP 파일로 구성된다. 여기에 라이믹스가 지원하는 다국어, DB 테이블 정의, view 템플릿을 구성할 수 있다.
shell
modules/example1 # 이 예제 모듈의 디렉토리
├── conf # [고정위치] 모듈 정보 및 설정 (Manifest)
│ ├── info.xml # [필수][고정위치] 모듈 정보
│ └── module.xml # [필수][고정위치] 모듈 설정
├── lang # [고정위치] 다국어
│ └── ko.php # 한국어
├── public # Assets
│ └── img
├── queries # [고정위치] XML 쿼리
├── schemas # [고정위치] 데이터베이스 스키마
├── src # 모듈의 기능을 구현하는 PHP 파일
│ ├── controllers # 컨트롤러
│ └── models # 모델
├── views # view 템플릿 파일
└── LICENSE # 라이선스 파일 (GNU GPL v2 or later)conf,lang,queries,schemas디레토리는 라이믹스에서 참조한다- 다른 용도로 사용하거나 이동, 변경하지 않아야 한다
- 사용하지 않는다면 빈 디렉토리를 유지할 필요는 없다
conf/info.xml,conf/module.xml파일은 필수로 존재해야 한다
🎉 모듈 템플릿
모듈의 권장 구조를 쉽게 구성할 수 있도록 GitHub 템플릿 저장소를 이용할 수 있다.
권장하는 형태의 구성으로 예시 코드를 기반으로 모듈을 만들기 시작할 수 있다.
-> 모듈 템플릿 사용하기
라이믹스의 권장 구조
위 예시는 필자가 권장하는 구조이며, 라이믹스의 권장하는 구조와는 사소한 차이가 있다.
shell
modules/example
├── conf
│ ├── info.xml
│ └── module.xml
├── controllers # 컨트롤러
├── lang
│ └── ko.php
├── models # 모델
├── queries
├── schemas
├── views
│ └── img
└── LICENSEshell
modules/example
├── conf
│ ├── info.xml
│ └── module.xml
├── controllers # src 밑으로 이동
├── lang
│ └── ko.php
├── models # src 밑으로 이동
├── public # Assets
│ └── img
├── queries
├── schemas
├── src # 모듈을 구성하는 PHP 파일
│ ├── controllers # 컨트롤러
│ ├── tratis # (예시) trait
│ └── models # 모델
├── vendor # (composer 사용 시)
├── views
│ └── img # public 밑으로 이동
├── composer.json # (composer 사용 시)
└── LICENSEcontrollers, models 디렉토리의 역활 외에 추가로 필요해지는 구조가 다른 디렉토리와 뒤섞이는 문제 방지를 위해 src 디렉토리 아래에 두었다.
public 디렉토리는 Webpack, vite, gulp 등 빌드 도구를 사용할 때 타겟 디렉토리로 지정을 편리하게 하고, public 디렉토리를 제외한 모든 접근을 제한해야할 때 규칙을 단순화하기 위해서이다.
라이믹스의 권장 구조를 따른 모듈 생성기를 이용할 수 있다.
-> 라이믹스 모듈 생성기