lightBLOG/Internal/Libraries/ViewObjects/Jquery/Helpers/Ajax.php

<?php
namespace ZN\ViewObjects\Jquery\Helpers;

use ZN\ViewObjects\JqueryTrait;

class Ajax
{
	//----------------------------------------------------------------------------------------------------
	//
	// Yazar      : Ozan UYKUN <ozanbote@windowslive.com> | <ozanbote@gmail.com>
	// Site       : www.zntr.net
	// Lisans     : The MIT License
	// Telif Hakkı: Copyright (c) 2012-2016, zntr.net
	//
	//----------------------------------------------------------------------------------------------------
	
	use JqueryTrait;
	
	//----------------------------------------------------------------------------------------------------
	// Call Method
	//----------------------------------------------------------------------------------------------------
	// 
	// __call()
	//
	//----------------------------------------------------------------------------------------------------
	use \CallUndefinedMethodTrait;
	
	/* 
	 * Fonksiyon blokları 
	 *
	 * success, error, complete...
	 *
	 * @var array
	 */
	protected $functions = [];
	
	/* 
	 * Ayar blokları
	 *
	 * url, method, data...
	 *
	 * @var array
	 */
	protected $sets = [];
	
	/* Dönüş fonksiyon blokları
	 *
	 * .done, .always, .then .fail
	 *
	 * @var array 
	 */
	protected $callbacks = [];

	/******************************************************************************************
	* URL                                                                                     *
	*******************************************************************************************
	| Genel Kullanım: Url parametresini ayarlamak için kullanılır.				    		  |
	
	  @param string $url
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function url($url = '')
	{
		if( ! is_string($url) )
		{
			\Errors::set('Error', 'stringParameter', '1.(url)');
			return $this;	
		}
		
		// Veri bir url içermiyorsa siteUrl yöntemi ile url'ye dönüştürülür.
		if( ! isUrl($url) )
		{
			$url = siteUrl($url);	
		}
		
		$this->sets['url'] = "\turl:\"$url\",".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* DATA                                                                                    *
	*******************************************************************************************
	| Genel Kullanım: Gönderilen Veri parametresini ayarlamak için kullanılır.				  |
	
	  @param string $data
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function data($data = '')
	{
		if( ! is_scalar($data) )
		{
			\Errors::set('Error', 'valueParameter', '1.(data)');
			return $this;	
		}
		
		$this->sets['data'] = "\tdata:$data,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* HEADERS                                                                                 *
	*******************************************************************************************
	| Genel Kullanım: Başlıklar parametresini ayarlamak için kullanılır.		    		  |
	
	  @param string $headers
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function headers($headers = '')
	{
		if( ! is_scalar($headers) )
		{
			\Errors::set('Error', 'valueParameter', '1.(headers)');
			return $this;	
		}
		
		$this->sets['headers'] = "\theaders:$headers,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* IF MODIFIED                                                                             *
	*******************************************************************************************
	| Genel Kullanım: If Modified parametresini ayarlamak için kullanılır.		    		  |
	
	  @param bool $ifModified true
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function ifModified($ifModified = true)
	{
		if( ! is_scalar($ifModified) )
		{
			\Errors::set('Error', 'valueParameter', '1.(isModified)');
			return $this;	
		}
		
		// Mantıklasal veri metinsel veriye dönüştürülüyor.
		$ifModified = $this->_boolToStr($ifModified);
		
		$this->sets['ifModified'] = "\tifModified:$ifModified,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* IS LOCAL                                                                                *
	*******************************************************************************************
	| Genel Kullanım: Is Local parametresini ayarlamak için kullanılır.	    	    		  |
	
	  @param bool $isLocal true
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function isLocal($isLocal = true)
	{
		if( ! is_scalar($isLocal) )
		{
			\Errors::set('Error', 'valueParameter', '1.(isLocal)');
			return $this;	
		}
		
		$isLocal = $this->_boolToStr($isLocal);
		
		$this->sets['isLocal'] = "\tisLocal:$isLocal,".EOL;
		
		return $this;	
	}
	
	
	/******************************************************************************************
	* MIME TYPE                                                                               *
	*******************************************************************************************
	| Genel Kullanım: MIME Type parametresini ayarlamak için kullanılır.	  	    		  |
	
	  @param bool $mimeType true
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function mimeType($mimeType = true)
	{
		if( ! is_scalar($mimeType) )
		{
			\Errors::set('Error', 'valueParameter', 'mimeType');
			return $this;	
		}
		
		$mimeType = $this->_boolToStr($mimeType);
		$this->sets['mimeType'] = "\tmimeType:$mimeType,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* JSONP                                                                                   *
	*******************************************************************************************
	| Genel Kullanım: Jsonp parametresini ayarlamak için kullanılır.     	  	    		  |
	
	  @param string/bool $jsonp
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function jsonp($jsonp = '')
	{
		if( is_bool($jsonp) )
		{
			$jsonp = $this->_boolToStr($jsonp);	
		}
		elseif( is_string($jsonp) )
		{
			$jsonp = "\"$jsonp\"";
		}
		else
		{
			return $this;
		}
		
		$this->sets['jsonp'] = "\tjsonp:$jsonp,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* JSONP CALLBACK                                                                          *
	*******************************************************************************************
	| Genel Kullanım: Jsonp Callback parametresini ayarlamak için kullanılır.   	   		  |
	
	  @param string $jsonpCallback
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function jsonpCallback($jsonpCallback = '')
	{
		if( ! is_scalar($jsonpCallback) )
		{
			\Errors::set('Error', 'valueParameter', 'jsonpCallback');
			return $this;	
		}
		
		if( $this->_isFunc($jsonpCallback) === false )
		{
			$jsonpCallback = "\"$jsonpCallback\"";
		}
		
		$this->sets['jsonpCallback'] = "\tjsonpCallback:$jsonpCallback,".EOL;
		
		return $this;	
	}
	
	/******************************************************************************************
	* DATA TYPE                                                                               *
	*******************************************************************************************
	| Genel Kullanım: Data Type parametresini ayarlamak için kullanılır.  		 	   		  |
	
	  @param string $type
	  
	  @return $this
	|          																				  |
	******************************************************************************************/
	public function dataType($type = '')
	{
		if( ! is_string($type) )
		{
			\Errors::set('Error', 'stringParameter', 'type');
			return $this;	
		}
		
		$this->sets['type'] = "\tdataType:\"$type\",".EOL;
		
		return $this;
	}
	
