├── .gitignore ├── LICENSE ├── README.md ├── examples ├── _include.php ├── animal_tags.php └── animal_tags2.php ├── lib ├── MongoMapReduce.php ├── MongoMapReduceResponse.php └── XMongoCollection.php └── tests ├── MongoMapReduceResponseTest.php ├── MongoMapReduceTest.php ├── _include.php └── fixtures └── animal_tags.json /.gitignore: -------------------------------------------------------------------------------- 1 | .project 2 | .buildpath 3 | .*.sw[a-z] 4 | *.un~ 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MapReduce Abstraction Layer for MongoDB using PHP Driver 2 | ======================================================== 3 | 4 | See examples folder for usage 5 | -------------------------------------------------------------------------------- /examples/_include.php: -------------------------------------------------------------------------------- 1 | remove(array()); //remove all documents of that collection 22 | 23 | $fixture = array( 24 | array('_id' => 1, 'tags' => array('dog', 'cat')), 25 | array('_id' => 2, 'tags' => array('cat')), 26 | array('_id' => 3, 'tags' => array('mouse', 'cat', 'dog')), 27 | array('_id' => 4, 'tags' => array()) 28 | ); 29 | $collection->batchInsert($fixture, array('safe' => true)); 30 | return $mongodb; 31 | } 32 | -------------------------------------------------------------------------------- /examples/animal_tags.php: -------------------------------------------------------------------------------- 1 | invoke($mongodb, $collection_name); 28 | if ($response->valid()) { 29 | echo "Total Execution Time: {$response->getTotalExecutionTime()} Milli Seconds\n"; 30 | $count_data = $response->getCountsData(); 31 | 32 | echo "Count Data\n"; 33 | foreach ($count_data as $key=>$value) { 34 | echo "{$key}: {$value}\n"; 35 | } 36 | echo "********************\n"; 37 | foreach ($response->getResultSet() as $tag) { 38 | echo "{$tag["_id"]}\n"; 39 | echo "Count: {$tag["value"]["count"]}\n"; 40 | echo "****************\n"; 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /examples/animal_tags2.php: -------------------------------------------------------------------------------- 1 | collectionName = self::COLLECTION_NAME; 13 | parent::__construct($mongoDB, $this->collectionName); 14 | } 15 | } 16 | 17 | $animal_tags = new AnimalTag($mongodb); 18 | 19 | $map = <<mapReduce(new MongoMapReduce($map, $reduce)); 36 | if ($response->valid()) { 37 | foreach ($response->getResultSet() as $tag) { 38 | echo "{$tag["_id"]}\n"; 39 | echo "Count: {$tag["value"]["count"]}\n"; 40 | echo "****************\n"; 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /lib/MongoMapReduce.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * This class takes required parameters to perform MongoDB MapReduce 7 | * 8 | */ 9 | 10 | class MongoMapReduce 11 | { 12 | /** 13 | * MapReduce Query Parameter variable 14 | * @var String 15 | */ 16 | private $_mapReduce; 17 | 18 | /** 19 | * MapReduce Response 20 | * @var String 21 | */ 22 | private $_response; 23 | 24 | /** 25 | * @var MongoDB 26 | */ 27 | private $mongoDB; 28 | 29 | 30 | /** 31 | * Name of the collection 32 | * @var String 33 | */ 34 | private $collectionNamespace; 35 | 36 | 37 | /** 38 | * Map Code 39 | * @var String 40 | */ 41 | private $map; 42 | 43 | 44 | /** 45 | * Reduce Code 46 | * @var String 47 | */ 48 | private $reduce; 49 | 50 | 51 | /** 52 | * Query Param 53 | * @var Array 54 | */ 55 | private $query = Array(); 56 | 57 | 58 | /** 59 | * Name of the ouput collection 60 | * @var String 61 | */ 62 | private $outputCollection; 63 | 64 | 65 | /** 66 | * Flag indicating whether to keep temporary collection created from MapReduce 67 | * @var unknown_type 68 | */ 69 | private $keepTemporaryCollection; 70 | 71 | private $finalize; 72 | 73 | private $limit; 74 | 75 | private $sort = Array(); 76 | 77 | private $scope = Array(); 78 | 79 | const VALUE = 'value'; //value index for MR Result Set 80 | 81 | const COUNT = 'count'; //number of objects in a MR Result Set 82 | 83 | const KEYS_MAPREDUCE = "mapreduce"; 84 | const KEYS_MAP = "map"; 85 | const KEYS_REDUCE = "reduce"; 86 | const KEYS_QUERY = "query"; 87 | const KEYS_KEEP_TEMPORARY_COLLECTION = "keeptemp"; 88 | const KEYS_FINALIZE = "finalize"; 89 | const KEYS_OUTPUT_COLLECTION = "out"; 90 | const KEYS_OUTPUT_SORT = "sort"; 91 | const KEYS_OUTPUT_LIMIT = "limit"; 92 | const KEYS_OUTPUT_SCOPE = "scope"; 93 | 94 | 95 | /** 96 | * 97 | * @param String $map 98 | * @param String $reduce 99 | * @param Array $query 100 | * @param String $outputCollection 101 | * @param Boolean $keepTemporaryCollection 102 | * @param String $finalize 103 | * @param Int $limit 104 | * @param Array $sort 105 | */ 106 | public function __construct($map, 107 | $reduce, 108 | Array $query = Array(), 109 | $outputCollection = NULL, 110 | $keepTemporaryCollection = FALSE, 111 | $finalize = NULL, 112 | $limit = NULL, 113 | Array $sort = Array(), 114 | Array $scope = Array()) { 115 | $this->map = $map; 116 | $this->reduce = $reduce; 117 | $this->query = $query; 118 | 119 | if (!is_null($outputCollection)) 120 | $this->outputCollection = $outputCollection; 121 | 122 | $this->keepTemporaryCollection = (bool)$keepTemporaryCollection; 123 | 124 | if (!is_null($finalize)) 125 | $this->finalize = $finalize; 126 | 127 | if (!is_int($limit)) 128 | $this->limit = $limit; 129 | 130 | $this->sort = $sort; 131 | $this->scope = $scope; 132 | } 133 | 134 | /** 135 | * 136 | * @param MongoDB $mongoDB 137 | * @return MongoMapReduceResponse 138 | */ 139 | public function invoke(MongoDB $mongoDB, $collection) { 140 | $this->collectionNamespace = $collection; 141 | $response = $mongoDB->command($this->prepare()->_mapReduce); 142 | return new MongoMapReduceResponse($mongoDB, $response); 143 | } 144 | 145 | /** 146 | * prepare map reduce parameters to be executed 147 | * @return MongoMapReduce 148 | */ 149 | private function prepare() { 150 | $this->_mapReduce = Array(); 151 | $this->_mapReduce[self::KEYS_MAPREDUCE] = $this->collectionNamespace; 152 | $this->_mapReduce[self::KEYS_MAP] = new MongoCode($this->map); 153 | $this->_mapReduce[self::KEYS_REDUCE] = new MongoCode($this->reduce); 154 | $this->_mapReduce[self::KEYS_KEEP_TEMPORARY_COLLECTION] = $this->keepTemporaryCollection; 155 | 156 | if (!empty($this->query)) 157 | $this->_mapReduce[self::KEYS_QUERY] = $this->query; 158 | 159 | if (isset($this->finalize)) 160 | $this->_mapReduce[self::KEYS_FINALIZE] = new MongoCode($this->finalize); 161 | if (isset($this->outputCollection)) 162 | $this->_mapReduce[self::KEYS_OUTPUT_COLLECTION] = $this->outputCollection; 163 | 164 | if (!empty($this->sort)) 165 | $this->_mapReduce[self::KEYS_OUTPUT_SORT] = $this->sort; 166 | 167 | if (isset($this->limit)) 168 | $this->_mapReduce[self::KEYS_OUTPUT_LIMIT] = $this->limit; 169 | 170 | if (!empty($this->scope)) 171 | $this->_mapReduce[self::KEYS_OUTPUT_SCOPE] = $this->scope; 172 | 173 | return $this; 174 | } 175 | 176 | 177 | ///SETTER METHODS/// 178 | 179 | public function setMap($map) { 180 | $this->map = $map; 181 | return $this; 182 | } 183 | 184 | public function setReduce($reduce) { 185 | $this->reduce = $reduce; 186 | return $this; 187 | } 188 | 189 | public function setQuery(Array $query) { 190 | $this->query = $query; 191 | return $this; 192 | } 193 | 194 | public function setKeepTemporaryCollection($keepTemp = TRUE) { 195 | if (is_bool($keepTemp)) 196 | $this->keepTemporaryCollection = $keepTemp; 197 | return $this; 198 | } 199 | 200 | public function setOutputCollection($outputCollection) { 201 | if ($outputCollection != '') 202 | $this->outputCollection = $outputCollection; 203 | return $this; 204 | } 205 | 206 | public function setFinalize($finalize) { 207 | if ($finalize != '') 208 | $this->finalize = $finalize; 209 | return $this; 210 | } 211 | 212 | public function setLimit($limit) { 213 | if (is_int($limit)) 214 | $this->limit = $limit; 215 | return $this; 216 | } 217 | 218 | public function setScope(Array $scope) { 219 | $this->scope = $scope; 220 | return $this; 221 | } 222 | 223 | public function setSort(Array $sort) { 224 | $this->sort = $sort; 225 | return $this; 226 | } 227 | } -------------------------------------------------------------------------------- /lib/MongoMapReduceResponse.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * This class takes handles MapReduce Reponse 7 | * 8 | */ 9 | class MongoMapReduceResponse { 10 | 11 | /** 12 | * @var MongoMapReduce 13 | */ 14 | private $_response; 15 | 16 | /** 17 | * @var MongoDB 18 | */ 19 | private $mongoDB; 20 | 21 | /** 22 | * @var MongoCollection 23 | */ 24 | private $collection; 25 | 26 | 27 | public function __construct(MongoDB $mongoDB, Array $mapReduce) { 28 | $this->_response = $mapReduce; 29 | $this->mongoDB = $mongoDB; 30 | } 31 | 32 | 33 | /** 34 | * MapReduce Result Set 35 | * @return MongoCursor 36 | */ 37 | public function getResultSet(Array $query = Array()) { 38 | if (!isset($this->collection)) { 39 | $this->collection = new MongoCollection($this->mongoDB, $this->_response["result"]); 40 | } 41 | return $this->collection->find($query); 42 | } 43 | 44 | 45 | /** 46 | * check if the MR operation failed or not 47 | * recommended to use this method before using MR result set 48 | * @return boolean 49 | */ 50 | public function valid() { 51 | return $this->_response["ok"] == 1 ? TRUE : FALSE; 52 | } 53 | 54 | 55 | /** 56 | * Get Number of Objects being iterated in MapReduce Query 57 | * @return integer 58 | */ 59 | public function getNumberOfObjects() { 60 | return $this->_response['numObjects']; 61 | } 62 | 63 | 64 | /** 65 | * Get total time in Milli Seconds to execute the MapReduce operation 66 | * @return double 67 | */ 68 | public function getTotalExecutionTime() { 69 | return $this->_response['timeMillis']; 70 | } 71 | 72 | 73 | /** 74 | * MapReduce Raw Response with index fields: timeMillis, numObjects, timeMillis.emi, ok, result 75 | * @return Array 76 | */ 77 | public function getRawResponse() { 78 | return $this->_response; 79 | } 80 | 81 | 82 | /** 83 | * error message of the MR operation 84 | * @return String 85 | */ 86 | public function getErrorMessage() { 87 | return $this->_response['errmsg']; 88 | } 89 | 90 | 91 | /** 92 | * get Array with keys: input, emit, output 93 | * input: Total number of collections that are iterated over 94 | * emit: Total number of emit functions being called 95 | * output: Total number of output keys 96 | * @return Array 97 | */ 98 | public function getCountsData() { 99 | return $this->_response['counts']; 100 | } 101 | 102 | 103 | /** 104 | * Drop the collection created by MapReduce 105 | * @return Array 106 | */ 107 | public function dropResultSet() { 108 | if (!isset($this->collection)) { 109 | $this->collection = new MongoCollection($this->mongoDB, $this->_response["result"]); 110 | } 111 | $db_response = $this->collection->drop(); 112 | $this->collection = NULL; 113 | return $db_response; 114 | 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /lib/XMongoCollection.php: -------------------------------------------------------------------------------- 1 | mongodb = $mongoDB; 8 | parent::__construct($this->mongodb, $collection_name); 9 | } 10 | 11 | /** 12 | * invoke MapReduce Operation 13 | * @param MongoMapReduce $mapReduce 14 | * @return MongoMapReduceResponse 15 | */ 16 | public function mapReduce(MongoMapReduce $mapReduce) { 17 | return $mapReduce->invoke($this->mongodb, $this->collectionName); 18 | } 19 | } -------------------------------------------------------------------------------- /tests/MongoMapReduceResponseTest.php: -------------------------------------------------------------------------------- 1 | dbName = "test_dbs"; 20 | $this->mongoDB = new MongoDB(new Mongo(), $this->dbName); 21 | 22 | $this->collectionName = "animal_tags"; 23 | 24 | $this->map = <<reduce = <<dbName = "22test_dbsaaa"; 47 | $this->mongoDB = new MongoDB(new Mongo(), $this->dbName); 48 | 49 | $this->collectionName = "animal_tags"; 50 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 51 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 52 | 53 | $error_msg = $response->getErrorMessage(); 54 | 55 | $this->assertEquals($error_msg, "ns doesn't exist"); 56 | } 57 | 58 | public function testInvalidCollectionShouldReturnNSDoesNotExist() { 59 | $this->mongoDB = new MongoDB(new Mongo(), $this->dbName); 60 | 61 | $this->collectionName = "animal_tagsaaa"; //invalid collection 62 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 63 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 64 | 65 | $error_msg = $response->getErrorMessage(); 66 | 67 | $this->assertEquals($error_msg, "ns doesn't exist"); 68 | } 69 | 70 | public function testResponseIsOKWhenMapReduceQueryIsValid() { 71 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 72 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 73 | $this->assertTrue($response->valid()); 74 | } 75 | 76 | public function testResponseIsFalseWhenMapFunctioIsInvalid() { 77 | $this->map = <<map, $this->reduce); 87 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 88 | $this->assertFalse($response->valid()); 89 | } 90 | 91 | 92 | public function testResultSet() { 93 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 94 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 95 | 96 | $mr_real_keys = Array(); 97 | $mr_expected_keys = Array("dog", "cat", "mouse"); 98 | 99 | foreach ($response->getResultSet() as $values) { 100 | array_push($mr_real_keys, $values["_id"]); 101 | $this->assertTrue(in_array($values["_id"], $mr_expected_keys)); 102 | } 103 | 104 | } 105 | 106 | public function testCountData() { 107 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 108 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 109 | if ($response->valid()) { 110 | $count_data = $response->getCountsData(); 111 | $count_data_keys = array_keys($count_data); 112 | $real = array_diff($count_data_keys, Array("input", "output", "emit")); 113 | $expected = Array(); 114 | $this->assertEquals($expected, $real); 115 | } 116 | 117 | } 118 | 119 | public function testExecutionTime() { 120 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 121 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 122 | $this->assertTrue(is_numeric($response->getTotalExecutionTime())); 123 | } 124 | 125 | 126 | public function testGlobalScope() { 127 | $map_reduce = new MongoMapReduce($this->map, $this->reduce); 128 | $global_value = 'this is global value!'; 129 | $scope = Array('global_value' => $global_value); 130 | $finalize = <<setScope($scope); 137 | $map_reduce->setFinalize($finalize); 138 | $response = $map_reduce->invoke($this->mongoDB, $this->collectionName); 139 | 140 | foreach ($response->getResultSet() as $cursor) { 141 | $this->assertEquals($global_value, $cursor["value"]["global"]); 142 | } 143 | } 144 | } -------------------------------------------------------------------------------- /tests/MongoMapReduceTest.php: -------------------------------------------------------------------------------- 1 | dbName = "test_dbs"; 19 | $this->mongoDB = new MongoDB(new Mongo(), $this->dbName); 20 | 21 | $this->collectionName = "animal_tags"; 22 | 23 | $this->map = <<reduce = <<map, $this->reduce); 45 | $this->assertTrue($map_reduce->invoke($this->mongoDB, "animal_tags") instanceof MongoMapReduceResponse); 46 | } 47 | 48 | } -------------------------------------------------------------------------------- /tests/_include.php: -------------------------------------------------------------------------------- 1 |