php-sqlsrv/test/sqlsrv/sqlsrv_bind_param_out_string.phpt

--TEST--
Verify the Binary and Char encoding output when binding output string with SQLSTYPE option with different size
--SKIPIF--
<?php require('skipif.inc'); ?>
--FILE--

<?php
require( 'MsCommon.inc' );
$conn = Connect();
if( $conn === false )
{
    FatalError("Could not connect");
}

$stmt = sqlsrv_query( $conn, "IF OBJECT_ID('BindStringTest', 'U') IS NOT NULL DROP TABLE BindStringTest" );
$stmt = sqlsrv_query( $conn, "IF OBJECT_ID('uspPerson', 'P') IS NOT NULL DROP PROCEDURE uspPerson");
if( $stmt === false )
{
     echo "Error in executing statement 1.\n";
     die( print_r( sqlsrv_errors(), true));
}

$stmt = sqlsrv_query( $conn, "CREATE TABLE BindStringTest (PersonID int, Name nvarchar(50))" );
if( $stmt === false ) {
    die( print_r( sqlsrv_errors(), true ));
}

$stmt = sqlsrv_query( $conn, "INSERT INTO BindStringTest (PersonID, Name) VALUES (10, N'Miller')" );
if( $stmt === false ) {
    die( print_r( sqlsrv_errors(), true ));
}

$stmt = sqlsrv_query( $conn, "INSERT INTO BindStringTest (PersonID, Name) VALUES (11, N'JSmith')" );
if( $stmt === false ) {
    die( print_r( sqlsrv_errors(), true ));
}           

$tsql_createSP = "CREATE PROCEDURE uspPerson
    @id int, @return nvarchar(50) OUTPUT
    AS
    BEGIN
    SET NOCOUNT ON;
    SET @return = (SELECT Name FROM BindStringTest WHERE PersonID = @id)
    END";
    
$stmt = sqlsrv_query( $conn, $tsql_createSP);
if( $stmt === false )
{
     echo "Error in executing statement 2.\n";
     die( print_r( sqlsrv_errors(), true));
}

$tsql_callSP = "{call uspPerson( ? , ?)}";


//***********************************************************************************************

echo "NVARCHAR(32)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NVARCHAR(32)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         print_r( sqlsrv_errors(), true);
}

$expectedLength = 6;
$expectedValue = "Miller";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NVARCHAR(32)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         print_r( sqlsrv_errors(), true);
     }
 
$expectedLength = 12;
$expectedValue = "M\0i\0l\0l\0e\0r\0";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

//***********************************************************************************************
echo "\n\n";
echo "NVARCHAR(50)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NVARCHAR(50)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         print_r( sqlsrv_errors(), true);
}

$expectedLength = 6;
$expectedValue = "Miller";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );


echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NVARCHAR(50)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         print_r( sqlsrv_errors(), true);
     }
     
$expectedLength = 12;
$expectedValue = "M\0i\0l\0l\0e\0r\0";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

//***********************************************************************************************
echo "\n\n";
echo "NVARCHAR(1)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";


$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NVARCHAR(1)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         echo "Statement should fail\n";
}

$expectedLength = 1;
$expectedValue = "M";
$actualValue = $return;
$actualLength = strlen($return);
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NVARCHAR(1)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         echo "Statement should fail\n";
     }
 
$expectedLength = 2;
$expectedValue = "M\0";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

//***********************************************************************************************
echo "\n\n";
echo "NCHAR(32)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NCHAR(32)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         print_r( sqlsrv_errors(), true);
}

$expectedLength = 32;
$expectedValue = "Miller                          ";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NCHAR(32)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         print_r( sqlsrv_errors(), true);
     }
     
$expectedLength = 64;
$expectedValue = "M\0i\0l\0l\0e\0r\0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue ); 

//***********************************************************************************************
echo "\n\n";
echo "NCHAR(0)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NCHAR(0)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         echo "Statement should fail\n";
}

