You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ActiveRecordCommon.php 8.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. <?php
  2. /**
  3. * Copyright distrib (2018)
  4. *
  5. * contact@opendistrib.net
  6. *
  7. * Ce logiciel est un programme informatique servant à aider les producteurs
  8. * à distribuer leur production en circuits courts.
  9. *
  10. * Ce logiciel est régi par la licence CeCILL soumise au droit français et
  11. * respectant les principes de diffusion des logiciels libres. Vous pouvez
  12. * utiliser, modifier et/ou redistribuer ce programme sous les conditions
  13. * de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
  14. * sur le site "http://www.cecill.info".
  15. *
  16. * En contrepartie de l'accessibilité au code source et des droits de copie,
  17. * de modification et de redistribution accordés par cette licence, il n'est
  18. * offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
  19. * seule une responsabilité restreinte pèse sur l'auteur du programme, le
  20. * titulaire des droits patrimoniaux et les concédants successifs.
  21. *
  22. * A cet égard l'attention de l'utilisateur est attirée sur les risques
  23. * associés au chargement, à l'utilisation, à la modification et/ou au
  24. * développement et à la reproduction du logiciel par l'utilisateur étant
  25. * donné sa spécificité de logiciel libre, qui peut le rendre complexe à
  26. * manipuler et qui le réserve donc à des développeurs et des professionnels
  27. * avertis possédant des connaissances informatiques approfondies. Les
  28. * utilisateurs sont donc invités à charger et tester l'adéquation du
  29. * logiciel à leurs besoins dans des conditions permettant d'assurer la
  30. * sécurité de leurs systèmes et ou de leurs données et, plus généralement,
  31. * à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
  32. *
  33. * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
  34. * pris connaissance de la licence CeCILL, et que vous en avez accepté les
  35. * termes.
  36. */
  37. namespace common\components;
  38. use common\helpers\GlobalParam;
  39. class ActiveRecordCommon extends \yii\db\ActiveRecord
  40. {
  41. const SEARCH_QUERY = 'query';
  42. const SEARCH_ALL = 'all';
  43. const SEARCH_ONE = 'one';
  44. const SEARCH_COUNT = 'count';
  45. public function populateFieldObject($fieldIdentifier, $fieldObject, $object)
  46. {
  47. $this->{$fieldIdentifier} = $object->id;
  48. $this->populateRelation($fieldObject, $object);
  49. }
  50. /**
  51. * Méthode générique de recherche utilisée pour tous les modèles. Elle a
  52. * pour but de construire la requête et de retourner le résultat.
  53. *
  54. * @param array $params
  55. * @param array $options
  56. * @return mixed
  57. * @throws NotFoundHttpException
  58. */
  59. public static function searchBy($params = [], $options = [])
  60. {
  61. $class = get_called_class();
  62. $repositoryClass = str_replace('\\Model\\', '\\Repository\\', $class).'Repository';
  63. $repository = $repositoryClass::getInstance();
  64. if(method_exists($repository , 'getDefaultOptionsSearch')) {
  65. $default_options = $repository->getDefaultOptionsSearch();
  66. } else {
  67. throw new \ErrorException('La méthode "getDefaultOptionsSearch" n\'est '
  68. . 'pas définie dans la classe "' . $repositoryClass . '"');
  69. }
  70. $options = array_merge($default_options, $options);
  71. $pk = $class::primaryKey();
  72. $pk = $class::tableName() . '.' . $pk[0];
  73. if (isset($options['attribute_id_producer']) && strlen($options['attribute_id_producer'])
  74. && !isset($params[$options['attribute_id_producer']]) && !\Yii::$app->user->isGuest
  75. ) {
  76. $params[$options['attribute_id_producer']] = GlobalParam::getCurrentProducerId();
  77. }
  78. if (!isset($options['type_search'])) {
  79. $options['type_search'] = self::SEARCH_ALL;
  80. }
  81. if($class == 'common\models\PointSale' && !isset($options['status'])) {
  82. $params['status'] = 1;
  83. }
  84. $records = $class::find();
  85. // With
  86. if (is_array($options['with']) && count($options['with'])) {
  87. $records = $records->with($options['with']);
  88. }
  89. // Join with
  90. if (is_array($options['join_with']) && count($options['join_with'])) {
  91. $records = $records->joinWith($options['join_with']);
  92. }
  93. // Conditions
  94. if (isset($options['conditions'])) {
  95. if (is_array($options['conditions'])) {
  96. if (count($options['conditions'])) {
  97. foreach ($options['conditions'] as $condition) {
  98. $records = $records->andWhere($condition);
  99. }
  100. }
  101. } else {
  102. if (strlen($options['conditions'])) {
  103. $records = $records->andWhere($options['conditions']);
  104. }
  105. }
  106. }
  107. // Params
  108. if (isset($options['params']) && is_array($options['params']) && count($options['params'])) {
  109. $records = $records->params($options['params']);
  110. }
  111. // Paramètres
  112. if (is_array($params) && count($params)) {
  113. foreach ($params as $key => $val) {
  114. if (strpos($key, '.') === false) {
  115. unset($params[$key]);
  116. $key = $class::tableName() . '.' . $key;
  117. $params[$key] = $val;
  118. }
  119. $records = $records->andWhere([$key => $val]);
  120. }
  121. }
  122. if (!isset($params[$pk])) {
  123. // Orderby
  124. if (isset($options['orderby']) && strlen($options['orderby'])) {
  125. $records = $records->orderBy($options['orderby']);
  126. }
  127. // Limit
  128. if (isset($options['limit']) && is_numeric($options['limit'])
  129. && $options['limit'] > 0) {
  130. $records = $records->limit($options['limit']);
  131. }
  132. }
  133. if (isset($options['groupby'])) {
  134. $records = $records->groupBy($options['groupby']);
  135. }
  136. if (isset($options['as_array'])) {
  137. $records = $records->asArray();
  138. }
  139. if ($options['type_search'] == self::SEARCH_QUERY) {
  140. self::groupByPrimaryKey($class, $records);
  141. return $records;
  142. } elseif ($options['type_search'] == self::SEARCH_ALL) {
  143. return $records->all();
  144. } elseif ($options['type_search'] == self::SEARCH_ONE) {
  145. $record = $records->one();
  146. if ($record) {
  147. return $record;
  148. }
  149. } elseif ($options['type_search'] == self::SEARCH_COUNT) {
  150. self::groupByPrimaryKey($class, $records);
  151. return $records->count();
  152. }
  153. return null;
  154. }
  155. public static function groupByPrimaryKey($class, $records)
  156. {
  157. $primaryKey = static::primaryKey();
  158. $records = $records->groupBy($class::tableName() . '.' . $primaryKey[0]);
  159. }
  160. public static function searchQuery($params = [], $options = [])
  161. {
  162. $options['type_search'] = self::SEARCH_QUERY;
  163. return self::searchDispatch($params, $options);
  164. }
  165. /**
  166. * Recherche un enregistrement.
  167. *
  168. * @param array $params
  169. * @param array $options
  170. * @return mixed
  171. */
  172. public static function searchOne($params = [], $options = [])
  173. {
  174. $options['type_search'] = self::SEARCH_ONE;
  175. return self::searchDispatch($params, $options);
  176. }
  177. /**
  178. * Recherche tous les enregistrements.
  179. *
  180. * @param array $params
  181. * @param array $options
  182. * @return mixed
  183. */
  184. public static function searchAll($params = [], $options = [])
  185. {
  186. $options['type_search'] = self::SEARCH_ALL;
  187. return self::searchDispatch($params, $options);
  188. }
  189. /**
  190. * Recherche et compte le nombre de résultats.
  191. *
  192. * @param array $params
  193. * @param array $options
  194. * @return integer
  195. */
  196. public static function searchCount($params = [], $options = [])
  197. {
  198. $options['type_search'] = self::SEARCH_COUNT;
  199. return self::searchDispatch($params, $options);
  200. }
  201. /**
  202. * Appelle la méthode 'search' de la classe appellante.
  203. *
  204. * @param array $params
  205. * @param array $options
  206. * @return mixed
  207. */
  208. public static function searchDispatch($params = [], $options = [])
  209. {
  210. $class = get_called_class();
  211. return $class::searchBy($params, $options);
  212. }
  213. }