Onurkacmaz\LaravelN11\Models\City

Complexity

Total Complexity

5

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getCities()	0	4	1
A	getCity()	0	4	1
A	getDistricts()	0	4	1
A	getNeighborhoods()	0	4	1

<?php

namespace Onurkacmaz\LaravelN11\Models;

use Onurkacmaz\LaravelN11\Exceptions\N11Exception;
use Onurkacmaz\LaravelN11\Interfaces\CityInterface;
use Onurkacmaz\LaravelN11\Service;
use SoapClient;

class City extends Service implements CityInterface
{

    /**
     * @var SoapClient|null
     */
    private $_client;

    /**
     * City constructor
     * @throws N11Exception|\SoapFault
     */
    public function __construct()
    {
        parent::__construct();
        $this->_client = $this->setEndPoint(self::END_POINT);
    }

    /**
     * @return mixed
     * @description Sistemde kayıtlı şehirlerin kodları ve plaka numaraları ile birlikte listelenmesi için bu metot kullanılır.
     * Adres ile ilgili işlem yapmak istendiği zaman bu servis aracılığı ile elde edilen şehir kodları kullanılır.
     * Genel kullanıma açık bir servis olduğu için servisin kullanımı sırasında herhangi bir güvenlik kontrolü yapılmamaktadır.
     */
    public function getCities(): object
    {
        return $this->_client->GetCities();
    }

    /**
     * @param int $cityCode
     * @return mixed
     * @description
     * Şehir plaka numarası verilen şehrin sistemde kayıtlı olan kodunu ve hangi şehir olduğunu öğrenmek için bu metot kullanılmalıdır.
     * Genel kullanıma açık bir servis olduğu için servisin kullanımı sırasında herhangi bir güvenlik kontrolü yapılmamaktadır.
     * Sorgulanan şehir sistemde bulunamazsa ‘şehir bulunamadı’ hatası alınır.
     */
    public function getCity(int $cityCode): object
    {
        return $this->_client->GetCity(["cityCode" => $cityCode]);
    }

    /**
     * @param int $cityCode
     * @return mixed
     * @description Plaka kodu verilen şehre ait ilçelerinin listelenmesi için bu metot kullanılmalıdır.
     * İlçe kodu adres ekleme/güncelleme işlemlerinde kullanılmaktadır.
     * Genel kullanıma açık bir servis olduğu için servisin kullanımı sırasında herhangi bir güvenlik kontrolü yapılmamaktadır.
     * Sorgulanan şehir sistemde bulunamazsa ‘şehir bulunamadı’ hatası alınır.
     */
    public function getDistricts(int $cityCode): object
    {
        return $this->_client->GetDistrict(["cityCode" => $cityCode]);
    }

    /**
     * @param int $districtId
     * @return mixed
     * @description İlçe kodu verilen semt/mahallelerin listelenmesi için bu metot kullanılmalıdır.
     * Genel kullanıma açık bir servis olduğu için servisin kullanımı sırasında herhangi bir güvenlik kontrolü yapılmamaktadır.
     * Sorgulanan ilçe sistemde bulunamazsa ‘ilçe bulunamadı’ hatası alınır.
     */
    public function getNeighborhoods(int $districtId):object
    {
        return $this->_client->GetNeighborhoods(["districtId" => $districtId]);
    }

}