Rajaongkir::getProvince() - Code Metrics - steevenz/rajaongkir - Measure and Improve Code Quality continuously with Scrutinizer

Rajaongkir::getProvince() A
last analyzed 2020-11-14 17:44 UTC

↳ Parent: Rajaongkir
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	2
rs	10
<?php
/**
 * Advanced RajaOngkir API PHP Library
 *
 * MIT License
 *
 * Copyright (c) 2018 Steeve Andrian Salim
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) 2018, Steeve Andrian Salim
 * @filesource
 */

// ------------------------------------------------------------------------

namespace Steevenz;

// ------------------------------------------------------------------------

use O2System\Curl;
use O2System\Kernel\Http\Message\Uri;
use O2System\Spl\Traits\Collectors\ErrorCollectorTrait;

/**
 * Class Rajaongkir
 * @package Steevenz
 */
class Rajaongkir {
	use ErrorCollectorTrait;

	/**
	 * Constant Account Type
	 *
	 * @access  public
	 * @type    string
	 */
	const ACCOUNT_STARTER = 'starter';
	const ACCOUNT_BASIC = 'basic';
	const ACCOUNT_PRO = 'pro';

	/**
	 * Rajaongkir::$accountType
	 *
	 * Rajaongkir Account Type.
	 *
	 * @access  protected
	 * @type    string
	 */
	protected $accountType = 'starter';

	/**
	 * Rajaongkir::$apiKey
	 *
	 * Rajaongkir API key.
	 *
	 * @access  protected
	 * @type    string
	 */
	protected $apiKey = null;

	/**
	 * List of Supported Account Types
	 *
	 * @access  protected
	 * @type    array
	 */
	protected $supportedAccountTypes = [
		'starter',
		'basic',
		'pro',
	];

	/**
	 * Supported Couriers
	 *
	 * @access  protected
	 * @type    array
	 */
	protected $supportedCouriers = [
		'starter' => [
			'jne',
			'pos',
			'tiki',
		],
		'basic'   => [
			'jne',
			'pos',
			'tiki',
			'pcp',
			'esl',
			'rpx',
		],
		'pro'     => [
			'jne',
			'pos',
			'tiki',
			'rpx',
			'pandu',
			'wahana',
			'sicepat',
			'jnt',
			'pahala',
			'sap',
			'jet',
			'indah',
			'dse',
			'slis',
			'first',
			'ncs',
			'star',
			'ninja',
			'lion',
			'idl',
			'rex',
			'ide',
			'sentral'
		],
	];

	/**
	 * Rajaongkir::$supportedWaybills
	 *
	 * Rajaongkir supported couriers waybills.
	 *
	 * @access  protected
	 * @type    array
	 */
	protected $supportedWayBills = [
		'starter' => [],
		'basic'   => [
			'jne',
		],
		'pro'     => [
			'jne',
			'pos',
			'tiki',
			'pcp',
			'rpx',
			'wahana',
			'sicepat',
			'j&t',
			'sap',
			'jet',
			'dse',
			'first',
		],
	];

	/**
	 * Rajaongkir::$couriersList
	 *
	 * Rajaongkir courier list.
	 *
	 * @access  protected
	 * @type array
	 */
	protected $couriersList = [
		'jne'       => 'Jalur Nugraha Ekakurir (JNE)',
		'pos'       => 'POS Indonesia (POS)',
		'tiki'      => 'Citra Van Titipan Kilat (TIKI)',
		'pcp'       => 'Priority Cargo and Package (PCP)',
		'esl'       => 'Eka Sari Lorena (ESL)',
		'rpx'       => 'RPX Holding (RPX)',
		'pandu'     => 'Pandu Logistics (PANDU)',
		'wahana'    => 'Wahana Prestasi Logistik (WAHANA)',
		'sicepat'   => 'SiCepat Express (SICEPAT)',
		'j&t'       => 'J&T Express (J&T)',
		'pahala'    => 'Pahala Kencana Express (PAHALA)',
		'cahaya'    => 'Cahaya Logistik (CAHAYA)',
		'sap'       => 'SAP Express (SAP)',
		'jet'       => 'JET Express (JET)',
		'indah'     => 'Indah Logistic (INDAH)',
		'slis'      => 'Solusi Express (SLIS)',
		'expedito*' => 'Expedito*',
		'dse'       => '21 Express (DSE)',
		'first'     => 'First Logistics (FIRST)',
		'ncs'       => 'Nusantara Card Semesta (NCS)',
		'star'      => 'Star Cargo (STAR)',
	];

