[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\MVC\Model;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Interface for a stateful model.
  18   *
  19   * @since  4.0.0
  20   */
  21  interface StatefulModelInterface
  22  {
  23      /**
  24       * Method to get model state variables.
  25       *
  26       * @param   string  $property  Optional parameter name
  27       * @param   mixed   $default   Optional default value
  28       *
  29       * @return  mixed  The property where specified, the state object where omitted
  30       *
  31       * @since   4.0.0
  32       */
  33      public function getState($property = null, $default = null);
  34  
  35      /**
  36       * Method to set model state variables.
  37       *
  38       * @param   string  $property  The name of the property.
  39       * @param   mixed   $value     The value of the property to set or null.
  40       *
  41       * @return  mixed  The previous value of the property or null if not set.
  42       *
  43       * @since   4.0.0
  44       */
  45      public function setState($property, $value = null);
  46  }