.. rst-class:: phpdoctorst

.. role:: php(code)
	:language: php


Util
====


.. php:namespace:: Firstred\PostNL\Util

.. php:class:: Util


	.. rst-class:: phpdoc-description
	
		| Class Util\.
		
	


Summary
-------

Methods
~~~~~~~

* :php:meth:`public static urlEncode\($arr, $prefix\)<Firstred\\PostNL\\Util\\Util::urlEncode\(\)>`
* :php:meth:`public static getPdfSizeAndOrientation\($pdf\)<Firstred\\PostNL\\Util\\Util::getPdfSizeAndOrientation\(\)>`
* :php:meth:`public static getDeliveryDate\($deliveryDate, $mondayDelivery, $sundayDelivery\)<Firstred\\PostNL\\Util\\Util::getDeliveryDate\(\)>`
* :php:meth:`public static getShippingDate\($deliveryDate, $days\)<Firstred\\PostNL\\Util\\Util::getShippingDate\(\)>`
* :php:meth:`public static getShippingDaysRemaining\($shippingDate, $preferredDeliveryDate\)<Firstred\\PostNL\\Util\\Util::getShippingDaysRemaining\(\)>`
* :php:meth:`protected static getHolidaysForYear\($year\)<Firstred\\PostNL\\Util\\Util::getHolidaysForYear\(\)>`
* :php:meth:`public static compareGuzzleVersion\($a, $b\)<Firstred\\PostNL\\Util\\Util::compareGuzzleVersion\(\)>`
* :php:meth:`public static isAssociativeArray\($array\)<Firstred\\PostNL\\Util\\Util::isAssociativeArray\(\)>`


Constants
---------

.. php:const:: ERROR_MARGIN = 2



Methods
-------

.. rst-class:: public static deprecated

	.. php:method:: public static urlEncode( $arr, $prefix=null)
	
		
		:Parameters:
			* **$arr** (array)  a map of param keys to values
			* **$prefix** (string | null)  

		
		:Returns: string a querystring, essentially
		:Since: 1.0.0 
		:Deprecated: 2.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static getPdfSizeAndOrientation( $pdf)
	
		
		:Parameters:
			* **$pdf** (string)  Raw PDF string

		
		:Returns: array | false | string Returns an array with the dimensions or ISO size and orientation
			The orientation is in FPDF format, so L for Landscape and P for Portrait
			Sizes are in mm
		
		:Since: 1.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static getDeliveryDate( $deliveryDate, $mondayDelivery=false, $sundayDelivery=false)
	
		.. rst-class:: phpdoc-description
		
			| Offline delivery date calculation\.
			
		
		
		:Parameters:
			* **$deliveryDate** (string)  Delivery date in any format accepted by DateTime
			* **$mondayDelivery** (bool)  Sunday sorting/Monday delivery enabled
			* **$sundayDelivery** (bool)  Sunday delivery enabled

		
		:Returns: string \(format: \`Y\-m\-d H:i:s\`\)
		:Throws: :any:`\\Exception <Exception>` 
		:Since: 1.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static getShippingDate( $deliveryDate, $days=\[0 =\> false, 1 =\> true, 2 =\> true, 3 =\> true, 4 =\> true, 5 =\> true, 6 =\> true\])
	
		.. rst-class:: phpdoc-description
		
			| Offline shipping date calculation\.
			
		
		
		:Parameters:
			* **$deliveryDate** (string)  
			* **$days** (array)  

		
		:Returns: string 
		:Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException <Firstred\\PostNL\\Exception\\InvalidArgumentException>` 
		:Since: 1.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static getShippingDaysRemaining( $shippingDate, $preferredDeliveryDate)
	
		.. rst-class:: phpdoc-description
		
			| Calculates amount of days remaining
			| i\.e\. preferred delivery date the day tomorrow =\> today = 0
			| i\.e\. preferred delivery date the day after tomorrow =\> today \+ tomorrow = 1
			| i\.e\. preferred delivery date the day after tomorrow, but one holiday =\> today \+ holiday = 0\.
			
			| 0 means: should ship today
			| < 0 means: should\'ve shipped in the past
			| anything higher means: you\'ve got some more time
			
		
		
		:Parameters:
			* **$shippingDate** (string)  Shipping date (format: `Y-m-d H:i:s`)
			* **$preferredDeliveryDate** (string)  Customer preference

		
		:Returns: int 
		:Throws: :any:`\\Exception <Exception>` 
		:Since: 1.0.0 
	
	

.. rst-class:: protected static

	.. php:method:: protected static getHolidaysForYear( $year)
	
		.. rst-class:: phpdoc-description
		
			| Get an array with all Dutch holidays for the given year\.
			
		
		
		:Parameters:
			* **$year** (string)  

		
		:Returns: array Credits to @tvlooy \(https://gist\.github\.com/tvlooy/1894247\)
		:Since: 1.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static compareGuzzleVersion(int|float|string $a, int|float|string $b)
	
		
		:Parameters:
			* **$a** (int | float | string)  
			* **$b** (int | float | string)  

		
		:Returns: int 
		:Since: 1.0.0 
	
	

.. rst-class:: public static

	.. php:method:: public static isAssociativeArray( $array)
	
		.. rst-class:: phpdoc-description
		
			| Check if the given array is associative\.
			
		
		
		:Parameters:
			* **$array** (array)  

		
		:Returns: bool 
		:Since: 2.0.0