	// PASSWORD Property -------------------------------------------------------
	// password data
	// password:string
	public function password($password = '')
	{
		if( ! is_string($password) )
		{
			\Errors::set('Error', 'stringParameter', 'password');
			return $this;	
		}
		
		$this->sets['password'] = "\tpassword:\"$password\",".EOL;
		
		return $this;
	}
	
	// USERNAME Property -------------------------------------------------------
	// username data
	// username:string
	public function username($username = '')
	{
		if( ! is_string($username) )
		{
			\Errors::set('Error', 'stringParameter', 'username');
			return $this;	
		}
		
		$this->sets['username'] = "\tusername:\"$username\",".EOL;
		
		return $this;
	}
	
	// METHOD/TYPE Property ----------------------------------------------------
	// type() = method() 
	// type data
	// type:string : post, get ...
	public function method($method = 'post')
	{
		if( ! is_string($method) )
		{
			\Errors::set('Error', 'stringParameter', 'method');
			return $this;	
		}
		
		$this->sets['method'] = "\tmethod:\"$method\",".EOL;
		
		return $this;
	}
	
	// METHOD/TYPE Property ----------------------------------------------------
	// type() = method() 
	// type data
	// type:string : post, get ...
	public function type($method = 'post')
	{
		$this->method($method);
		
		return $this;
	}
	
	// SCRIPT CHARSET Property -------------------------------------------------------
	// scriptCharset data
	// scriptCharset:string
	public function scriptCharset($scriptCharset = 'utf-8')
	{
		if( ! isCharset($scriptCharset) )
		{
			\Errors::set('Error', 'charsetParameter', 'scriptCharset');
			return $this;	
		}
		
		$this->sets['scriptCharset'] = "\tscriptCharset:\"$scriptCharset\",".EOL;
		
		return $this;
	}
	
