| r3 vs r4 | ||
|---|---|---|
| 1 | ''' | |
| 1 | 위키 엔진이다. [[https://github.com/PressDo/PressDoWiki|Github]] | |
| 2 | ||<-2><tablealign=right><tablebordercolor=#580000><tablewidth=45%><tablebgcolor=white,#191919><bgcolor=#8892BF><:>'''{{{#222530 {{{+2 PressDo}}}[br]PressDo - Fast & Light PHP Wiki Engine}}}'''|| | |
| 3 | ||<colbgcolor=#8892BF><colcolor=#222530> '''개발자''' || PRASEOD- || | |
| 4 | || '''종류''' || 위키 소프트웨어 || | |
| 5 | || '''출시''' || ~~2022년 2월{{{#2878da ^^(예정)^^}}}~~ || | |
| 6 | || '''최신 버전''' || 2202a{{{#2878da ^^(예정)^^}}} || | |
| 7 | || '''저장소''' || [[https://github.com/PressDo/PressDoWiki]] || | |
| 8 | || '''운영 체제''' || 크로스 플랫폼 || | |
| 9 | || '''개발 언어''' || PHP || | |
| 10 | || '''지원 언어''' || 한국어 || | |
| 11 | || '''개발 환경''' || PHP 8.0[br]MariaDB 10.3.25 || | |
| 12 | || '''최소 사양''' || PHP 8.0 || | |
| 13 | || '''라이선스''' || AGPL-3.0 License[* 변경 가능성 있음] || | |
| 14 | || '''공식 사이트''' || '''비공개'''[* 테스트 위키 사이트로, 위키가 완성되면 공개한다고 한다. 타 서버에서는 도메인이 살짝 공개되기도 했었다.] || | |
| 15 | [목차] | |
| 16 | [clearfix] | |
| 2 | 17 | |
| 18 | == 함수 목록 == | |
| 19 | PressDoLib.php 내 함수 목록이다. | |
| 20 | === class PressDo === | |
| 21 | ==== exist() ==== | |
| 22 | * 매개변수 | |
| 23 | || 변수형 || 변수명 || 내용 || | |
| 24 | || string || title || 문서명 || | |
| 3 | 25 | |
| 26 | * 출력 | |
| 27 | 문서 존재 여부 (bool) | |
| 4 | 28 | |
| 29 | 문서의 존재 여부를 확인한다. | |
| 30 | ||
| 31 | ==== readSyntax() ==== | |
| 32 | * 매개변수 | |
| 33 | || 변수형 || 변수명 || 내용 || | |
| 34 | || string || content || 문서 RAW || | |
| 35 | || array || options || 렌더러 옵션 || | |
| 36 | ||
| 37 | * 출력 (array) | |
| 38 | || 요소명 || 내용 || | |
| 39 | || html || 문서 HTML || | |
| 40 | || categories || 문서 분류 목록(array) || | |
| 41 | ||
| 42 | RAW를 문법에 따라 렌더링한다. | |
| 43 | ||
| 44 | ==== rand() ==== | |
| 45 | * 매개변수 (선택) | |
| 46 | || 변수형 || 변수명 || 내용 || | |
| 47 | || int || l || 길이 || | |
| 48 | || bool || u || 대문자포함여부 || | |
| 49 | || string || add || 추가할 문자열 종류 || | |
| 50 | ||
| 51 | * 출력 | |
| 52 | 무작위 문자열 (string) | |
| 53 | ||
| 54 | l 만큼의 길이를 가진 무작위 문자열을 생성한다. | |
| 55 | 기본적으로 영소문자와 숫자를 포함하고, u값이 true일 경우 대문자를 포함한다. | |
| 56 | add값이 존재할 경우 해당 값에 존재하는 문자들을 추가로 포함한다. | |
| 57 | ||
| 58 | ==== getip() ==== | |
| 59 | * 매개변수 없음 | |
| 60 | ||
| 61 | * 출력 | |
| 62 | IP (string) | |
| 63 | ||
| 64 | 접속자의 IP를 가져온다. 확인이 불가능할 경우 0.0.0.0으로 표시된다. | |
| 65 | ||
| 66 | ==== cidr_range_ipv4() ==== | |
| 67 | * 매개변수 | |
| 68 | || 변수형 || 변수명 || 내용 || | |
| 69 | || string || cidr || CIDR || | |
| 70 | ||
| 71 | * 출력 | |
| 72 | CIDR의 시작 아이피와 끝 아이피를 포함한 배열을 반환한다. | |
| 73 | ||
| 74 | ==== cidr_range_ipv6() ==== | |
| 75 | * 매개변수 | |
| 76 | || 변수형 || 변수명 || 내용 || | |
| 77 | || string || cidr || CIDR || | |
| 78 | ||
| 79 | * 출력 | |
| 80 | CIDR의 시작 아이피와 끝 아이피를 포함한 배열을 반환한다. | |
| 81 | ||
| 82 | ==== ipd() ==== | |
| 83 | * 매개변수 | |
| 84 | || 변수형 || 변수명 || 내용 || | |
| 85 | || string || ipaddress || CIDR || | |
| 86 | ||
| 87 | * 출력 | |
| 88 | 정수형 아이피 (string) | |
| 89 | ||
| 90 | IPv6 아이피를 정수형으로 변환한다. | |
| 91 | ||
| 92 | ==== geoip() ==== | |
| 93 | * 매개변수 | |
| 94 | || 변수형 || 변수명 || 내용 || | |
| 95 | || string || ip || IP || | |
| 96 | ||
| 97 | * 출력 | |
| 98 | 국가코드 (string) | |
| 99 | ||
| 100 | IP-API에서 가져온 해당 아이피의 국가 코드를 반환한다. | |
| 101 | ||
| 102 | ==== formatTime() ==== | |
| 103 | * 매개변수 | |
| 104 | || 변수형 || 변수명 || 내용 || | |
| 105 | || int || sec || 초 단위의 시간 || | |
| 106 | ||
| 107 | * 출력 (array) | |
| 108 | || 요소명 || 내용 || | |
| 109 | || week || 주 || | |
| 110 | || day || 일 || | |
| 111 | || hour || 시간 || | |
| 112 | || minute || 분 || | |
| 113 | || second || 초 || | |
| 114 | ||
| 115 | 초 단위의 시간을 형식화해준다. | |
| 116 | ||
| 117 | ==== starDocument() ==== | |
| 118 | * 매개변수 | |
| 119 | || 변수형 || 변수명 || 내용 || | |
| 120 | || string || action || 동작 || | |
| 121 | || int || docid || 문서 ID || | |
| 122 | || string || username || 사용자명 || | |
| 123 | ||
| 124 | * 출력 없음 | |
| 125 | ||
| 126 | 문서를 문서함에 추가하거나 문서함에서 삭제한다. | |
| 127 | ||
| 128 | ==== getStarred() ==== | |
| 129 | * 매개변수 | |
| 130 | || 변수형 || 변수명 || 내용 || | |
| 131 | || string || username || 사용자명 || | |
| 132 | ||
| 133 | * 출력 | |
| 134 | 별표한 문서 ID 목록 (array) | |
| 135 | ||
| 136 | 문서함에 추가된 문서를 불러온다. | |
| 137 | ||
| 138 | ==== ifStarred() ==== | |
| 139 | * 매개변수 | |
| 140 | || 변수형 || 변수명 || 내용 || | |
| 141 | || string || username || 사용자명 || | |
| 142 | || int || docid || 문서 ID || | |
| 143 | ||
| 144 | * 출력 | |
| 145 | 별표 여부 (bool) | |
| 146 | ||
| 147 | 해당 사용자가 해당 문서를 별표했는지 확인한다. | |
| 148 | ||
| 149 | ==== countStar() ==== | |
| 150 | * 매개변수 | |
| 151 | || 변수형 || 변수명 || 내용 || | |
| 152 | || int || docid || 문서 ID || | |
| 153 | ||
| 154 | * 출력 | |
| 155 | 별표 개수 (int) | |
| 156 | ||
| 157 | 몇 명이 해당 문서를 별표했는지 확인한다. | |
| 158 | ||
| 159 | ==== requestAPI() ==== | |
| 160 | * 매개변수 | |
| 161 | || 변수형 || 변수명 || 내용 || | |
| 162 | || string || url || URL || | |
| 163 | || mixed || session || 세션 정보 || | |
| 164 | ||
| 165 | * 출력 | |
| 166 | 페이지 메타데이터 (array) | |
| 167 | ||
| 168 | 내부 API를 통해 페이지 구성에 필요한 메타데이터를 호출한다. | |
| 169 | ||
| 170 | === class Member === | |
| 171 | ==== addUser() ==== | |
| 172 | * 매개변수 | |
| 173 | || 변수형 || 변수명 || 내용 || | |
| 174 | || string || id || ID || | |
| 175 | || string || pw || 비밀번호 || | |
| 176 | || string || email || 이메일 || | |
| 177 | || string || ua || User-Agent || | |
| 178 | ||
| 179 | * 출력 없음 | |
| 180 | 사용자를 생성한다. | |
| 181 | ||
| 182 | ==== mailExists() ==== | |
| 183 | * 매개변수 | |
| 184 | || 변수형 || 변수명 || 내용 || | |
| 185 | || string || email || 이메일 || | |
| 186 | ||
| 187 | * 출력 | |
| 188 | 메일 존재 여부 (bool) | |
| 189 | ||
| 190 | 사용자가 입력한 메일이 이미 가입되었는지 확인한다. | |
| 191 | ||
| 192 | ==== userExists() ==== | |
| 193 | * 매개변수 | |
| 194 | || 변수형 || 변수명 || 내용 || | |
| 195 | || string || user || ID || | |
| 196 | ||
| 197 | * 출력 | |
| 198 | ID 존재 여부 (bool) | |
| 199 | ||
| 200 | 사용자가 입력한 아이디가 이미 가입되었는지 확인한다. | |
| 201 | ||
| 202 | ==== loginUser() ==== | |
| 203 | * 매개변수 | |
| 204 | || 변수형 || 변수명 || 내용 || | |
| 205 | || string || id || ID || | |
| 206 | || string || pw || 비밀번호 || | |
| 207 | || string || dt || 시간 || | |
| 208 | || string || ip || IP || | |
| 209 | || string || ua || User-Agent || | |
| 210 | ||
| 211 | * 출력 | |
| 212 | 로그인 성공 시: gravatar URL, 사용자명이 담긴 배열 | |
| 213 | 로그인 실패 시: false (bool) | |
| 214 | ||
| 215 | 사용자를 로그인시킨다. | |
| 216 | ||
| 217 | ==== modifyUser() ==== | |
| 218 | * 매개변수 | |
| 219 | || 변수형 || 변수명 || 내용 || | |
| 220 | || string || id || ID || | |
| 221 | || string || pw || 비밀번호 || | |
| 222 | || string || email || 이메일 || | |
| 223 | ||
| 224 | * 출력 없음 | |
| 225 | ||
| 226 | 사용자 정보를 수정한다. |