framework/main/traits/result/search/class_SearchableResultTrait.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Traits\Result\Search;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Result\Search\SearchableResult;
   7
   8 /**
   9  * A trait for searchable results
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 trait SearchableResultTrait {
  31         /**
  32          * Database result instance
  33          */
  34         private $resultInstance = NULL;
  35
  36         /**
  37          * Setter for database result instance
  38          *
  39          * @param       $resultInstance         An instance of a database result class
  40          * @return      void
  41          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
  42          */
  43         protected final function setResultInstance (SearchableResult $resultInstance) {
  44                 $this->resultInstance =  $resultInstance;
  45         }
  46
  47         /**
  48          * Getter for database result instance
  49          *
  50          * @return      $resultInstance         An instance of a database result class
  51          */
  52         public final function getResultInstance () {
  53                 return $this->resultInstance;
  54         }
  55
  56 }