	// TRADITIONAL Property -------------------------------------------------------
	// traditional data
	// traditional:bool: true or false
	public function traditional($traditional = true)
	{
		if( ! is_scalar($traditional) )
		{
			\Errors::set('Error', 'valueParameter', 'traditional');
			return $this;	
		}
		
		$traditional = $this->_boolToStr($traditional);
		$this->sets['traditional'] = "\ttraditional:$traditional,".EOL;
		
		return $this;
	}
	
	// PROCESS DATA Property -------------------------------------------------------
	// processData data
	// processData:bool: true or false
	public function processData($processData = true)
	{
		if( ! is_scalar($processData) )
		{
			\Errors::set('Error', 'valueParameter', 'processData');
			return $this;	
		}
		
		$processData = $this->_boolToStr($processData);
		$this->sets['processData'] = "\tprocessData:$processData,".EOL;
		
		return $this;
	}
	
	// CACHE Property -------------------------------------------------------
	// cache data
	// cache:bool: true or false
	public function cache($cache = true)
	{
		if( ! is_scalar($cache) )
		{
			\Errors::set('Error', 'valueParameter', 'cache');
			return $this;	
		}
		
		$cache = $this->_boolToStr($cache);
		$this->sets['cache'] = "\tcache:$cache,".EOL;
		
		return $this;
	}
	
	// XHR FIELDS Property -------------------------------------------------------
	// xhrFields data
	// xhrFields:string
	public function xhrFields($xhrFields = '')
	{
		if( ! is_string($xhrFields) )
		{
			\Errors::set('Error', 'stringParameter', 'xhrFields');
			return $this;	
		}
		
		$this->sets['xhrFields'] = "\txhrFields:$xhrFields,".EOL;
		
		return $this;
	}
	
	// CONTEXT Property -------------------------------------------------------
	// context data
	// context:plain object
	public function context($context = '')
	{
		if( ! is_scalar($context) )
		{
			\Errors::set('Error', 'valueParameter', 'context');
			return $this;	
		}
		
		$this->sets['context'] = "\tcontext:$context,".EOL;
		
		return $this;
	}
	
	// ACCEPTS Property -------------------------------------------------------
	// accepts data
	// accepts:plain object
	public function accepts($accepts = '')
	{
		if( ! is_string($accepts) )
		{
			\Errors::set('Error', 'stringParameter', 'accepts');
			return $this;	
		}
		
		$this->sets['accepts'] = "\taccepts:$accepts,".EOL;
		
		return $this;
	}
	
	// CONTENTS Property -------------------------------------------------------
	// contents data
	// contents:plain object
	public function contents($contents = '')
	{
		if( ! is_string($contents) )
		{
			\Errors::set('Error', 'stringParameter', 'contents');
			return $this;	
		}
		
		$this->sets['contents'] = "\tcontents:$contents,".EOL;
		
		return $this;
	}
	
	// ASYNC Property -------------------------------------------------------
	// async data
	// async:bool: true or false
	public function async($async = true)
	{
		if( ! is_scalar($async) )
		{
			\Errors::set('Error', 'valueParameter', 'async');
			return $this;	
		}
		
		$async = $this->_boolToStr($async);
		$this->sets['async'] = "\tasync:$async,".EOL;
		
		return $this;
	}
	
	// CROSS DOMAIN Property -------------------------------------------------------
	// crossDomain data
	// crossDomain:bool: true or false
	public function crossDomain($crossDomain = true)
	{
		if( ! is_scalar($crossDomain) )
		{
			\Errors::set('Error', 'valueParameter', 'crossDomain');
			return $this;	
		}
		
		$crossDomain = $this->_boolToStr($crossDomain);
		$this->sets['crossDomain'] = "\tcrossDomain:$crossDomain,".EOL;
		
		return $this;
	}
	
	// TIMEOUT Property -------------------------------------------------------
	// timeout data
	// timeout:numeric
	public function timeout($timeout = '')
	{
		if( ! is_scalar($timeout) )
		{
			\Errors::set('Error', 'valueParameter', 'timeout');
			return $this;	
		}
		
		$this->sets['timeout'] = "\ttimeout:$timeout,".EOL;
		
		return $this;
	}
	
