doctrine2/lib/Doctrine/Task/Dql.php

<?php
/*
 *  $Id: Dql.php 2761 2007-10-07 23:42:29Z zYne $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.phpdoctrine.org>.
 */

/**
 * Doctrine_Task_Dql
 *
 * @package     Doctrine
 * @subpackage  Task
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        www.phpdoctrine.org
 * @since       1.0
 * @version     $Revision: 2761 $
 * @author      Jonathan H. Wage <jwage@mac.com>
 */
class Doctrine_Task_Dql extends Doctrine_Task
{
    public $description          =   'Execute dql query and display the results',
           $requiredArguments    =   array('models_path'    =>  'Specify path to your Doctrine_Record definitions.',
                                           'dql_query'      =>  'Specify the complete dql query to execute.'),
           $optionalArguments    =   array('params'         =>  'Comma separated list of the params to replace the ? tokens in the dql');

    public function execute()
    {
        Doctrine::loadModels($this->getArgument('models_path'));

        $dql = $this->getArgument('dql_query');

        $query = new Doctrine_Query();

        $params = $this->getArgument('params');
        $params = $params ? explode(',', $params):array();

        $this->notify('executing: "' . $dql . '" (' . implode(', ', $params) . ')');

        $results = $query->query($dql);

        $this->_printResults($results);
    }

    protected function _printResults($data)
    {
        $array = $data->toArray(true);

        $yaml = Doctrine_Parser::dump($array, 'yml');
        $lines = explode("\n", $yaml);

        unset($lines[0]);
        $lines[1] = $data->getTable()->getOption('name') . ':';

        foreach ($lines as $yamlLine) {
            $line = trim($yamlLine);

            if ($line) {
                $this->notify($yamlLine);
            }
        }
    }
}