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

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