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 7.1KB

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