	/**
	 * Rajaongkir::$response
	 *
	 * Rajaongkir response.
	 *
	 * @access  protected
	 * @type    mixed
	 */
	protected $response;

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::__construct
	 *
	 * @access  public
	 * @throws  \InvalidArgumentException
	 */
	public function __construct( $apiKey = null, $accountType = null ) {
		if ( isset( $apiKey ) ) {
			if ( is_array( $apiKey ) ) {
				if ( isset( $apiKey['api_key'] ) ) {
					$this->apiKey = $apiKey['api_key'];
				}

				if ( isset( $apiKey['account_type'] ) ) {
					$accountType = $apiKey['account_type'];
				}
			} elseif ( is_string( $apiKey ) ) {
				$this->apiKey = $apiKey;
			}
		}

		if ( isset( $accountType ) ) {
			$this->setAccountType( $accountType );
		}
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::setApiKey
	 *
	 * Set Rajaongkir API Key.
	 *
	 * @param string $apiKey Rajaongkir API Key
	 *
	 * @access  public
	 * @return  static
	 */
	public function setApiKey( $apiKey ) {
		$this->apiKey = $apiKey;

		return $this;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::setAccountType
	 *
	 * Set Rajaongkir account type.
	 *
	 * @param string $accountType RajaOngkir Account Type, can be starter, basic or pro
	 *
	 * @access  public
	 * @return  static
	 * @throws  \InvalidArgumentException
	 */
	public function setAccountType( $accountType ) {
		$accountType = strtolower( $accountType );

		if ( in_array( $accountType, $this->supportedAccountTypes ) ) {
			$this->accountType = $accountType;
		} else {
			throw new \InvalidArgumentException( 'Rajaongkir: Invalid Account Type' );
		}

		return $this;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::request
	 *
	 * Curl request API caller.
	 *
	 * @param string $path
	 * @param array $params
	 * @param string $type
	 *
	 * @access  protected
	 * @return  array|bool Returns FALSE if failed.
	 */
	protected function request( $path, $params = [], $type = 'GET' ) {
		$apiUrl = 'https://api.rajaongkir.com';

		switch ( $this->accountType ) {
			default:
			case 'starter':
				$path = 'starter/' . $path;
				break;

			case 'basic':
				$path = 'basic/' . $path;
				break;

			case 'pro':
				$apiUrl = 'https://pro.rajaongkir.com';
				$path   = 'api/' . $path;
				break;
		}

		$uri     = ( new Uri( $apiUrl ) )->withPath( $path );
		$request = new Curl\Request();
		$request->setHeaders( [
			'key' => $this->apiKey,
		] );

		switch ( $type ) {
			default:
			case 'GET':
				$this->response = $request->setUri( $uri )->get( $params );
				break;

			case 'POST':
				$request->addHeader( 'content-type', 'application/x-www-form-urlencoded' );
				$this->response = $request->setUri( $uri )->post( $params );
				break;
		}

		// Try to get curl error
		if ( false !== ( $error = $this->response->getError() ) ) {

			$this->addErrors( $error->getArrayCopy() );
		} else {
			$body = $this->response->getBody();

			if ( $body instanceof \DOMDocument ) {
				$this->errors[404] = 'Page Not Found!';
			} else {
				$body   = $body->rajaongkir;
				$status = $body['status'];

				if ( $status['code'] == 200 ) {
					if ( isset( $body['results'] ) ) {
						if ( count( $body['results'] ) == 1 && isset( $body['results'][0] ) ) {
							return $body['results'][0];
						} elseif ( count( $body['results'] ) ) {
							return $body['results'];
						}
					} elseif ( isset( $body['result'] ) ) {
						return $body['result'];
					}
				} else {
					$this->errors[ $status['code'] ] = $status['description'];
				}
			}
		}

		return false;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getCouriersList
	 *
	 * Get list of supported couriers.
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getCouriersList() {
		return $this->couriersList;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getProvinces
	 *
	 * Get list of provinces.
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getProvinces() {
		return $this->request( 'province' );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getProvince
	 *
	 * Get detail of single province.
	 *
	 * @param int $idProvince Province ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getProvince( $idProvince ) {
		return $this->request( 'province', [ 'id' => $idProvince ] );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getCities
	 *
	 * Get list of province cities.
	 *
	 * @param int $idProvince Province ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getCities( $idProvince = null ) {
		$params = [];

		if ( ! is_null( $idProvince ) ) {
			$params['province'] = $idProvince;
		}

		return $this->request( 'city', $params );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getCity
	 *
	 * Get detail of single city.
	 *
	 * @param int $idCity City ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getCity( $idCity ) {
		return $this->request( 'city', [ 'id' => $idCity ] );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getSubdistricts
	 *
	 * Get list of city subdisctricts.
	 *
	 * @param int $idCity City ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getSubdistricts( $idCity ) {
		if ( $this->accountType === 'starter' ) {
			$this->errors[302] = 'Unsupported Subdistricts Request. Tipe akun starter tidak mendukung hingga tingkat kecamatan.';

			return false;
		} elseif ( $this->accountType === 'basic' ) {
			$this->errors[302] = 'Unsupported Subdistricts Request. Tipe akun basic tidak mendukung hingga tingkat kecamatan.';

			return false;
		}

		return $this->request( 'subdistrict', [ 'city' => $idCity ] );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getSubdistrict
	 *
	 * Get detail of single subdistrict.
	 *
	 * @param int $idSubdistrict Subdistrict ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getSubdistrict( $idSubdistrict ) {
		if ( $this->accountType === 'starter' ) {
			$this->errors[302] = 'Unsupported Subdistricts Request. Tipe akun starter tidak mendukung hingga tingkat kecamatan.';

			return false;
		} elseif ( $this->accountType === 'basic' ) {
			$this->errors[302] = 'Unsupported Subdistricts Request. Tipe akun basic tidak mendukung hingga tingkat kecamatan.';

			return false;
		}

		return $this->request( 'subdistrict', [ 'id' => $idSubdistrict ] );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getInternationalOrigins
	 *
	 * Get list of supported international origins.
	 *
	 * @param int $idProvince Province ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getInternationalOrigins( $idProvince = null ) {
		if ( $this->accountType === 'starter' ) {
			$this->errors[301] = 'Unsupported International Origin Request. Tipe akun starter tidak mendukung tingkat international.';

			return false;
		}

		$params = [];

		if ( isset( $idProvince ) ) {
			$params['province'] = $idProvince;
		}

		return $this->request( 'v2/internationalOrigin', $params );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getInternationalOrigin
	 *
	 * Get list of supported international origins by city and province.
	 *
	 * @param int $idCity City ID
	 * @param int $idProvince Province ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getInternationalOrigin( $idCity = null, $idProvince = null ) {
		if ( $this->accountType === 'starter' ) {
			$this->errors[301] = 'Unsupported International Origin Request. Tipe akun starter tidak mendukung tingkat international.';

			return false;
		}

		if ( isset( $idCity ) ) {
			$params['id'] = $idCity;

		}

		if ( isset( $idProvince ) ) {
			$params['province'] = $idProvince;
		}

		return $this->request( 'v2/internationalOrigin', $params );

	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getInternationalDestinations
	 *
	 * Get list of international destinations.
	 *
	 * @param int $id_country Country ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getInternationalDestinations() {
		if ( $this->accountType === 'starter' ) {
			$this->errors[301] = 'Unsupported International Destination Request. Tipe akun starter tidak mendukung tingkat international.';

			return false;
		}

		return $this->request( 'v2/internationalDestination' );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getInternationalDestination
	 *
	 * Get International Destination
	 *
	 * @param int $idCountry Country ID
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getInternationalDestination( $idCountry = null ) {
		if ( $this->accountType === 'starter' ) {
			$this->errors[301] = 'Unsupported International Destination Request. Tipe akun starter tidak mendukung tingkat international.';

			return false;
		}

		$params = [];

		if ( isset( $idCountry ) ) {
			$params['id'] = $idCountry;
		}

		return $this->request( 'v2/internationalDestination', $params );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getCost
	 *
	 * Get cost calculation.
	 *
	 * @param array $origin City, District or Subdistrict Origin
	 * @param array $destination City, District or Subdistrict Destination
	 * @param array $metrics Array of Specification
	 *                                  weight      int     weight in gram (required)
	 *                                  length      number  package length dimension
	 *                                  width       number  package width dimension
	 *                                  height      number  package height dimension
	 *                                  diameter    number  package diameter
	 * @param string $courier Courier Code
	 *
	 * @access   public
	 * @return  array|bool Returns FALSE if failed.
	 * @see      http://rajaongkir.com/dokumentasi/pro
	 *
	 * @example
	 * $rajaongkir->getCost(
	 *      ['city' => 1],
	 *      ['subdistrict' => 12],
	 *      ['weight' => 100, 'length' => 100, 'width' => 100, 'height' => 100, 'diameter' => 100],
	 *      'jne'
	 * );
	 *
	 */
	public function getCost( array $origin, array $destination, $metrics, $courier ) {
		$params['courier'] = strtolower( $courier );


		$params['originType']      = strtolower( key( $origin ) );
		$params['destinationType'] = strtolower( key( $destination ) );

		if ( $params['originType'] !== 'city' ) {
			$params['originType'] = 'subdistrict';
		}

		if ( ! in_array( $params['destinationType'], [ 'city', 'country' ] ) ) {
			$params['destinationType'] = 'subdistrict';
		}

		if ( is_array( $metrics ) ) {

			if ( ! isset( $metrics['weight'] ) and
			     isset( $metrics['length'] ) and
			     isset( $metrics['width'] ) and
			     isset( $metrics['height'] )
			) {
				$metrics['weight'] = ( ( $metrics['length'] * $metrics['width'] * $metrics['height'] ) / 6000 ) * 1000;
			} elseif ( isset( $metrics['weight'] ) and
			           isset( $metrics['length'] ) and
			           isset( $metrics['width'] ) and
			           isset( $metrics['height'] )
			) {
				$weight = ( ( $metrics['length'] * $metrics['width'] * $metrics['height'] ) / 6000 ) * 1000;

				if ( $weight > $metrics['weight'] ) {
					$metrics['weight'] = $weight;
				}
			}

			foreach ( $metrics as $key => $value ) {
				$params[ $key ] = $value;
			}
		} elseif ( is_numeric( $metrics ) ) {
			$params['weight'] = $metrics;
		}

		switch ( $this->accountType ) {
			case 'starter':

				if ( $params['destinationType'] === 'country' ) {
					$this->errors[301] = 'Unsupported International Destination. Tipe akun starter tidak mendukung pengecekan destinasi international.';

					return false;
				} elseif ( $params['originType'] === 'subdistrict' or $params['destinationType'] === 'subdistrict' ) {
					$this->errors[302] = 'Unsupported Subdistrict Origin-Destination. Tipe akun starter tidak mendukung pengecekan ongkos kirim sampai kecamatan.';

					return false;
				}

				if ( ! isset( $params['weight'] ) and
				     isset( $params['length'] ) and
				     isset( $params['width'] ) and
				     isset( $params['height'] )
				) {
					$this->errors[304] = 'Unsupported Dimension. Tipe akun starter tidak mendukung pengecekan biaya kirim berdasarkan dimensi.';

					return false;
				} elseif ( isset( $params['weight'] ) and $params['weight'] > 30000 ) {
					$this->errors[305] = 'Unsupported Weight. Tipe akun starter tidak mendukung pengecekan biaya kirim dengan berat lebih dari 30000 gram (30kg).';

					return false;
				}

				if ( ! in_array( $params['courier'], $this->supportedCouriers[ $this->accountType ] ) ) {
					$this->errors[303] = 'Unsupported Courier. Tipe akun starter tidak mendukung pengecekan biaya kirim dengan kurir ' . $this->couriersList[ $courier ] . '.';

					return false;
				}

				break;

			case 'basic':

				if ( $params['originType'] === 'subdistrict' or $params['destinationType'] === 'subdistrict' ) {
					$this->errors[302] = 'Unsupported Subdistrict Origin-Destination. Tipe akun basic tidak mendukung pengecekan ongkos kirim sampai kecamatan.';

					return false;
				}

				if ( ! isset( $params['weight'] ) and
				     isset( $params['length'] ) and
				     isset( $params['width'] ) and
				     isset( $params['height'] )
				) {
					$this->errors[304] = 'Unsupported Dimension. Tipe akun basic tidak mendukung pengecekan biaya kirim berdasarkan dimensi.';

					return false;
				} elseif ( isset( $params['weight'] ) and $params['weight'] > 30000 ) {
					$this->errors[305] = 'Unsupported Weight. Tipe akun basic tidak mendukung pengecekan biaya kirim dengan berat lebih dari 30000 gram (30kg).';

					return false;
				} elseif ( isset( $params['weight'] ) and $params['weight'] < 30000 ) {
					unset( $params['length'], $params['width'], $params['height'] );
				}

				if ( ! in_array( $params['courier'], $this->supportedCouriers[ $this->accountType ] ) ) {
					$this->errors[303] = 'Unsupported Courier. Tipe akun basic tidak mendukung pengecekan biaya kirim dengan kurir ' . $this->couriersList[ $courier ] . '.';

					return false;
				}

				break;
		}

		$params['origin']      = $origin[ key( $origin ) ];
		$params['destination'] = $destination[ key( $destination ) ];

		$path = key( $destination ) === 'country' ? 'internationalCost' : 'cost';

		return $this->request( $path, $params, 'POST' );
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getWaybill
	 *
	 * Get detail of waybill.
	 *
	 * @param int $idWaybill Receipt ID
	 * @param null|string $courier Courier Code
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getWaybill( $idWaybill, $courier ) {
		$courier = strtolower( $courier );

		if ( in_array( $courier, $this->supportedWayBills[ $this->accountType ] ) ) {
			return $this->request( 'waybill', [
				'key'     => $this->apiKey,
				'waybill' => $idWaybill,
				'courier' => $courier,
			], 'POST' );
		}

		return false;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getCurrency
	 *
	 * Get Rajaongkir currency.
	 *
	 * @access  public
	 * @return  array|bool Returns FALSE if failed.
	 */
	public function getCurrency() {
		if ( $this->accountType !== 'starter' ) {
			return $this->request( 'currency' );
		}

		$this->errors[301] = 'Unsupported Get Currency. Tipe akun starter tidak mendukung pengecekan currency.';

		return false;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getSupportedCouriers
	 *
	 * Gets list of supported couriers by your account.
	 *
	 * @return array|bool Returns FALSE if failed.
	 */
	public function getSupportedCouriers() {
		if ( isset( $this->supportedCouriers[ $this->accountType ] ) ) {
			return $this->supportedCouriers[ $this->accountType ];
		}

		return false;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getSupportedWayBills
	 *
	 * Gets list of supported way bills based on account type.
	 *
	 * @return array|bool Returns FALSE if failed.
	 */
	public function getSupportedWayBills() {
		if ( isset( $this->supportedWayBills[ $this->accountType ] ) ) {
			return $this->supportedWayBills[ $this->accountType ];
		}

		return false;
	}

	// ------------------------------------------------------------------------

	/**
	 * Rajaongkir::getResponse
	 *
	 * Get original response object.
	 *
	 * @param string $offset Response Offset Object
	 *
	 * @access  public
	 * @return  \O2System\Curl\Response|bool Returns FALSE if failed.
	 */
	public function getResponse() {
		return $this->response;
	}
}

steevenz / rajaongkir

Rajaongkir::getProvince() A last analyzed 2020-11-14 17:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Rajaongkir::getProvince() A
last analyzed 2020-11-14 17:44 UTC
