Skip to content

Commit c14388e

Browse files
authored
Fix example code blocks in event docblocks
1 parent db59795 commit c14388e

1 file changed

Lines changed: 69 additions & 58 deletions

File tree

src/Database/Model.php

Lines changed: 69 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -249,10 +249,11 @@ protected function bootNicerEvents()
249249
*
250250
* Example usage:
251251
*
252-
* $model->bindEvent('model.afterBoot', function () use (\Winter\Storm\Database\Model $model) {
253-
* \Log::info(get_class($model) . ' has booted');
254-
* });
255-
*
252+
* ```php
253+
* $model->bindEvent('model.afterBoot', function () use (\Winter\Storm\Database\Model $model) {
254+
* \Log::info(get_class($model) . ' has booted');
255+
* });
256+
* ```
256257
*/
257258
$model->fireEvent('model.afterBoot');
258259

@@ -290,12 +291,13 @@ protected function beforeCreate()
290291
*
291292
* Example usage:
292293
*
293-
* $model->bindEvent('model.beforeCreate', function () use (\Winter\Storm\Database\Model $model) {
294-
* if (!$model->isValid()) {
295-
* throw new \Exception("Invalid Model!");
296-
* }
297-
* });
298-
*
294+
* ```php
295+
* $model->bindEvent('model.beforeCreate', function () use (\Winter\Storm\Database\Model $model) {
296+
* if (!$model->isValid()) {
297+
* throw new \Exception("Invalid Model!");
298+
* }
299+
* });
300+
* ```
299301
*/
300302
}
301303

@@ -311,10 +313,11 @@ protected function afterCreate()
311313
*
312314
* Example usage:
313315
*
314-
* $model->bindEvent('model.afterCreate', function () use (\Winter\Storm\Database\Model $model) {
315-
* \Log::info("{$model->name} was created!");
316-
* });
317-
*
316+
* ```php
317+
* $model->bindEvent('model.afterCreate', function () use (\Winter\Storm\Database\Model $model) {
318+
* \Log::info("{$model->name} was created!");
319+
* });
320+
* ```
318321
*/
319322
}
320323

@@ -330,12 +333,13 @@ protected function beforeUpdate()
330333
*
331334
* Example usage:
332335
*
333-
* $model->bindEvent('model.beforeUpdate', function () use (\Winter\Storm\Database\Model $model) {
334-
* if (!$model->isValid()) {
335-
* throw new \Exception("Invalid Model!");
336-
* }
337-
* });
338-
*
336+
* ```php
337+
* $model->bindEvent('model.beforeUpdate', function () use (\Winter\Storm\Database\Model $model) {
338+
* if (!$model->isValid()) {
339+
* throw new \Exception("Invalid Model!");
340+
* }
341+
* });
342+
* ```
339343
*/
340344
}
341345

@@ -351,12 +355,13 @@ protected function afterUpdate()
351355
*
352356
* Example usage:
353357
*
354-
* $model->bindEvent('model.afterUpdate', function () use (\Winter\Storm\Database\Model $model) {
355-
* if (!$model->originalIsEquivalent('title') {
356-
* \Log::info("{$model->name} updated its title!");
357-
* }
358-
* });
359-
*
358+
* ```php
359+
* $model->bindEvent('model.afterUpdate', function () use (\Winter\Storm\Database\Model $model) {
360+
* if (!$model->originalIsEquivalent('title') {
361+
* \Log::info("{$model->name} updated its title!");
362+
* }
363+
* });
364+
* ```
360365
*/
361366
}
362367

@@ -372,12 +377,13 @@ protected function beforeSave()
372377
*
373378
* Example usage:
374379
*
375-
* $model->bindEvent('model.beforeSave', function () use (\Winter\Storm\Database\Model $model) {
376-
* if (!$model->isValid()) {
377-
* throw new \Exception("Invalid Model!");
378-
* }
379-
* });
380-
*
380+
* ```php
381+
* $model->bindEvent('model.beforeSave', function () use (\Winter\Storm\Database\Model $model) {
382+
* if (!$model->isValid()) {
383+
* throw new \Exception("Invalid Model!");
384+
* }
385+
* });
386+
* ```
381387
*/
382388
}
383389

@@ -393,12 +399,13 @@ protected function afterSave()
393399
*
394400
* Example usage:
395401
*
396-
* $model->bindEvent('model.afterSave', function () use (\Winter\Storm\Database\Model $model) {
397-
* if (!$model->originalIsEquivalent('title') {
398-
* \Log::info("{$model->name} updated its title!");
399-
* }
400-
* });
401-
*
402+
* ```php
403+
* $model->bindEvent('model.afterSave', function () use (\Winter\Storm\Database\Model $model) {
404+
* if (!$model->originalIsEquivalent('title') {
405+
* \Log::info("{$model->name} updated its title!");
406+
* }
407+
* });
408+
* ```
402409
*/
403410
}
404411

@@ -414,12 +421,13 @@ protected function beforeDelete()
414421
*
415422
* Example usage:
416423
*
417-
* $model->bindEvent('model.beforeDelete', function () use (\Winter\Storm\Database\Model $model) {
418-
* if (!$model->isAllowedToBeDeleted()) {
419-
* throw new \Exception("You cannot delete me!");
420-
* }
421-
* });
422-
*
424+
* ```php
425+
* $model->bindEvent('model.beforeDelete', function () use (\Winter\Storm\Database\Model $model) {
426+
* if (!$model->isAllowedToBeDeleted()) {
427+
* throw new \Exception("You cannot delete me!");
428+
* }
429+
* });
430+
* ```
423431
*/
424432
}
425433

@@ -435,10 +443,11 @@ protected function afterDelete()
435443
*
436444
* Example usage:
437445
*
438-
* $model->bindEvent('model.afterDelete', function () use (\Winter\Storm\Database\Model $model) {
439-
* \Log::info("{$model->name} was deleted");
440-
* });
441-
*
446+
* ```php
447+
* $model->bindEvent('model.afterDelete', function () use (\Winter\Storm\Database\Model $model) {
448+
* \Log::info("{$model->name} was deleted");
449+
* });
450+
* ```
442451
*/
443452
}
444453

@@ -454,12 +463,13 @@ protected function beforeFetch()
454463
*
455464
* Example usage:
456465
*
457-
* $model->bindEvent('model.beforeFetch', function () use (\Winter\Storm\Database\Model $model) {
458-
* if (!\Auth::getUser()->hasAccess('fetch.this.model')) {
459-
* throw new \Exception("You shall not pass!");
460-
* }
461-
* });
462-
*
466+
* ```php
467+
* $model->bindEvent('model.beforeFetch', function () use (\Winter\Storm\Database\Model $model) {
468+
* if (!\Auth::getUser()->hasAccess('fetch.this.model')) {
469+
* throw new \Exception("You shall not pass!");
470+
* }
471+
* });
472+
* ```
463473
*/
464474
}
465475

@@ -475,10 +485,11 @@ protected function afterFetch()
475485
*
476486
* Example usage:
477487
*
478-
* $model->bindEvent('model.afterFetch', function () use (\Winter\Storm\Database\Model $model) {
479-
* \Log::info("{$model->name} was retrieved from the database");
480-
* });
481-
*
488+
* ```php
489+
* $model->bindEvent('model.afterFetch', function () use (\Winter\Storm\Database\Model $model) {
490+
* \Log::info("{$model->name} was retrieved from the database");
491+
* });
492+
* ```
482493
*/
483494
}
484495

0 commit comments

Comments
 (0)