web-site/Internal/package-services/Restful.php

<?php namespace ZN\Services;
/**
 * ZN PHP Web Framework
 * 
 * "Simplicity is the ultimate sophistication." ~ Da Vinci
 * 
 * @package ZN
 * @license MIT [http://opensource.org/licenses/MIT]
 * @author  Ozan UYKUN [ozan@znframework.com]
 */

use ZN\XML;
use ZN\Singleton;
use ZN\Request\Http;
use ZN\Protection\Json;
use ZN\Response\Redirect;

class Restful implements RestfulInterface
{
    /**
     * URL
     * 
     * @vasr string
     */
    protected $url;

    /**
     * Data
     * 
     * @var array
     */
    protected $data;

    /**
     * Info
     * 
     * @var array
     */
    protected $info;

    /**
     * SSL Verify Peer
     * 
     * @var bool
     */
    protected $sslVerifyPeer = false;

    /**
     * Keeps curl class
     */
    protected $curl;

    /**
     * Magic Call
     * 
     * @param string $method
     * @param array  $parameters
     * 
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        # Return CURL info.
        if( $return = $this->info($method) )
        {
            return $return;
        }
        
        # Set CURL option.
        $this->curl->{$method}(...$parameters);

        return $this;
    }

    /**
     * Magic Constructor
     */
    public function __construct()
    {
        $this->curl = Singleton::class('ZN\Services\CURL');
    }

    /**
     * Get request headers
     * 
     * @return array
     * 
     * @codeCoverageIgnore
     */
    public function getRequestHeaders() : array
    {
        return apache_request_headers();
    }

    /**
     * Get raw data
     * 
     * @param string $type
     * 
     * @return string|array|object
     */
    public function getRawData(string $type = 'string')
    {
        $rawData = file_get_contents('php://input');

        switch( $type )
        {
            case 'string' : return $rawData; break;
            case 'object' : return Json::decodeObject($rawData);
            case 'array'  : return Json::decodeArray($rawData);
        }

        return false;
    }

    /**
     * Get raw data object
     * 
     * @return object
     */
    public function getRawDataObject()
    {
        return $this->getRawData('object');
    }

    /**
     * Get raw data array
     * 
     * @return array
     */
    public function getRawDataArray()
    {
        return $this->getRawData('array');
    }

    /**
     * Content Type
     * 
     * @param string $type    = 'json'
     * @param string $charset = 'utf-8'
     * 
     * @return Restful
     */
    public function contentType(string $type = 'json', string $charset = 'utf-8') : Restful
    {
        header('Content-Type: application/' . $type . '; charset=' . $charset);

        return $this;
    }

    /**
     * HTTP Status
     * 
     * @param int ¢ode = NULL
     * 
     * @return Restful
     */
    public function httpStatus(?int $code = NULL) : Restful
    {
        $code = $code ?? Redirect::status();

        header('HTTP/1.1 ' . $code . ' ' . Http::code($code));

        return $this;
    }

    /**
     * Info
     * 
     * @param string $key = NULL
     * 
     * @return mixed
     */
    public function info(?string $key = NULL)
    {
        return $key === NULL ? $this->info : ($this->info[strtolower($key ?? '')] ?? false);
    }

    /**
     * URL
     * 
     * @param string 
     * 
     * @return Restful
     */
    public function url(string $url) : Restful
    {
        $this->url = $url;

        return $this;
    }

    /**
     * Data
     * 
     * @param mixed $data
     * 
     * @return Restful
     */
    public function data($data) : Restful
    {
        $this->data = $data;

        return $this;
    }

    /**
     * SSL Verify Peer
     * 
     * @param bool $type = false
     * 
     * @return Restful
     */
    public function sslVerifyPeer(bool $type = false) : Restful
    {
        $this->sslVerifyPeer = $type;

        return $this;
    }

    /**
     * Get
     * 
     * @param string $url = NULL
     * 
     * @return object
     */
    public function get(?string $url = NULL)
    {
        $response = $this->curl
                         ->init($this->url ?? $url)
                         ->option('returntransfer', true)
                         ->option('ssl_verifypeer', $this->sslVerifyPeer)
                         ->exec();

        return $this->_result($response);
    }