$expectedLength = 0;
$expectedValue = "";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue ); 

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NCHAR(0)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         echo "Statement should fail\n";
     }
 
$expectedLength = 0;
$expectedValue = "";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue ); 

//***********************************************************************************************
echo "\n\n";
echo "NCHAR(50)\n"; 
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NCHAR(50)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         print_r( sqlsrv_errors(), true);
}

$expectedLength = 50;
$expectedValue = "Miller                                            ";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue ); 

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NCHAR(50)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         print_r( sqlsrv_errors(), true);
     }
 
$expectedLength = 100;
$expectedValue = "M\0i\0l\0l\0e\0r\0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0 \0";
$actualLength = strlen($return);
$actualValue = $return;
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue ); 

//***********************************************************************************************
// NCHAR 1: less than length of the returned value 
echo "\n\n";
echo "NCHAR(1)\n";
echo "---------Encoding char-----------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_CHAR), 
                   SQLSRV_SQLTYPE_NCHAR(1)
            ));

if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) === false)
{
         print_r( sqlsrv_errors(), true);
}

$expectedLength = 1;
$expectedValue = "M";
$actualValue = $return;
$actualLength = strlen($return);
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

echo "---------Encoding binary---------\n";
$id = 10;
$return = "";
$params = array( 
    array($id, SQLSRV_PARAM_IN),
    array(&$return, SQLSRV_PARAM_OUT,
                    SQLSRV_PHPTYPE_STRING(SQLSRV_ENC_BINARY),   
                   SQLSRV_SQLTYPE_NCHAR(1)
            ));
if( $stmt = sqlsrv_query($conn, $tsql_callSP, $params) == false)
     {
         print_r( sqlsrv_errors(), true);
     }
 
$expectedLength = 2;
$expectedValue = "M\0";
$actualValue = $return;
$actualLength = strlen($return);
compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue );

sqlsrv_query( $conn, "DROP TABLE BindStringTest" );
sqlsrv_query( $conn, "DROP PROCEDURE uspPerson");

sqlsrv_close($conn);

$status = true;

/**
*  Compares actual output to expected one
*  @param $expectedLength The length of the expected value
*  @param $expectedValue The expected value
*  @param $actualLength The length of the actual value
*  @param $actualValue The actual value
*/
function compareResults ( $expectedLength, $expectedValue, $actualLength, $actualValue )
{
    $match = false;
    if ( $expectedLength == $actualLength) 
    {
        if ( strncmp ( $actualValue, $expectedValue, $expectedLength ) == 0 )
        {
            $match = true;
        }
    } 
    if ( !$match )
    {
        echo "The actual result is different from the expected one \n";
    }
    else
    {
        echo "The actual result is the same as the expected one \n";
    }
}
?>
--EXPECT--
NVARCHAR(32)
---------Encoding char-----------
The actual result is the same as the expected one 
---------Encoding binary---------
The actual result is the same as the expected one 


NVARCHAR(50)
---------Encoding char-----------
The actual result is the same as the expected one 
---------Encoding binary---------
The actual result is the same as the expected one 


NVARCHAR(1)
---------Encoding char-----------
Statement should fail
The actual result is the same as the expected one 
---------Encoding binary---------
Statement should fail
The actual result is the same as the expected one 


NCHAR(32)
---------Encoding char-----------
The actual result is the same as the expected one 
---------Encoding binary---------
The actual result is the same as the expected one 


NCHAR(0)
---------Encoding char-----------
Statement should fail
The actual result is the same as the expected one 
---------Encoding binary---------
Statement should fail
The actual result is the same as the expected one 


NCHAR(50)
---------Encoding char-----------
The actual result is the same as the expected one 
---------Encoding binary---------
The actual result is the same as the expected one 


NCHAR(1)
---------Encoding char-----------
The actual result is the same as the expected one 
---------Encoding binary---------
The actual result is the same as the expected one