210 lines
8.2KB

  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_ALL = 'all';
  42. const SEARCH_ONE = 'one';
  43. const SEARCH_COUNT = 'count';
  44. /**
  45. * Méthode générique de recherche utilisée pour tous les modèles. Elle a
  46. * pour but de construire la requête et de retourner le résultat.
  47. *
  48. * @param array $params
  49. * @param array $options
  50. * @return mixed
  51. * @throws NotFoundHttpException
  52. */
  53. public static function searchBy($params = [], $options = [])
  54. {
  55. $class = get_called_class();
  56. if (is_callable([$class, 'defaultOptionsSearch'])) {
  57. $default_options = $class::defaultOptionsSearch();
  58. } else {
  59. throw new \ErrorException('La méthode "defaultOptionsSearch" n\'est '
  60. . 'pas définie dans la classe "' . $class . '"');
  61. }
  62. $options = array_merge($default_options, $options);
  63. $pk = $class::primaryKey();
  64. $pk = $class::tableName() . '.' . $pk[0];
  65. if (isset($options['attribute_id_producer']) && strlen($options['attribute_id_producer'])
  66. && !isset($params[$options['attribute_id_producer']]) && !Yii::$app->user->isGuest) {
  67. $params[$options['attribute_id_producer']] = GlobalParam::getCurrentProducerId();
  68. }
  69. if (!isset($options['type_search'])) {
  70. $options['type_search'] = self::SEARCH_ALL;
  71. }
  72. $records = $class::find();
  73. // With
  74. if (is_array($options['with']) && count($options['with'])) {
  75. $records = $records->with($options['with']);
  76. }
  77. // Join with
  78. if (is_array($options['join_with']) && count($options['join_with'])) {
  79. $records = $records->joinWith($options['join_with']);
  80. }
  81. // Conditions
  82. if (isset($options['conditions'])) {
  83. if (is_array($options['conditions'])) {
  84. if (count($options['conditions'])) {
  85. foreach ($options['conditions'] as $condition) {
  86. $records = $records->andWhere($condition);
  87. }
  88. }
  89. } else {
  90. if (strlen($options['conditions'])) {
  91. $records = $records->andWhere($options['conditions']);
  92. }
  93. }
  94. }
  95. // Params
  96. if (isset($options['params']) && is_array($options['params']) && count($options['params'])) {
  97. $records = $records->params($options['params']);
  98. }
  99. // Paramètres
  100. if (is_array($params) && count($params)) {
  101. foreach ($params as $key => $val) {
  102. if (strpos($key, '.') === false) {
  103. unset($params[$key]);
  104. $key = $class::tableName() . '.' . $key;
  105. $params[$key] = $val;
  106. }
  107. $records = $records->andWhere([$key => $val]);
  108. }
  109. }
  110. if (!isset($params[$pk])) {
  111. // Orderby
  112. if (isset($options['orderby']) && strlen($options['orderby'])) {
  113. $records = $records->orderBy($options['orderby']);
  114. }
  115. // Limit
  116. if (isset($options['limit']) && is_numeric($options['limit'])
  117. && $options['limit'] > 0) {
  118. $records = $records->limit($options['limit']);
  119. }
  120. }
  121. if (isset($options['as_array'])) {
  122. $records = $records->asArray();
  123. }
  124. if ($options['type_search'] == self::SEARCH_ALL) {
  125. return $records->all();
  126. } elseif ($options['type_search'] == self::SEARCH_ONE) {
  127. $record = $records->one();
  128. if ($record) {
  129. return $record;
  130. }
  131. } elseif ($options['type_search'] == self::SEARCH_COUNT) {
  132. return $records->count();
  133. }
  134. return false;
  135. }
  136. /**
  137. * Recherche un enregistrement.
  138. *
  139. * @param array $params
  140. * @param array $options
  141. * @return mixed
  142. */
  143. public static function searchOne($params = [], $options = [])
  144. {
  145. $options['type_search'] = self::SEARCH_ONE;
  146. return self::searchDispatch($params, $options);
  147. }
  148. /**
  149. * Recherche tous les enregistrements.
  150. *
  151. * @param array $params
  152. * @param array $options
  153. * @return mixed
  154. */
  155. public static function searchAll($params = [], $options = [])
  156. {
  157. $options['type_search'] = self::SEARCH_ALL;
  158. return self::searchDispatch($params, $options);
  159. }
  160. /**
  161. * Recherche et compte le nombre de résultats.
  162. *
  163. * @param array $params
  164. * @param array $options
  165. * @return integer
  166. */
  167. public static function searchCount($params = [], $options = [])
  168. {
  169. $options['type_search'] = self::SEARCH_COUNT;
  170. return self::searchDispatch($params, $options);
  171. }
  172. /**
  173. * Appelle la méthode 'search' de la classe appellante.
  174. *
  175. * @param array $params
  176. * @param array $options
  177. * @return mixed
  178. */
  179. public static function searchDispatch($params = [], $options = [])
  180. {
  181. $class = get_called_class();
  182. return $class::searchBy($params, $options);
  183. }
  184. }