| 1 |  |  | <?php | 
            
                                                                                                            
                            
            
                                    
            
            
                | 2 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 3 |  |  | /* | 
            
                                                                                                            
                            
            
                                    
            
            
                | 4 |  |  |  * The MIT License | 
            
                                                                                                            
                            
            
                                    
            
            
                | 5 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 6 |  |  |  * Copyright 2014-2018 James Ekow Abaka Ainooson | 
            
                                                                                                            
                            
            
                                    
            
            
                | 7 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 8 |  |  |  * Permission is hereby granted, free of charge, to any person obtaining a copy | 
            
                                                                                                            
                            
            
                                    
            
            
                | 9 |  |  |  * of this software and associated documentation files (the "Software"), to deal | 
            
                                                                                                            
                            
            
                                    
            
            
                | 10 |  |  |  * in the Software without restriction, including without limitation the rights | 
            
                                                                                                            
                            
            
                                    
            
            
                | 11 |  |  |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | 
            
                                                                                                            
                            
            
                                    
            
            
                | 12 |  |  |  * copies of the Software, and to permit persons to whom the Software is | 
            
                                                                                                            
                            
            
                                    
            
            
                | 13 |  |  |  * furnished to do so, subject to the following conditions: | 
            
                                                                                                            
                            
            
                                    
            
            
                | 14 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 15 |  |  |  * The above copyright notice and this permission notice shall be included in | 
            
                                                                                                            
                            
            
                                    
            
            
                | 16 |  |  |  * all copies or substantial portions of the Software. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 17 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 18 |  |  |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | 
            
                                                                                                            
                            
            
                                    
            
            
                | 19 |  |  |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | 
            
                                                                                                            
                            
            
                                    
            
            
                | 20 |  |  |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | 
            
                                                                                                            
                            
            
                                    
            
            
                | 21 |  |  |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | 
            
                                                                                                            
                            
            
                                    
            
            
                | 22 |  |  |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | 
            
                                                                                                            
                            
            
                                    
            
            
                | 23 |  |  |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | 
            
                                                                                                            
                            
            
                                    
            
            
                | 24 |  |  |  * THE SOFTWARE. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 25 |  |  |  */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 26 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 27 |  |  | namespace ntentan\nibii; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 28 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 29 |  |  | use ntentan\atiaa\Driver; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 30 |  |  | use ntentan\nibii\exceptions\ModelNotFoundException; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 31 |  |  | use ntentan\utils\Text; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 32 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 33 |  |  | /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 34 |  |  |  * Performs operations that query the database. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 35 |  |  |  */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 36 |  |  | class QueryOperations | 
            
                                                                                                            
                            
            
                                    
            
            
                | 37 |  |  | { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 38 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 39 |  |  |      * An instance of the record wrapper being used. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 40 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 41 |  |  |      * @var RecordWrapper | 
            
                                                                                                            
                            
            
                                    
            
            
                | 42 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 43 |  |  |     private $wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 44 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 45 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 46 |  |  |      * An instance of the driver adapter used in the database connection. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 47 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 48 |  |  |      * @var DriverAdapter | 
            
                                                                                                            
                            
            
                                    
            
            
                | 49 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 50 |  |  |     private $adapter; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 51 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 52 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 53 |  |  |      * An instance of query parameters used to perform the various queries. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 54 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 55 |  |  |      * @var QueryParameters | 
            
                                                                                                            
                            
            
                                    
            
            
                | 56 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 57 |  |  |     private $queryParameters; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 58 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 59 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 60 |  |  |      * The name of a method initialized through a dynamic method waiting to be executed. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 61 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 62 |  |  |      * @var string | 
            
                                                                                                            
                            
            
                                    
            
            
                | 63 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 64 |  |  |     private $pendingMethod; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 65 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 66 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 67 |  |  |      * Regular expressions for matching dynamic methods. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 68 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 69 |  |  |      * @var array | 
            
                                                                                                            
                            
            
                                    
            
            
                | 70 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 71 |  |  |     private $dynamicMethods = [ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 72 |  |  |         '/(?<method>filterBy)(?<variable>[A-Z][A-Za-z]+){1}/', | 
            
                                                                                                            
                            
            
                                    
            
            
                | 73 |  |  |         '/(?<method>sort)(?<direction>Asc|Desc)?(By)(?<variable>[A-Z][A-Za-z]+){1}/', | 
            
                                                                                                            
                            
            
                                    
            
            
                | 74 |  |  |         '/(?<method>fetch)(?<first>First)?(With)(?<variable>[A-Za-z]+)/', | 
            
                                                                                                            
                            
            
                                    
            
            
                | 75 |  |  |     ]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 76 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 77 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 78 |  |  |      * An instance of the DataOperations class used for filtered deletes. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 79 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 80 |  |  |      * @var DataOperations | 
            
                                                                                                            
                            
            
                                    
            
            
                | 81 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 82 |  |  |     private $dataOperations; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 83 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 84 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 85 |  |  |      * An instance of the Driver class used for establishing database connections. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 86 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 87 |  |  |      * @var Driver | 
            
                                                                                                            
                            
            
                                    
            
            
                | 88 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 89 |  |  |     private $driver; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 90 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 91 |  |  |     //private $defaultQueryParameters = null; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 92 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 93 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 94 |  |  |      * QueryOperations constructor. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 95 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 96 |  |  |      * @param RecordWrapper  $wrapper | 
            
                                                                                                            
                            
            
                                    
            
            
                | 97 |  |  |      * @param DataOperations $dataOperations | 
            
                                                                                                            
                            
            
                                    
            
            
                | 98 |  |  |      * @param Driver         $driver | 
            
                                                                                                            
                            
            
                                    
            
            
                | 99 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 100 |  |  |      * @internal param DriverAdapter $adapter | 
            
                                                                                                            
                            
            
                                    
            
            
                | 101 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 102 | 30 |  |     public function __construct(RecordWrapper $wrapper, DataOperations $dataOperations, Driver $driver) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 103 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 104 | 30 |  |         $this->wrapper = $wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 105 | 30 |  |         $this->adapter = $wrapper->getAdapter(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 106 | 30 |  |         $this->dataOperations = $dataOperations; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 107 | 30 |  |         $this->driver = $driver; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 108 | 30 |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 109 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 110 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 111 |  |  |      * Fetches items from the database. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 112 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 113 |  |  |      * @param int|array|QueryParameters $query | 
            
                                                                                                            
                            
            
                                    
            
            
                | 114 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 115 |  |  |      * @return RecordWrapper | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 116 |  |  |      * @throws \ReflectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 117 |  |  |      * @throws \ntentan\atiaa\exceptions\ConnectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 118 |  |  |      * @throws exceptions\NibiiException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 119 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 120 | 20 |  |     public function doFetch($query = null) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 121 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 122 | 20 |  |         $parameters = $this->buildFetchQueryParameters($query); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 123 | 20 |  |         $data = $this->adapter->select($parameters); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 124 | 20 |  |         if (empty($data)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 125 | 4 |  |             return; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 126 |  |  |         } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 127 | 16 |  |             $this->wrapper->setData($data); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 128 |  |  |             //$this->resetQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 129 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 130 | 16 |  |             return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 131 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 132 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 133 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 134 |  |  | //    public function setDefaultQueryParameters(QueryParameters $queryParameters) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 135 |  |  | //    { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 136 |  |  | //        $this->defaultQueryParameters = $queryParameters; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 137 |  |  | //    } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 138 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 139 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 140 |  |  |      * The method takes multiple types of arguments and converts it to a QueryParametersObject. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 141 |  |  |      * When this method receives null, it returns a new instance of QueryParameters. When it receives an integer, it | 
            
                                                                                                            
                            
            
                                    
            
            
                | 142 |  |  |      * returns a QueryParameters object that points the primary key to the integer. When it receives an associative | 
            
                                                                                                            
                            
            
                                    
            
            
                | 143 |  |  |      * array, it builds a series of conditions with array key-value pairs. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 144 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 145 |  |  |      * @param int|array|QueryParameters $arg | 
            
                                                                                                            
                            
            
                                    
            
            
                | 146 |  |  |      * @param bool $instantiate | 
            
                                                                                                            
                            
            
                                    
            
            
                | 147 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 148 |  |  |      * @return QueryParameters | 
            
                                                                                                            
                            
            
                                    
            
            
                | 149 |  |  |      * @throws \ReflectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 150 |  |  |      * @throws \ntentan\atiaa\exceptions\ConnectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 151 |  |  |      * @throws exceptions\NibiiException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 152 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 153 | 22 |  |     private function buildFetchQueryParameters($arg, $instantiate = true) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 154 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 155 | 22 |  |         if ($arg instanceof QueryParameters) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 156 | 8 |  |             $this->queryParameters = $arg; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 157 | 8 |  |             return $arg; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 158 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 159 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 160 | 22 |  |         $parameters = $this->getQueryParameters($instantiate); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 161 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 162 | 22 |  |         if (is_numeric($arg)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 163 | 4 |  |             $description = $this->wrapper->getDescription(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 164 | 4 |  |             $parameters->addFilter($description->getPrimaryKey()[0], $arg); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 165 | 4 |  |             $parameters->setFirstOnly(true); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 166 | 20 |  |         } elseif (is_array($arg)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 167 | 6 |  |             foreach ($arg as $field => $value) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 168 | 6 |  |                 $parameters->addFilter($field, $value); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 169 |  |  |             } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 170 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 171 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 172 | 22 |  |         return $parameters; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 173 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 174 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 175 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 176 |  |  |      * Creates a new instance of the QueryParameters if required or just returns an already instance. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 177 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 178 |  |  |      * @param bool $forceInstantiation | 
            
                                                                                                            
                            
            
                                    
            
            
                | 179 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 180 |  |  |      * @return QueryParameters | 
            
                                                                                                            
                            
            
                                    
            
            
                | 181 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 182 | 28 |  |     private function getQueryParameters($forceInstantiation = true) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 183 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 184 | 28 |  |         if ($this->queryParameters === null && $forceInstantiation) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 185 | 28 |  |             $this->queryParameters = new QueryParameters($this->wrapper->getDBStoreInformation()['quoted_table']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 186 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 187 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 188 | 28 |  |         return $this->queryParameters; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 189 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 190 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 191 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 192 |  |  |      * Clears up the query parameters. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 193 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 194 | 8 |  |     private function resetQueryParameters() | 
            
                                                                                                            
                            
            
                                    
            
            
                | 195 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 196 | 8 |  |         $this->queryParameters = null; //$this->defaultQueryParameters ? clone $this->defaultQueryParameters : null; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 197 | 8 |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 198 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 199 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 200 |  |  |      * Performs the fetch operation and returns just the first item. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 201 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 202 |  |  |      * @param mixed $id | 
            
                                                                                                            
                            
            
                                    
            
            
                | 203 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 204 |  |  |      * @return RecordWrapper | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 205 |  |  |      * @throws \ReflectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 206 |  |  |      * @throws \ntentan\atiaa\exceptions\ConnectionException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 207 |  |  |      * @throws exceptions\NibiiException | 
            
                                                                                                            
                            
            
                                    
            
            
                | 208 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 209 | 10 |  |     public function doFetchFirst($id = null) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 210 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 211 | 10 |  |         $this->getQueryParameters()->setFirstOnly(true); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 212 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 213 | 10 |  |         return $this->doFetch($id); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 214 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 215 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 216 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 217 |  |  |      * Set the fields that should be returned for each record. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 218 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 219 |  |  |      * @return RecordWrapper | 
            
                                                                                                            
                            
            
                                    
            
            
                | 220 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 221 | 12 |  |     public function doFields() | 
            
                                                                                                            
                            
            
                                    
            
            
                | 222 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 223 | 12 |  |         $fields = []; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 224 | 12 |  |         $arguments = func_get_args(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 225 | 12 |  |         foreach ($arguments as $argument) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 226 | 12 |  |             if (is_array($argument)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 227 | 6 |  |                 $fields = array_merge($fields, $argument); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 228 |  |  |             } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 229 | 6 |  |                 $fields[] = $argument; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 230 |  |  |             } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 231 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 232 | 12 |  |         $this->getQueryParameters()->setFields($fields); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 233 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 234 | 12 |  |         return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 235 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 236 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 237 |  |  | //    public function doFix($query) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 238 |  |  | //    { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 239 |  |  | //        $this->defaultQueryParameters = $query; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 240 |  |  | //    } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 241 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 242 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 243 |  |  |      * Sort the query by a given field in a given directory. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 244 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 245 |  |  |      * @param string $field | 
            
                                                                                                            
                            
            
                                    
            
            
                | 246 |  |  |      * @param string $direction | 
            
                                                                                                            
                            
            
                                    
            
            
                | 247 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 248 |  |  |     public function doSortBy($field, $direction = 'ASC') | 
            
                                                                                                            
                            
            
                                    
            
            
                | 249 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 250 |  |  |         $this->getQueryParameters()->addSort($field, $direction); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 251 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 252 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 253 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 254 |  |  |      * @param mixed $arguments | 
            
                                                                                                            
                            
            
                                    
            
            
                | 255 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 256 |  |  |      * @return array | 
            
                                                                                                            
                            
            
                                    
            
            
                | 257 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 258 | 10 |  |     private function getFilter($arguments) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 259 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 260 | 10 |  |         if (count($arguments) == 2 && is_array($arguments[1])) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 261 | 2 |  |             $filter = $arguments[0]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 262 | 2 |  |             $data = $arguments[1]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 263 |  |  |         } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 264 | 10 |  |             $filter = array_shift($arguments); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 265 | 10 |  |             $data = $arguments; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 266 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 267 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 268 | 10 |  |         return ['filter' => $filter, 'data' => $data]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 269 |  |  |     } | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 270 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 271 | 6 |  |     public function doFilter() | 
            
                                                                        
                            
            
                                    
            
            
                | 272 |  |  |     { | 
            
                                                                        
                            
            
                                    
            
            
                | 273 | 6 |  |         $arguments = func_get_args(); | 
            
                                                                        
                            
            
                                    
            
            
                | 274 | 6 |  |         if (count($arguments) == 1 && is_array($arguments[0])) { | 
            
                                                                        
                            
            
                                    
            
            
                | 275 |  |  |             foreach ($arguments[0] as $field => $value) { | 
            
                                                                        
                            
            
                                    
            
            
                | 276 |  |  |                 $this->getQueryParameters()->addFilter($field, $value); | 
            
                                                                        
                            
            
                                    
            
            
                | 277 |  |  |             } | 
            
                                                                        
                            
            
                                    
            
            
                | 278 |  |  |         } else { | 
            
                                                                        
                            
            
                                    
            
            
                | 279 | 6 |  |             $details = $this->getFilter($arguments); | 
            
                                                                        
                            
            
                                    
            
            
                | 280 | 6 |  |             $this->getQueryParameters()->setFilter($details['filter'], $details['data']); | 
            
                                                                        
                            
            
                                    
            
            
                | 281 |  |  |         } | 
            
                                                                        
                            
            
                                    
            
            
                | 282 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 283 | 6 |  |         return $this->wrapper; | 
            
                                                                        
                            
            
                                    
            
            
                | 284 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 285 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 286 | 4 |  |     public function doFilterBy() | 
            
                                                                                                            
                            
            
                                    
            
            
                | 287 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 288 | 4 |  |         $arguments = func_get_args(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 289 | 4 |  |         $details = $this->getFilter($arguments); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 290 | 4 |  |         $this->getQueryParameters()->addFilter($details['filter'], $details['data']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 291 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 292 | 4 |  |         return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 293 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 294 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 295 | 6 |  |     public function doUpdate($data) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 296 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 297 | 6 |  |         $this->driver->beginTransaction(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 298 | 6 |  |         $parameters = $this->getQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 299 | 6 |  |         $this->adapter->bulkUpdate($data, $parameters); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 300 | 6 |  |         $this->driver->commit(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 301 | 6 |  |         $this->resetQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 302 | 6 |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 303 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 304 | 2 |  |     public function doDelete($args = null) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 305 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 306 | 2 |  |         $this->driver->beginTransaction(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 307 | 2 |  |         $parameters = $this->buildFetchQueryParameters($args); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 308 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 309 | 2 |  |         if ($parameters === null) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 310 |  |  |             $primaryKey = $this->wrapper->getDescription()->getPrimaryKey(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 311 |  |  |             $parameters = $this->getQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 312 |  |  |             $data = $this->wrapper->getData(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 313 |  |  |             $keys = []; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 314 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 315 |  |  |             foreach ($data as $datum) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 316 |  |  |                 if ($this->dataOperations->isItemDeletable($primaryKey, $datum)) { | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 317 |  |  |                     $keys[] = $datum[$primaryKey[0]]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 318 |  |  |                 } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 319 |  |  |             } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 320 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 321 |  |  |             $parameters->addFilter($primaryKey[0], $keys); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 322 |  |  |             $this->adapter->delete($parameters); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 323 |  |  |         } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 324 | 2 |  |             $this->adapter->delete($parameters); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 325 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 326 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 327 | 2 |  |         $this->driver->commit(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 328 | 2 |  |         $this->resetQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 329 | 2 |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 330 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 331 | 10 |  |     public function runDynamicMethod($arguments) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 332 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 333 | 10 |  |         $arguments = count($arguments) > 1 ? $arguments : ($arguments[0] ?? null); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 334 | 10 |  |         switch ($this->pendingMethod['method']) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 335 | 10 |  |             case 'filterBy': | 
            
                                                                                                            
                            
            
                                    
            
            
                | 336 | 4 |  |                 $this->getQueryParameters()->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 337 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 338 | 4 |  |                 return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 339 | 8 |  |             case 'sort': | 
            
                                                                                                            
                            
            
                                    
            
            
                | 340 |  |  |                 $this->getQueryParameters()->addSort(Text::deCamelize($this->pendingMethod['variable']), $this->pendingMethod['direction']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 341 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 342 |  |  |                 return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 343 | 8 |  |             case 'fetch': | 
            
                                                                                                            
                            
            
                                    
            
            
                | 344 | 8 |  |                 $parameters = $this->getQueryParameters(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 345 | 8 |  |                 $parameters->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 346 | 8 |  |                 if ($this->pendingMethod['first'] === 'First') { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 347 | 8 |  |                     $parameters->setFirstOnly(true); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 348 |  |  |                 } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 349 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 350 | 8 |  |                 return $this->doFetch(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 351 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 352 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 353 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 354 | 10 |  |     public function initDynamicMethod($method) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 355 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 356 | 10 |  |         $return = false; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 357 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 358 | 10 |  |         foreach ($this->dynamicMethods as $regexp) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 359 | 10 |  |             if (preg_match($regexp, $method, $matches)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 360 | 10 |  |                 $return = true; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 361 | 10 |  |                 $this->pendingMethod = $matches; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 362 | 10 |  |                 break; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 363 |  |  |             } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 364 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 365 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 366 | 10 |  |         return $return; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 367 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 368 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 369 |  |  |     public function doCount($query = null) | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 370 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 371 |  |  |         return $this->adapter->count($this->buildFetchQueryParameters($query)); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 372 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 373 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 374 |  |  |     public function doLimit($numItems) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 375 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 376 |  |  |         $this->getQueryParameters()->setLimit($numItems); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 377 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 378 |  |  |         return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 379 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 380 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 381 |  |  |     public function doOffset($offset) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 382 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 383 |  |  |         $this->getQueryParameters()->setOffset($offset); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 384 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 385 |  |  |         return $this->wrapper; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 386 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 387 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 388 |  |  |     public function doWith($model) | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                            
            
                                    
            
            
                | 389 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 390 |  |  |         if (!isset($this->wrapper->getDescription()->getRelationships()[$model])) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 391 |  |  |             throw new ModelNotFoundException("Could not find related model [$model]"); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 392 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 393 |  |  |         $relationship = $this->wrapper->getDescription()->getRelationships()[$model]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 394 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 395 |  |  |         return $relationship->createQuery(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 396 |  |  |     } | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 397 |  |  | } | 
            
                                                        
            
                                    
            
            
                | 398 |  |  |  | 
            
                        
This check compares the return type specified in the
@returnannotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.