Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

트리거 내용을 서술하는 문서를 제작하고 있습니다 #13

Open
Waterticket opened this issue Aug 12, 2022 · 1 comment
Open

Comments

@Waterticket
Copy link

https://github.com/Waterticket/rhymix-docs/blob/trigger/ko/reference/trigger.md

위와 같이 라이믹스 기본 모듈에 존재하는 트리거들을 문서에 작성할 예정입니다.

본격적인 작업 전에 개선할 점이 있을지 확인 부탁드립니다.

@kijin
Copy link
Member

kijin commented Aug 12, 2022

감사합니다.

post요청 이후, 글을 데이터베이스에 넣기 전에 값을 인자로 넘깁니다.
인자로 주어진 object를 수정할 경우, 해당 값이 최종 반영됩니다.
error값을 담아 BaseObject를 return할 경우, 값을 데이터베이스에 넣지 않으며 작성자에게 message를 노출합니다.

return 값은 무시됩니다.

이런 내용들은 거의 모든 트리거에 공통적으로 적용되므로, 특별한 경우 외에는 적지 않으셔도 됩니다. 공통 사항으로 처리하는 편이 훨씬 효율적일 것 같네요.

문서 트리거 등에서 제공되는 어마어마하게 많은 데이터를 일일이 문서화할 필요도 없을 것 같습니다. 이럴 때는 문서 속성을 담은 stdClass가 전달된다, 저럴 때는 DocumentItem이 넘어간다, extra_vars는 이미 serialize()된 상태로 넘어온다, 이런 차이점에 초점을 맞추는 것이 낫겠어요. 특히 _filtererror_return_url처럼 문서와 전혀 관계없는 속성들은 언제 예고없이 삭제될지 모릅니다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants