Conditions | 1 |
Paths | 1 |
Total Lines | 601 |
Code Lines | 385 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
863 | public function dataProviderForTestMergeExternal() { |
||
864 | return array( |
||
865 | array( |
||
866 | // {{{ #0 hasMany |
||
867 | 'User', |
||
868 | 'Comment', |
||
869 | // $meta |
||
870 | array( |
||
871 | 'parentKey' => 'id', |
||
872 | 'targetKey' => 'user_id', |
||
873 | 'options' => array('fields' => 'id'), |
||
874 | 'has' => true, |
||
875 | 'belong' => false, |
||
876 | 'many' => true, |
||
877 | 'external' => true, |
||
878 | ), |
||
879 | // $results |
||
880 | array( |
||
881 | array( |
||
882 | 'User' => array( |
||
883 | 'id' => '2', |
||
884 | ), |
||
885 | ), |
||
886 | array( |
||
887 | 'User' => array( |
||
888 | 'id' => '4', |
||
889 | ), |
||
890 | ), |
||
891 | ), |
||
892 | // $frixtures |
||
893 | array('User', 'Comment'), |
||
894 | // $expectedArgument |
||
895 | array( |
||
896 | array( |
||
897 | 'Comment' => array( |
||
898 | 'id' => '1', |
||
899 | 'user_id' => '2', |
||
900 | ), |
||
901 | 'EagerLoaderModel' => array( |
||
902 | 'assoc_id' => '2', |
||
903 | ), |
||
904 | ), |
||
905 | array( |
||
906 | 'Comment' => array( |
||
907 | 'id' => '2', |
||
908 | 'user_id' => '4', |
||
909 | ), |
||
910 | 'EagerLoaderModel' => array( |
||
911 | 'assoc_id' => '4', |
||
912 | ), |
||
913 | ), |
||
914 | array( |
||
915 | 'Comment' => array( |
||
916 | 'id' => '6', |
||
917 | 'user_id' => '2', |
||
918 | ), |
||
919 | 'EagerLoaderModel' => array( |
||
920 | 'assoc_id' => '2', |
||
921 | ), |
||
922 | ), |
||
923 | ), |
||
924 | // $expectedResults |
||
925 | array( |
||
926 | array( |
||
927 | 'User' => array( |
||
928 | 'id' => '2', |
||
929 | 'Comment' => array( |
||
930 | array( |
||
931 | 'id' => '1', |
||
932 | 'user_id' => '2', |
||
933 | ), |
||
934 | array( |
||
935 | 'id' => '6', |
||
936 | 'user_id' => '2', |
||
937 | ), |
||
938 | ), |
||
939 | ), |
||
940 | ), |
||
941 | array( |
||
942 | 'User' => array( |
||
943 | 'id' => '4', |
||
944 | 'Comment' => array( |
||
945 | array( |
||
946 | 'id' => '2', |
||
947 | 'user_id' => '4', |
||
948 | ), |
||
949 | ), |
||
950 | ), |
||
951 | ) |
||
952 | ), |
||
953 | // }}} |
||
954 | ), |
||
955 | array( |
||
956 | // {{{ #1 hasMany (limited) |
||
957 | 'User', |
||
958 | 'Comment', |
||
959 | // $meta |
||
960 | array( |
||
961 | 'parentKey' => 'id', |
||
962 | 'targetKey' => 'user_id', |
||
963 | 'options' => array('fields' => 'id', 'limit' => 1), |
||
964 | 'has' => true, |
||
965 | 'belong' => false, |
||
966 | 'many' => true, |
||
967 | 'external' => true, |
||
968 | ), |
||
969 | // $results |
||
970 | array( |
||
971 | array( |
||
972 | 'User' => array( |
||
973 | 'id' => '2', |
||
974 | ), |
||
975 | ), |
||
976 | array( |
||
977 | 'User' => array( |
||
978 | 'id' => '4', |
||
979 | ), |
||
980 | ), |
||
981 | ), |
||
982 | // $frixtures |
||
983 | array('User', 'Comment'), |
||
984 | // $expectedArgument |
||
985 | array( |
||
986 | array( |
||
987 | 'Comment' => array( |
||
988 | 'id' => '1', |
||
989 | 'user_id' => '2', |
||
990 | ), |
||
991 | 'EagerLoaderModel' => array( |
||
992 | 'assoc_id' => '2', |
||
993 | ), |
||
994 | ), |
||
995 | array( |
||
996 | 'Comment' => array( |
||
997 | 'id' => '2', |
||
998 | 'user_id' => '4', |
||
999 | ), |
||
1000 | 'EagerLoaderModel' => array( |
||
1001 | 'assoc_id' => '4', |
||
1002 | ), |
||
1003 | ), |
||
1004 | ), |
||
1005 | // $expectedResults |
||
1006 | array( |
||
1007 | array( |
||
1008 | 'User' => array( |
||
1009 | 'id' => '2', |
||
1010 | 'Comment' => array( |
||
1011 | array( |
||
1012 | 'id' => '1', |
||
1013 | 'user_id' => '2', |
||
1014 | ), |
||
1015 | ), |
||
1016 | ), |
||
1017 | ), |
||
1018 | array( |
||
1019 | 'User' => array( |
||
1020 | 'id' => '4', |
||
1021 | 'Comment' => array( |
||
1022 | array( |
||
1023 | 'id' => '2', |
||
1024 | 'user_id' => '4', |
||
1025 | ), |
||
1026 | ), |
||
1027 | ), |
||
1028 | ) |
||
1029 | ), |
||
1030 | // }}} |
||
1031 | ), |
||
1032 | array( |
||
1033 | // {{{ #2 hasOne (external) |
||
1034 | 'Comment', |
||
1035 | 'Attachment', |
||
1036 | // $meta |
||
1037 | array( |
||
1038 | 'parentKey' => 'id', |
||
1039 | 'targetKey' => 'comment_id', |
||
1040 | 'options' => array('fields' => 'id'), |
||
1041 | 'has' => true, |
||
1042 | 'belong' => false, |
||
1043 | 'many' => false, |
||
1044 | 'external' => true, |
||
1045 | ), |
||
1046 | // $results |
||
1047 | array( |
||
1048 | array( |
||
1049 | 'Comment' => array( |
||
1050 | 'id' => '5', |
||
1051 | ), |
||
1052 | ), |
||
1053 | ), |
||
1054 | // $frixtures |
||
1055 | array('Comment', 'Attachment'), |
||
1056 | // $expectedArgument |
||
1057 | array( |
||
1058 | array( |
||
1059 | 'Attachment' => array( |
||
1060 | 'id' => '1', |
||
1061 | 'comment_id' => '5', |
||
1062 | ), |
||
1063 | 'EagerLoaderModel' => array( |
||
1064 | 'assoc_id' => '5', |
||
1065 | ), |
||
1066 | ), |
||
1067 | ), |
||
1068 | // $expectedResults |
||
1069 | array( |
||
1070 | array( |
||
1071 | 'Comment' => array( |
||
1072 | 'id' => '5', |
||
1073 | 'Attachment' => array( |
||
1074 | 'id' => '1', |
||
1075 | 'comment_id' => '5', |
||
1076 | ), |
||
1077 | ), |
||
1078 | ), |
||
1079 | ), |
||
1080 | // }}} |
||
1081 | ), |
||
1082 | array( |
||
1083 | // {{{ #3 hasAndBelongsToMany |
||
1084 | 'Article', |
||
1085 | 'Tag', |
||
1086 | // $meta |
||
1087 | array( |
||
1088 | 'parentKey' => 'id', |
||
1089 | 'targetKey' => 'id', |
||
1090 | 'options' => array('fields' => 'id', 'order' => array('ArticlesTag.article_id')), |
||
1091 | 'habtmAlias' => 'ArticlesTag', |
||
1092 | 'habtmParentKey' => 'article_id', |
||
1093 | 'habtmTargetKey' => 'tag_id', |
||
1094 | 'has' => true, |
||
1095 | 'belong' => true, |
||
1096 | 'many' => true, |
||
1097 | 'external' => true, |
||
1098 | ), |
||
1099 | // $results |
||
1100 | array( |
||
1101 | array( |
||
1102 | 'Article' => array( |
||
1103 | 'id' => '1', |
||
1104 | ), |
||
1105 | ), |
||
1106 | array( |
||
1107 | 'Article' => array( |
||
1108 | 'id' => '2', |
||
1109 | ), |
||
1110 | ), |
||
1111 | ), |
||
1112 | // $frixtures |
||
1113 | array('Article', 'Tag', 'ArticlesTag'), |
||
1114 | // $expectedArgument |
||
1115 | array( |
||
1116 | array( |
||
1117 | 'Tag' => array( |
||
1118 | 'id' => '1', |
||
1119 | ), |
||
1120 | 'ArticlesTag' => array( |
||
1121 | 'article_id' => '1', |
||
1122 | 'tag_id' => '1', |
||
1123 | ), |
||
1124 | 'EagerLoaderModel' => array( |
||
1125 | 'assoc_id' => '1', |
||
1126 | ), |
||
1127 | ), |
||
1128 | array( |
||
1129 | 'Tag' => array( |
||
1130 | 'id' => '2', |
||
1131 | ), |
||
1132 | 'ArticlesTag' => array( |
||
1133 | 'article_id' => '1', |
||
1134 | 'tag_id' => '2', |
||
1135 | ), |
||
1136 | 'EagerLoaderModel' => array( |
||
1137 | 'assoc_id' => '1', |
||
1138 | ), |
||
1139 | ), |
||
1140 | array( |
||
1141 | 'Tag' => array( |
||
1142 | 'id' => '1', |
||
1143 | ), |
||
1144 | 'ArticlesTag' => array( |
||
1145 | 'article_id' => '2', |
||
1146 | 'tag_id' => '1', |
||
1147 | ), |
||
1148 | 'EagerLoaderModel' => array( |
||
1149 | 'assoc_id' => '2', |
||
1150 | ), |
||
1151 | ), |
||
1152 | array( |
||
1153 | 'Tag' => array( |
||
1154 | 'id' => '3', |
||
1155 | ), |
||
1156 | 'ArticlesTag' => array( |
||
1157 | 'article_id' => '2', |
||
1158 | 'tag_id' => '3', |
||
1159 | ), |
||
1160 | 'EagerLoaderModel' => array( |
||
1161 | 'assoc_id' => '2', |
||
1162 | ), |
||
1163 | ), |
||
1164 | ), |
||
1165 | // $expectedResults |
||
1166 | array( |
||
1167 | array( |
||
1168 | 'Article' => array( |
||
1169 | 'id' => '1', |
||
1170 | 'Tag' => array( |
||
1171 | array( |
||
1172 | 'id' => '1', |
||
1173 | 'ArticlesTag' => array( |
||
1174 | 'article_id' => '1', |
||
1175 | 'tag_id' => '1', |
||
1176 | ), |
||
1177 | ), |
||
1178 | array( |
||
1179 | 'id' => '2', |
||
1180 | 'ArticlesTag' => array( |
||
1181 | 'article_id' => '1', |
||
1182 | 'tag_id' => '2', |
||
1183 | ), |
||
1184 | ), |
||
1185 | ), |
||
1186 | ), |
||
1187 | ), |
||
1188 | array( |
||
1189 | 'Article' => array( |
||
1190 | 'id' => '2', |
||
1191 | 'Tag' => array( |
||
1192 | array( |
||
1193 | 'id' => '1', |
||
1194 | 'ArticlesTag' => array( |
||
1195 | 'article_id' => '2', |
||
1196 | 'tag_id' => '1', |
||
1197 | ), |
||
1198 | ), |
||
1199 | array( |
||
1200 | 'id' => '3', |
||
1201 | 'ArticlesTag' => array( |
||
1202 | 'article_id' => '2', |
||
1203 | 'tag_id' => '3', |
||
1204 | ), |
||
1205 | ), |
||
1206 | ), |
||
1207 | ), |
||
1208 | ), |
||
1209 | ), |
||
1210 | // }}} |
||
1211 | ), |
||
1212 | array( |
||
1213 | // {{{ #4 hasOne (finderQuery) |
||
1214 | 'Apple', |
||
1215 | 'NextApple', |
||
1216 | // $meta |
||
1217 | array( |
||
1218 | 'parentAlias' => 'Apple', |
||
1219 | 'parentKey' => 'id', |
||
1220 | 'targetKey' => 'apple_id', |
||
1221 | 'aliasPath' => 'Apple.NextApple', |
||
1222 | 'propertyPath' => 'Apple.NextApple', |
||
1223 | 'options' => array(), |
||
1224 | 'has' => true, |
||
1225 | 'belong' => false, |
||
1226 | 'many' => false, |
||
1227 | 'external' => true, |
||
1228 | ), |
||
1229 | // $results |
||
1230 | array( |
||
1231 | array( |
||
1232 | 'Apple' => array( |
||
1233 | 'id' => '1', |
||
1234 | ), |
||
1235 | ), |
||
1236 | array( |
||
1237 | 'Apple' => array( |
||
1238 | 'id' => '5', |
||
1239 | ), |
||
1240 | ), |
||
1241 | ), |
||
1242 | // $fixtures |
||
1243 | array('Apple'), |
||
1244 | // $expectedArgument |
||
1245 | array( |
||
1246 | array( |
||
1247 | 'NextApple' => array( |
||
1248 | 'id' => '2', |
||
1249 | 'apple_id' => '1', |
||
1250 | 'color' => 'Bright Red 1', |
||
1251 | 'name' => 'Bright Red Apple', |
||
1252 | 'created' => '2006-11-22 10:43:13', |
||
1253 | 'modified' => '2006-11-30 18:38:10', |
||
1254 | ), |
||
1255 | 'EagerLoaderModel' => array( |
||
1256 | 'assoc_id' => '1', |
||
1257 | ), |
||
1258 | ), |
||
1259 | array( |
||
1260 | 'NextApple' => array( |
||
1261 | 'id' => '6', |
||
1262 | 'apple_id' => 4, |
||
1263 | 'color' => 'My new appleOrange', |
||
1264 | 'name' => 'My new apple', |
||
1265 | 'created' => '2006-12-25 05:29:39', |
||
1266 | 'modified' => '2006-12-25 05:29:39', |
||
1267 | ), |
||
1268 | 'EagerLoaderModel' => array( |
||
1269 | 'assoc_id' => '5', |
||
1270 | ), |
||
1271 | ), |
||
1272 | ), |
||
1273 | // $expectedResults |
||
1274 | array( |
||
1275 | array( |
||
1276 | 'Apple' => array( |
||
1277 | 'id' => '1', |
||
1278 | 'NextApple' => array( |
||
1279 | 'id' => '2', |
||
1280 | 'apple_id' => 1, |
||
1281 | 'color' => 'Bright Red 1', |
||
1282 | 'name' => 'Bright Red Apple', |
||
1283 | 'created' => '2006-11-22 10:43:13', |
||
1284 | 'modified' => '2006-11-30 18:38:10', |
||
1285 | ), |
||
1286 | ), |
||
1287 | ), |
||
1288 | array( |
||
1289 | 'Apple' => array( |
||
1290 | 'id' => '5', |
||
1291 | 'NextApple' => array( |
||
1292 | 'id' => '6', |
||
1293 | 'apple_id' => 4, |
||
1294 | 'color' => 'My new appleOrange', |
||
1295 | 'name' => 'My new apple', |
||
1296 | 'created' => '2006-12-25 05:29:39', |
||
1297 | 'modified' => '2006-12-25 05:29:39', |
||
1298 | ), |
||
1299 | ), |
||
1300 | ), |
||
1301 | ), |
||
1302 | // }}} |
||
1303 | ), |
||
1304 | array( |
||
1305 | // {{{ #5 belongsTo |
||
1306 | 'Article', |
||
1307 | 'User', |
||
1308 | // $meta |
||
1309 | array( |
||
1310 | 'parentAlias' => 'Article', |
||
1311 | 'parentKey' => 'user_id', |
||
1312 | 'targetKey' => 'id', |
||
1313 | 'aliasPath' => 'Article.User', |
||
1314 | 'propertyPath' => 'Article.User', |
||
1315 | 'options' => array( |
||
1316 | 'fields' => 'id', |
||
1317 | ), |
||
1318 | 'has' => false, |
||
1319 | 'belong' => true, |
||
1320 | 'many' => false, |
||
1321 | 'external' => false, |
||
1322 | ), |
||
1323 | // $results |
||
1324 | array( |
||
1325 | array( |
||
1326 | 'Article' => array( |
||
1327 | 'id' => '1', |
||
1328 | 'user_id' => '1', |
||
1329 | ), |
||
1330 | 'User' => array( |
||
1331 | 'id' => '1', |
||
1332 | 'dummy' => '1', |
||
1333 | ), |
||
1334 | ), |
||
1335 | array( |
||
1336 | 'Article' => array( |
||
1337 | 'id' => '3', |
||
1338 | 'user_id' => '1', |
||
1339 | ), |
||
1340 | 'User' => array( |
||
1341 | 'id' => '1', |
||
1342 | 'dummy' => '2', |
||
1343 | ), |
||
1344 | ) |
||
1345 | ), |
||
1346 | // $fixtures |
||
1347 | array('Article', 'User'), |
||
1348 | // $expectedArgument |
||
1349 | array( |
||
1350 | array( |
||
1351 | 'User' => array( |
||
1352 | 'id' => '1', |
||
1353 | 'dummy' => '1', |
||
1354 | ), |
||
1355 | ), |
||
1356 | array( |
||
1357 | 'User' => array( |
||
1358 | 'id' => '1', |
||
1359 | 'dummy' => '2', |
||
1360 | ), |
||
1361 | ), |
||
1362 | ), |
||
1363 | // $expectedResults |
||
1364 | array( |
||
1365 | array( |
||
1366 | 'Article' => array( |
||
1367 | 'id' => '1', |
||
1368 | 'user_id' => '1', |
||
1369 | 'User' => array( |
||
1370 | 'id' => '1', |
||
1371 | 'dummy' => '1', |
||
1372 | ), |
||
1373 | ), |
||
1374 | ), |
||
1375 | array( |
||
1376 | 'Article' => array( |
||
1377 | 'id' => '3', |
||
1378 | 'user_id' => '1', |
||
1379 | 'User' => array( |
||
1380 | 'id' => '1', |
||
1381 | 'dummy' => '2', |
||
1382 | ), |
||
1383 | ), |
||
1384 | ), |
||
1385 | ), |
||
1386 | // }}} |
||
1387 | ), |
||
1388 | array( |
||
1389 | // {{{ #6 hasOne |
||
1390 | 'Comment', |
||
1391 | 'Attachment', |
||
1392 | // $meta |
||
1393 | array( |
||
1394 | 'parentAlias' => 'Comment', |
||
1395 | 'parentKey' => 'id', |
||
1396 | 'targetKey' => 'comment_id', |
||
1397 | 'aliasPath' => 'Comment.Attachment', |
||
1398 | 'propertyPath' => 'Comment.Attachment', |
||
1399 | 'options' => array( |
||
1400 | 'fields' => 'id', |
||
1401 | ), |
||
1402 | 'has' => true, |
||
1403 | 'belong' => false, |
||
1404 | 'many' => false, |
||
1405 | 'external' => false, |
||
1406 | ), |
||
1407 | // $results |
||
1408 | array( |
||
1409 | array( |
||
1410 | 'Comment' => array( |
||
1411 | 'id' => '1', |
||
1412 | ), |
||
1413 | 'Attachment' => array( |
||
1414 | 'id' => null, |
||
1415 | 'comment_id' => null, |
||
1416 | ), |
||
1417 | ), |
||
1418 | array( |
||
1419 | 'Comment' => array( |
||
1420 | 'id' => '5', |
||
1421 | ), |
||
1422 | 'Attachment' => array( |
||
1423 | 'id' => '1', |
||
1424 | 'comment_id' => '5', |
||
1425 | ), |
||
1426 | ) |
||
1427 | ), |
||
1428 | // $fixtures |
||
1429 | array('Comment', 'Attachment'), |
||
1430 | // $expectedArgument |
||
1431 | array( |
||
1432 | array( |
||
1433 | 'Attachment' => array(), |
||
1434 | ), |
||
1435 | array( |
||
1436 | 'Attachment' => array( |
||
1437 | 'id' => '1', |
||
1438 | 'comment_id' => '5', |
||
1439 | ), |
||
1440 | ), |
||
1441 | ), |
||
1442 | // $expectedResults |
||
1443 | array( |
||
1444 | array( |
||
1445 | 'Comment' => array( |
||
1446 | 'id' => '1', |
||
1447 | 'Attachment' => array(), |
||
1448 | ), |
||
1449 | ), |
||
1450 | array( |
||
1451 | 'Comment' => array( |
||
1452 | 'id' => '5', |
||
1453 | 'Attachment' => array( |
||
1454 | 'id' => '1', |
||
1455 | 'comment_id' => '5', |
||
1456 | ), |
||
1457 | ), |
||
1458 | ), |
||
1459 | ), |
||
1460 | // }}} |
||
1461 | ), |
||
1462 | ); |
||
1463 | } |
||
1464 | |||
1497 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.