BookStack Code Mirror - bookstack/blob - app/Interfaces/Sluggable.php

   1 <?php
   2
   3 namespace BookStack\Interfaces;
   4
   5 use Illuminate\Database\Eloquent\Builder;
   6
   7 /**
   8  * Interface Sluggable.
   9  *
  10  * Assigned to models that can have slugs.
  11  * Must have the below properties.
  12  *
  13  * @property int    $id
  14  * @property string $name
  15  *
  16  * @method Builder newQuery
  17  */
  18 interface Sluggable
  19 {
  20     /**
  21      * Regenerate the slug for this model.
  22      */
  23     public function refreshSlug(): string;
  24 }