CFDBQueryResultIteratorFactory.php

<?php
/*
    "Contact Form to Database" Copyright (C) 2011-2014 Michael Simpson  (email : michael.d.simpson@gmail.com)

    This file is part of Contact Form to Database.

    Contact Form to Database is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Contact Form to Database is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Contact Form to Database.
    If not, see <http://www.gnu.org/licenses/>.
*/

require_once('CFDBWpdbResultIterator.php');
require_once('CFDBWpdbUnbufferedResultIterator.php');

/**
 * @singleton
 */
class CFDBQueryResultIteratorFactory {

    /**
     * @var CFDBAbstractQueryResultsIterator mock instance
     */
    var $mock;

    public static function getInstance() {
        static $inst = null;
        if ($inst === null) {
            $inst = new CFDBQueryResultIteratorFactory();
        }
        return $inst;
    }

    /**
     * @param $mock CFDBAbstractQueryResultsIterator mock for CFDBQueryResultIterator
     */
    public function setQueryResultsIteratorMock($mock) {
        $this->mock = $mock;
    }

    public function clearMock() {
        $this->mock = null;
    }

    /**
     * Factory method for getting a new CFDBQueryResultIterator or mock.
     * @param $unbuffered bool
     * @return CFDBAbstractQueryResultsIterator (or mock)
     */
    public function newQueryIterator($unbuffered = false) {
        if ($this->mock) {
            return $this->mock;
        }
        if ($unbuffered) {
          return new CFDBWpdbUnbufferedResultIterator;
        } else {
            return new CFDBWpdbResultIterator;
        }
    }

}