	// GLOBAL Property -------------------------------------------------------
	// global data
	// global:bool : true or false
	// global is keywords so global is name globals
	public function globals($globals = true)
	{
		if( ! is_scalar($globals) )
		{
			\Errors::set('Error', 'valueParameter', 'globals');
			return $this;	
		}
		
		$globals = $this->_boolToStr($globals);
		$this->sets['globals'] = "\tglobal:$globals,".EOL;
		
		return $this;
	}
	
	// CONTENT TYPE Property -------------------------------------------------------
	// contentType data
	// contentType:bool or string
	// is bool  : true or false
	// is_string: 'application/x-www-form-urlencoded; charset=UTF-8'
	public function contentType($contentType = 'application/x-www-form-urlencoded; charset=UTF-8')
	{
		if( is_bool($contentType) )
		{
			$contentType = $this->_boolToStr($contentType);		
		}
		elseif( is_string($contentType) )
		{
			$contentType = "\"$contentType\"";
		}
		else
		{
			\Errors::set('Error', 'valueParameter', 'contentType');
			return $this;	
		}
		
		$this->sets['contentType'] = "\tcontentType:$contentType,".EOL;
		
		return $this;
	}
	
	protected function _object($name, $codes = [])
	{
		if( ! is_array($codes) )
		{
			\Errors::set('Error', 'arrayParameter', 'codes');
			return $this;	
		}
		
		$eol = EOL;	
		
		$statusCode = $eol."\t$name:".$eol."\t{";
		
		if( ! empty($codes) )
		{
			foreach( $codes as $code => $value )
			{
				$param = '';
				if(strstr($value, '->'))
				{
					$params = explode('->', $value);	
					$param = $params[0];
					$value = $params[1];
				}
				
				$statusCode .= $eol."\t\t$code:function($param)".$eol."\t\t{".$eol."\t\t\t$value".$eol."\t\t},".$eol;
			}
			
			$statusCode = trim(trim($statusCode), ',').$eol;
		}
		
		$statusCode .= "\t}";
		
		$this->functions[$name] = $eol."\t".$statusCode;
	}
	
	// STATUS CODE Property -------------------------------------------------------
	// statusCode data
	// statusCode:array
	// array(404 => 'alert(404);', 403 => 'alert(403);') 
	// To use parameters :::::    param1, param2->codes...   ::::: function(param1, param2){codes}
	// -> parameters and codes is seperators
	// array(404 => 'data->alert(data);', 403 => 'data->alert(data);')
	public function statusCode($codes = [])
	{
		$this->_object('statusCode', $codes);
			
		return $this;
	}
	
	// CONVERTERS Property -------------------------------------------------------
	// converters data
	// converters:array
	// To use parameters :::::    param1, param2->codes...   ::::: function(param1, param2){codes}
	// -> parameters and codes is seperators
	// array('C1' => 'alert('c1');', C2 => 'param1, param2->alert('c2');') 
	public function converters($codes = [])
	{
		$this->_object('converters', $codes);
			
		return $this;
	}
	
	
	protected function _functions($name, $params, $codes)
	{
		if( ! is_string($params) || ! is_string($codes) )
		{
			\Errors::set('Error', 'stringParameter', 'params & codes');
			return $this;
		}
		
		$eol = EOL;
		
		$this->functions[$name] = $eol."\t$name:function($params)".$eol."\t{".$eol."\t\t$codes".$eol."\t}";
	}
	
	// SUCCESS FUNCTION Property -------------------------------------------------------
	// success data
	// success: 2 Parameters
	// string @params : 'param1, param2'
	// string @success: 'alert("example")'
	public function success($params = 'e', $success = '')
	{
		$this->_functions('success', $params, $success);	
		
		return $this;
	}
	
	// ERROR FUNCTION Property -------------------------------------------------------
	// error data
	// error: 2 Parameters
	// string @params : 'param1, param2'
	// string @error  : 'alert("example")'
	public function error($params = 'e', $error = '')
	{
		$this->_functions('error', $params, $error);	
	
		return $this;
	}
	
	// COMPLETE FUNCTION Property -------------------------------------------------------
	// complete data
	// complete: 2 Parameters
	// string @params    : 'param1, param2'
	// string @complete  : 'alert("example")'
	public function complete($params = 'e', $complete = '')
	{
		$this->_functions('complete', $params, $complete);
		
		return $this;	
	}
	
