aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Datetime/DateFormatInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Datetime;
   4
   5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a date format.
   9  */
  10 interface DateFormatInterface extends ConfigEntityInterface {
  11
  12   /**
  13    * Gets the date pattern string for this format.
  14    *
  15    * @return string
  16    *   The pattern string as expected by date().
  17    */
  18   public function getPattern();
  19
  20   /**
  21    * Sets the date pattern for this format.
  22    *
  23    * @param string $pattern
  24    *   The date pattern to use for this format.
  25    *
  26    * @return $this
  27    */
  28   public function setPattern($pattern);
  29
  30   /**
  31    * Determines if this date format is locked.
  32    *
  33    * @return bool
  34    *   TRUE if the date format is locked, FALSE otherwise.
  35    */
  36   public function isLocked();
  37
  38 }