oxcurl.php

Go to the documentation of this file.

<?php

class oxCurl
{
    protected $_rCurl = null;

    protected $_sUrl = null;

    protected $_sQuery = null;

    protected $_sMethod = 'POST';

    protected $_aParameters = null;

    protected $_sConnectionCharset = "UTF-8";

    protected $_aHeader = null;

    protected $_sHost = null;

    protected $_aOptions = array('CURLOPT_RETURNTRANSFER' => 1);

    protected $_sStatusCode = null;

    public function setUrl( $sUrl )
    {
        $this->_sUrl = $sUrl;
    }

    public function getUrl()
    {
        if ($this->getMethod() == "GET" && $this->getQuery()) {
            $this->_sUrl = $this->_sUrl . "?" . $this->getQuery();
        }
        return $this->_sUrl;
    }

    public function setQuery( $sQuery  )
    {
        $this->_sQuery = $sQuery;
    }

    public function getQuery()
    {
        if ( is_null( $this->_sQuery ) ) {
            $sQuery = "";
            if ( $aParams = $this->getParameters() ) {
                $aParams = $this->_prepareQueryParameters( $aParams );
                $sQuery = http_build_query( $aParams, "", "&" );
            }
            $this->setQuery($sQuery);
        }

        return $this->_sQuery;
    }

    public function setParameters( $aParameters )
    {
        $this->setQuery( null );
        $this->_aParameters = $aParameters;
    }

    public function getParameters()
    {
        return $this->_aParameters;
    }

    public function setHost( $sHost )
    {
        $this->_sHost = $sHost;
    }

    public function getHost()
    {
        return $this->_sHost;
    }

    public function setHeader( $aHeader = null )
    {
        if ( is_null( $aHeader ) && $this->getMethod() == "POST") {
            $sHost = $this->getHost();

            $aHeader = array();
            $aHeader[] = 'POST /cgi-bin/webscr HTTP/1.1';
            $aHeader[] = 'Content-Type: application/x-www-form-urlencoded';
            if ( isset( $sHost ) ) {
                $aHeader[] = 'Host: '. $sHost;
            }
            $aHeader[] = 'Connection: close';
        }
        $this->_aHeader = $aHeader;
    }

    public function getHeader()
    {
        if ( is_null( $this->_aHeader ) ) {
            $this->setHeader();
        }
        return $this->_aHeader;
    }

    public function setMethod($sMethod)
    {
        $this->_sMethod = strtoupper($sMethod);
    }

    public function getMethod()
    {
        return $this->_sMethod;
    }

    public function setOption( $sName, $sValue )
    {
        if (strpos( $sName, 'CURLOPT_' ) !== 0 || !defined($sConstant = strtoupper($sName))) {
            $oException = oxNew( 'oxException' );
            $oLang = oxRegistry::getLang();
            $oException->setMessage( sprintf( $oLang->translateString( 'EXCEPTION_NOT_VALID_CURL_CONSTANT', $oLang->getTplLanguage() ), $sName ) );
            throw $oException;
        }

        $this->_aOptions[$sName] = $sValue;
    }

    public function getOptions()
    {
        return $this->_aOptions;
    }

    public function execute()
    {
        $this->_setOptions();

        $sResponse = $this->_execute();
        $this->_saveStatusCode();

        $iCurlErrorNumber = $this->_getErrorNumber();

        $this->_close();

        if ( $iCurlErrorNumber ) {
            $oException = oxNew( 'oxException' );
            $oLang = oxRegistry::getLang();
            $oException->setMessage( sprintf( $oLang->translateString( 'EXCEPTION_CURL_ERROR', $oLang->getTplLanguage() ), $iCurlErrorNumber ) );
            throw $oException;
        }

        return $sResponse;
    }

    public function setConnectionCharset( $sCharset )
    {
        $this->_sConnectionCharset = $sCharset;
    }

    public function getConnectionCharset()
    {
        return $this->_sConnectionCharset;
    }

    public function getStatusCode()
    {
        return $this->_sStatusCode;
    }

    protected function _setResource( $rCurl )
    {
        $this->_rCurl = $rCurl;
    }

    protected function _getResource()
    {
        if ( is_null( $this->_rCurl ) ) {
            $this->_setResource( curl_init() );
        }
        return $this->_rCurl;
    }

    protected function _setOptions()
    {
        if (!is_null($this->getHeader())) {
            $this->_setOpt( CURLOPT_HTTPHEADER, $this->getHeader() );
        }
        $this->_setOpt( CURLOPT_URL, $this->getUrl() );

        if ( $this->getMethod() == "POST" ) {
            $this->_setOpt( CURLOPT_POST, 1 );
            $this->_setOpt( CURLOPT_POSTFIELDS, $this->getQuery() );
        }

        $aOptions = $this->getOptions();
        if ( count($aOptions) ) {
            foreach( $aOptions as $sName => $mValue  ) {
                $this->_setOpt( constant( $sName ), $mValue );
            }
        }
    }

    protected function _execute()
    {
        return curl_exec( $this->_getResource() );
    }

    protected function _close()
    {
        curl_close( $this->_getResource() );
        $this->_setResource( null );
    }

    protected function _setOpt( $sName, $sValue )
    {
        curl_setopt( $this->_getResource(), $sName, $sValue );
    }

    protected function _getErrorNumber()
    {
        return curl_errno( $this->_getResource() );
    }

    protected function _saveStatusCode()
    {
        $this->_sStatusCode = curl_getinfo($this->_getResource(), CURLINFO_HTTP_CODE);
    }

    protected function _prepareQueryParameters( $aParams )
    {
        $aParams = array_filter( $aParams );
        $aParams = array_map( array( $this, '_htmlDecode' ), $aParams );

        return $aParams;
    }

    protected function _htmlDecode( $mParam )
    {
        if ( is_array( $mParam ) ) {
            $mParam = $this->_prepareQueryParameters( $mParam );
        } else {
            $mParam = html_entity_decode( stripslashes( $mParam ), ENT_QUOTES, $this->getConnectionCharset() );
        }

        return $mParam;
    }

}