/OData Producer for PHP/library/ODataProducer/Providers/Metadata/Type/String.php

<?php

/** 

 * Type to represent String

 * 

 * PHP version 5.3

 * 

 * @category  ODataProducer

 * @package   ODataProducer_Providers_Metadata_Type

 * @author    Anu T Chandy <odataphpproducer_alias@microsoft.com>

 * @copyright 2011 Microsoft Corp. (http://www.microsoft.com)

 * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)

 * @version   SVN: 1.0

 * @link      http://odataphpproducer.codeplex.com

 * 

 */

namespace ODataProducer\Providers\Metadata\Type;

/**

 * Type to represent String

 * 

 * @category  ODataProducer

 * @package   ODataProducer_Providers_Metadata_Type

 * @author    Anu T Chandy <odataphpproducer_alias@microsoft.com>

 * @copyright 2011 Microsoft Corp. (http://www.microsoft.com)

 * @license   New BSD license, (http://www.opensource.org/licenses/bsd-license.php)

 * @version   Release: 1.0

 * @link      http://odataphpproducer.codeplex.com

 */

class String implements IType

{

    /**

     * Gets the type code

     * Note: implementation of IType::getTypeCode

     *   

     * @return TypeCode

     */

    public function getTypeCode()

    {

        return TypeCode::STRING;

    }



    /**

     * Checks this type (String) is compactible with another type

     * Note: implementation of IType::isCompatibleWith

     * 

     * @param IType $type Type to check compactibility

     * 

     * @return boolean 

     */

    public function isCompatibleWith(IType $type)

    {

        return ($type->getTypeCode() == TypeCode::STRING);

    }



    /**

     * Validate a value in Astoria uri is in a format for this type

     * Note: implementation of IType::validate

     * 

     * @param string $value     The value to validate 

     * @param string &$outValue The stripped form of $value that can 

     *                          be used in PHP expressions

     * 

     * @return boolean

     */

    public function validate($value, &$outValue)

    {

        if (!is_string($value)) {

            return false;

        }

        

        $outValue = $value;

        return true;

    }



    /**

     * Gets full name of this type in EDM namespace

     * Note: implementation of IType::getFullTypeName

     * 

     * @return string

     */

    public function getFullTypeName()

    {

        return 'Edm.String';

    }



    /**

     * Converts the given string value to string type.

     * 

     * @param string $stringValue value to convert.

     * 

     * @return string

     */

    public function convert($stringValue)

    {

        //Consider the odata url option 

        //$filter=ShipName eq 'Antonio%20Moreno%20Taquer%C3%ADa'

        //WebOperationContext will do urldecode, so the clause become

        //$filter=ShipName eq 'Antonio Moreno Taquería', the lexer will

        //give the token as

        //Token {Text string(25):'Antonio Moreno Taquería', Id: String}, 

        //this function is used to remove the pre-post quotes from Token::Text 

        //i.e. 'Antonio Moreno Taquería'

        //to Antonio Moreno Taquería

        $len = strlen($stringValue);

        if ($len < 2) {

            return $stringValue;

        }



        return substr($stringValue, 1, $len - 2);

    }



    /**

     * Convert the given value to a form that can be used in OData uri. 

     * Note: The calling function should not pass null value, as this 

     * function will not perform any check for nullability 

     * 

     * @param mixed $value value to convert.

     * 

     * @return string

     */

    public function convertToOData($value)

    {

        return '\'' . str_replace('%27', "''", urlencode(utf8_encode($value))) . '\'';

    }

}