SlimFramework Documentation Part – 2
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
<?php // RESPONSE // Response Overview $app->response(); /* * Status * Header * Body */ // Response Status $app->response()-status(400); $status = $app->response()->status(); // Response Headers $res = $app->response(); $res['Content-Type'] = 'application/json'; $res['X-Powered-By'] = 'Slim'; $res = $app->response(); $contentType = $res['Content-Type']; $poweredBy = $res['X-Powered-By']; // Response Body $res = $app->response(); // overwrite response body $res->body('Foo'); // Append response body $res->write('Bar'); $res = $app->response(); $body = $res->body(); // Response Cookies // Set Cookie $app->setCookie('foo', 'bar', '2 days'); $app->setCookie($name, $value, $expiresAt, $path, $domain, $secure, $httponly); // Set Encrypted Cookie $app = new \Slim\Slim(array( 'cookies.secret_key' => 'my_secret_key', 'cookies.cipher' => MCRYPT_RIJNDAEL_256, 'cookies.cipher_mode' => MCRYPT_MODE_CBC )); // Delete Cookie $app->deleteCookie('foo'); $app->deleteCookie('foo', '/', 'foo.com'); $app->deleteCookie('foo', '/', 'foo.com', true, true); // RESPONSE Helpers // Finalize /** * Prepare new response object */ $res = new \Slim\Http\Response(); $res->status(400); $res->write('You made a bad request'); $res['ContentType'] = 'text/plain' /** * Finalize * @return [ * 200, * ['Contenttype' => 'text/plain'], * 'You made a bad request' * ] */ $array = $res->finalize(); // Redirect $app->response()->redirect('/foo', 303); $res = $app->response(); // Is this an informational response? $res->isInformational(); // Is this a 200 OK response? $res->isOk(); // Is this a 2xx successful response? $res->isSuccesful(); // Is this a 3xx redirection response? $res->isRedirection(); // Is this a specific redirect response? $res->isRedirect(); // Is this a forbidden response? $res->isForbidden(); // Is this a not found response? $res->isNotFound(); // Is this a client error response? $res->isClientError(); // Is this a server error response? $res->isServerError(); // View // View Overview // Rendering $app = new \Slim\Slim(); $app->get('/books/:id', function ($id) use ($app) { $app->render('myTemplate.php', array('id' => $id)); }); $app->render( 'myTemplate.php', array('name' => 'Josh') ); $app->render( 'myTemplate.php', array( 'name' => 'Josh'), 400 ); // Custom Views public render(string $template); class CustomView extends \Slim\View { public function render($template) { return 'The final rendered template'; } } // Example View class CustomView extends \Slim\View { public function render($template) { // $template === 'show.php' // $this->data['title'] === 'sahara' } } // Example Integration required 'CustomView.php'; $app = new \Slim\Slim(array( 'view' => new CustomView() )); $app->get('/books/:id', function ($id) use ($app) { $app->render('show.php', array('title' => 'Sahara')); }); // View Data // Setting Data $view = $app->view(); $view->setData('color', 'red'); $view = $app->view(); $view->setData(array( 'color' => 'red', 'size' => 'medium' )); // Appending Data $view = $app->view(); $view()->appendData(array( 'foo' => 'bar' )); // ETag $app->get('/foo', function () use ($app) { $app->etag('unique-id'); echo "This will be cached after the initial request!"; }); // Last Modified $app->get('/foo', function () use ($app) { $app->lastModified(1286139652); echo "This will be cached after the initial request!"; }); // Expires $app->get('/foo', function () use ($app) { $app->etag('unique-resource-id'); $app->expires('+1 week'); echo "This will be cached client-side for one week"; }); // Middleware Overview class MyMiddleware extends \Slim\Middleware { public function call() { // The Slim application $app = $this->app; // The Environment object $env = $app->environment(); // The Request object $req = $app->request(); // The Response object $res = $app->response(); } } // Next Middleware Reference class MyMiddleware extends \Slim\Middleware { public function call() { // optionally call the next middleware $this->next->call(); } } // Example Middleware class AllCapsMiddleware extends \Slim\Middleware { public function call() { // get reference to application $app = $this->app; // run inner middleware and application $this->next->call(); // capitalize response body $res = $app->response(); $body = $res->body(); $res->body(strtoupper($body)); } } // Add Middleware $app = new \Slim\Slim(); $app->add(new \AllCapsMiddleware()); $app->get('/foo', function () use ($app) { echo "Hello"; }); $app->run(); // How to write middleware class MyMiddleware extends \Slim\Middleware { public function call() { $this->next->call(); } } // Hooks // How to use Hooks $app = new \Slim\Slim(); $app->hook('the.hook.name', function () { // Do something }); $app = new \Slim\Slim(); $app->hook('the.hook.name', function () { // Do something }, 5); $app = new \Slim\Slim(); $app->hook('the.hook.name', function () use ($app) { // Do somethhing }); // custom hook $app = new \Slim\Slim(); $app->applyHook('my.hook.name'); // Flash Messaging Overview // Flash Next $app->flash('error', 'User email is required'); // Flash Now $app->flashNow('info', 'Your credit card is expired'); // Flash Keep $app->flashKeep(); // SESSIONS // Cookie Session Store $app = new Slim(); $app->add(new \Slim\Middleware\SessionCookie(array( 'expires' => '20 minutes', 'path' => '/', 'domain' => null, 'secure' => false, 'httponly' => false, 'name' => 'slim_session', 'secret' => 'CHANGE_ME', 'cipher' => MCRYPT_RIJNDAEL_256, 'cipher_mode' => MCRYPT_RIJNDAEL_256 ))); // LOGGING // How to log data $log = $app->getLog(); $log->debug(mixed $object); $log->info(mixed $object); $log->warn(mixed $object); $log->error(mixed $object); $log->fatal(mixed $object); // Activate Logging // enable logging $app->getLog()->setEnabled(true); $app = new Slim(array( 'log.enabled' => true )); // disable logging $app->getLog()->setEnabled(false); // Log Level // How to set the log level $log = $app->getLog(); $log->setLevel(\Slim\Log::WARN); $app = new \Slim\Slim(array( 'log.level' => \Slim\Log::WARN )); // LOG Writers // How to use a custom log writer public function write(mixed $message); $app = new \Slim\Slim(array( 'log.writer' => new MyLogWriter() )); class CustomLogWriterMiddleware extends \Slim\Middleware { // set the new log writer $log = $this->app->getLog(); $log->setWriter(new \MyLogWriter()); // call next middleware $this->next->call(); } $app->hook('slim.before', function () use ($app) { $app->getLog()->setWriter(new \MyLogWriter()); }); // Error Handler // set custom error handler $app = new \Slim\Slim(); $app->error(function (\Exception $e) use ($app) { $app->rendeer('error.php'); }); // set not found handler $app = new \Slim\Slim(); $app->notFound(function () use ($app) { $app->render('404.html'); }); // invoke not found handler $app = new \Slim\Slim(); $app->get('/hello/:name', function ($name) use ($app) { if ($name === 'Waldo') { $app->notFound(); } else { echo "Hello, $name"; } }); // DEBUGGING $app = new \Slim\Slim(array( 'debug' => true )); $app = new \Slim\Slim(); // enable debugging (on by default) $app->config('debug', true); // disable debugging $app->config('debug', false); // Output Redirection class CustomErrorMiddleware extends \Slim\Middleware { public function call() { // set new error output $env = $this->app->environment(); $env['slim.errors'] = fopen('/path/to/output', 'w'); // call next middleware $this->next->call(); } } ?> |