    /**
     * Post 
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function post(?string $url = NULL, $data = NULL)
    {
        $response = $this->curl
                         ->init($this->url ?? $url)
                         ->option('returntransfer', true)
                         ->option('post', true)
                         ->option('ssl_verifypeer', $this->sslVerifyPeer)
                         ->option('postfields', $this->buildQuery($data))
                         ->exec();

        return $this->_result($response);
    }

    /**
     * Post Json
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function postJson(?string $url = NULL, $data = NULL)
    {
        return $this->post($url, json_encode($this->data ?? $data));
    }

    /**
     * Put 
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function put(?string $url = NULL, $data = NULL)
    {
        return $this->_customRequest($url, $this->buildQuery($data), __FUNCTION__);
    }

    /**
     * Put Json
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function putJson(?string $url = NULL, $data = NULL)
    {
        return $this->_customRequest($url, json_encode($this->data ?? $data), 'put');
    }


    /**
     * Patch 
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function patch(?string $url = NULL, $data = NULL)
    {
        return $this->_customRequest($url, $this->buildQuery($data), __FUNCTION__);
    }

    /**
     * Patch Json
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function patchJson(?string $url = NULL, $data = NULL)
    {
        return $this->_customRequest($url, json_encode($this->data ?? $data), 'patch');
    }

    /**
     * Delete 
     * 
     * @param string $url  = NULL
     * @param mixed  $data = NULL
     * 
     * @return object
     */
    public function delete(?string $url = NULL, $data = NULL)
    {
        return $this->_customRequest($url, $this->data ?? $data, __FUNCTION__);
    }

    /**
     * Return
     * 
     * @param callable $callback
     * 
     * @return callable
     */
    public function return(callable $callback)
    {
        return $callback();
    }

    /**
     * Protected build query
     */
    protected function buildQuery($data)
    {
        $data = $this->data ?? $data;

        return is_string($data) ? $data : http_build_query($data, '', '&', PHP_QUERY_RFC1738);
    }

    /**
     * Protected Custom Request
     */
    protected function _customRequest($url, $data, $type)
    {
        $response = $this->curl->init($this->url ?? $url)
                        ->option('returntransfer', true)
                        ->option('customrequest', strtoupper($type))
                        ->option('ssl_verifypeer', $this->sslVerifyPeer)
                        ->option('postfields', $data)
                        ->exec();

        return $this->_result($response);
    }

    /**
     * Protected Info
     */
    protected function _info()
    {
        $this->info['gethttpcode']          = $this->curl->info('http_code');
        $this->info['getfiletime']          = $this->curl->info('filetime');
        $this->info['gettotaltime']         = $this->curl->info('total_time');
        $this->info['getpretransfertime']   = $this->curl->info('pretransfer_time');
        $this->info['getstarttransfertime'] = $this->curl->info('starttransfer_time');
        $this->info['getredirecttime']      = $this->curl->info('redirect_time');
        $this->info['getuploadsize']        = $this->curl->info('size_upload');
        $this->info['getdownloadsize']      = $this->curl->info('size_download');
        $this->info['getrequestsize']       = $this->curl->info('request_size');
        $this->info['getdownloadspeed']     = $this->curl->info('speed_download');
        $this->info['getuploadspeed']       = $this->curl->info('speed_upload');
        $this->info['all']                  = $this->curl->info(NULL);
    }

    /**
     * Protected Result
     */
    protected function _result($response)
    {
        $this->_info();

        $this->curl->close();

        $this->_default();

        if( Json::check($response) )
        {
            return json_decode($response);
        }
        elseif( XML\Check::check($response) )
        {
            return XML\Parser::simple($response);
        }
        else
        {
            return $response;
        }
    }

    /**
     * Protected Default
     */
    protected function _default()
    {
        $this->url           = NULL;
        $this->data          = NULL;
        $this->sslVerifyPeer = false;
    }
}