<?php

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2019 - 2022, CodeIgniter Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @package CodeIgniter
 * @author  EllisLab Dev Team
 * @copyright   Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
 * @copyright   Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
 * @copyright   Copyright (c) 2019 - 2022, CodeIgniter Foundation (https://codeigniter.com/)
 * @license https://opensource.org/licenses/MIT MIT License
 * @link    https://codeigniter.com
 * @since   Version 2.0.3
 * @filesource
 */

defined('BASEPATH') or exit('No direct script access allowed');

/**
 * SQLSRV Result Class
 *
 * This class extends the parent result class: CI_DB_result
 *
 * @category    Database
 * @author      EllisLab Dev Team
 * @link        https://codeigniter.com/userguide3/database/
 */
class CI_DB_sqlsrv_result extends CI_DB_result
{
    /**
     * Scrollable flag
     *
     * @var mixed
     */
    public $scrollable;

    // --------------------------------------------------------------------

    /**
     * Constructor
     *
     * @param   object  $driver_object
     * @return  void
     */
    public function __construct(&$driver_object)
    {
        parent::__construct($driver_object);

        $this->scrollable = $driver_object->scrollable;
    }

    // --------------------------------------------------------------------

    /**
     * Number of rows in the result set
     *
     * @return  int
     */
    public function num_rows()
    {
        // sqlsrv_num_rows() doesn't work with the FORWARD and DYNAMIC cursors (FALSE is the same as FORWARD)
        if (! in_array($this->scrollable, array(false, SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_DYNAMIC), true)) {
            return parent::num_rows();
        }

        return is_int($this->num_rows)
            ? $this->num_rows
            : $this->num_rows = sqlsrv_num_rows($this->result_id);
    }

    // --------------------------------------------------------------------

    /**
     * Number of fields in the result set
     *
     * @return  int
     */
    public function num_fields()
    {
        return @sqlsrv_num_fields($this->result_id);
    }

    // --------------------------------------------------------------------

    /**
     * Fetch Field Names
     *
     * Generates an array of column names
     *
     * @return  array
     */
    public function list_fields()
    {
        $field_names = array();
        foreach (sqlsrv_field_metadata($this->result_id) as $offset => $field) {
            $field_names[] = $field['Name'];
        }

        return $field_names;
    }

    // --------------------------------------------------------------------

    /**
     * Field data
     *
     * Generates an array of objects containing field meta-data
     *
     * @return  array
     */
    public function field_data()
    {
        $retval = array();
        foreach (sqlsrv_field_metadata($this->result_id) as $i => $field) {
            $retval[$i]     = new stdClass();
            $retval[$i]->name   = $field['Name'];
            $retval[$i]->type   = $field['Type'];
            $retval[$i]->max_length = $field['Size'];
        }

        return $retval;
    }

    // --------------------------------------------------------------------

    /**
     * Free the result
     *
     * @return  void
     */
    public function free_result()
    {
        if (is_resource($this->result_id)) {
            sqlsrv_free_stmt($this->result_id);
            $this->result_id = false;
        }
    }

    // --------------------------------------------------------------------

    /**
     * Result - associative array
     *
     * Returns the result set as an array
     *
     * @return  array
     */
    protected function _fetch_assoc()
    {
        return sqlsrv_fetch_array($this->result_id, SQLSRV_FETCH_ASSOC);
    }

    // --------------------------------------------------------------------

    /**
     * Result - object
     *
     * Returns the result set as an object
     *
     * @param   string  $class_name
     * @return  object
     */
    protected function _fetch_object($class_name = 'stdClass')
    {
        return sqlsrv_fetch_object($this->result_id, $class_name);
    }
}