	// BEFORE SEND FUNCTION Property -------------------------------------------------------
	// beforeSend data
	// beforeSend: 2 Parameters
	// string @params       : 'param1, param2'
	// string @before_send  : 'alert("example")'
	public function beforeSend($params = 'e', $beforeSend = '')
	{
		$this->_functions('beforeSend', $params, $beforeSend);
		
		return $this;
	}	
	
	// DATA FILTER FUNCTION Property -------------------------------------------------------
	// dataFilter data
	// dataFilter: 2 Parameters
	// string @params       : 'param1, param2'
	// string @data_filter  : 'alert("example")'
	public function dataFilter($params = 'e', $dataFilter = '')
	{
		$this->_functions('dataFilter', $params, $dataFilter);
		
		return $this;
	}
	
	protected function _callbacks($name, $params, $codes)
	{
		if( ! ( is_string($params) || is_string($codes) ) )
		{
			return $this;
		}
		
		$eol = EOL;
		
		$this->callbacks[$name] = $eol.".$name(function($params)".$eol."{".$eol."\t$codes".$eol."})";
	}	
	
	// DONE CALLBACK FUNCTION Property -------------------------------------------------------
	// done data
	// done: 2 Parameters
	// string @params : 'param1, param2'
	// string @done   : 'alert("example")'
	public function done($params = 'e', $done = '')
	{
		$this->_callbacks('done', $params, $done);
		
		return $this;
	}
	
	// FAIL CALLBACK FUNCTION Property -------------------------------------------------------
	// fail data
	// fail: 2 Parameters
	// string @params : 'param1, param2'
	// string @fail   : 'alert("example")'
	public function fail($params = 'e', $fail = '')
	{
		$this->_callbacks('fail', $params, $fail);
		
		return $this;
	}
	
	// ALWAYS CALLBACK FUNCTION Property -------------------------------------------------------
	// always data
	// always: 2 Parameters
	// string @params : 'param1, param2'
	// string @always : 'alert("example")'
	public function always($params = 'e', $always = '')
	{
		$this->_callbacks('always', $params, $always);
		
		return $this;
	}
	
	// THEN CALLBACK FUNCTION Property -------------------------------------------------------
	// then data
	// then: 2 Parameters
	// string @params : 'param1, param2'
	// string @then   : 'alert("example")'
	public function then($params = 'e', $then = '')
	{
		$this->_callbacks('then', $params, $then);
		
		return $this;
	}
	
	// Complementary method of operation
	// Optional Use Parameters
	// [string @url])  => url() method instead of the alternative  
	// [string @data]) => data() method instead of the alternative 
	public function send($url = '', $data = '')
	{
		if( ! is_string($url) || ! is_string($data) )
		{
			return \Errors::set('Error', 'stringParameter', 'url & data');
		}
		
		if( ! empty($url) )
		{
			$this->url($url);	
		}
		
		if( ! empty($data) )
		{
			$this->data($data);	
		}
		
		if( ! isset($this->sets['method']) )
		{
			$this->method('post');
		} 
		
		$eol  = EOL;
		$ajax = '';
		
		if( ! empty($this->sets) ) foreach( $this->sets as $val )
		{
			$ajax .= $val;
		}
		
		if( ! empty($this->functions) ) foreach( $this->functions as $val )
		{
			$ajax .= "\t$val,";
		}
		
		$ajax = rtrim(trim($ajax), ',');
		
		$callbacks = '';
		
		if( ! empty($this->callbacks) )
		{
			foreach( $this->callbacks as $val )
			{
				$callbacks .= $val;	
			}
			
			$callbacks .= ";".$eol;
		}
		else
		{
			$callbacks = ";".$eol;
		}
		
		$ajax = $this->_tag($eol."$.ajax".$eol."({".$eol."$ajax".$eol."})$callbacks");
		
		$this->_defaultVariable();
		
		return $ajax;
	}
	
	// Complementary method of operation
	// Optional Use Parameters
	// [string @url])  => url() method instead of the alternative  
	// [string @data]) => data() method instead of the alternative 
	public function create($url = '', $data = '')
	{
		return $this->send($url, $data);	
	}
	
	// DEFAULT VARIABLES
	protected function _defaultVariable()
	{
		$this->functions = [];
		$this->sets 	 = [];
		$this->callbacks = [];
	}
}