deliveryServiceCity

Класс для работы с населенными пунктами в системе службы доставки

Переменные

Переменные отсутсвуют

Методы

void dropCache () Сбрасывает кеш класса
mixed getDeliveryServiceId ({ [id] }) Возвращает id службы доставки к которой относится населенный пункт
mixed getId ({ [deliveryServiceId], [cityTitle] }) Возвращает id населенного пункта
mixed getList ({ deliveryServiceId, [searchString], [searchFromStartKey], [amount] }) Возвращает список населенных пунктов в системе службы доставки
object getNew () Возвращает новую копию объекта класса
mixed getTitle ({ [id] }) Возвращает название населенного пункта в системе службы доставки
mixed init ({ [id] }) Инициализация класса
mixed isExist ({ [id], [devName] }) (Внимание! Метод временно не работает) Проверяет существование населенного пункта в системе службы доставки

dropCache

Сбрасывает кеш класса

Возвращаемые значения

void

Примеры кода




getDeliveryServiceId

Синоним: deliveryServiceId
Возвращает id службы доставки к которой относится населенный пункт

Параметры

[id] int Id населенного пункта

Возвращаемые значения

string Название населенного пункта в системе службы доставки
bool False - в случае ошибки

Примеры кода




getId

Синоним: id
Возвращает id населенного пункта

Параметры

[deliveryServiceId] int Id службы доставки
[cityTitle] string Наименование города

Возвращаемые значения

int Id населенного пункта
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список населенных пунктов в системе службы доставки

Параметры

deliveryServiceId int Id службы доставки
[searchString] string Поисковая фраза для поиска по наименованию города
[searchFromStartKey] int Поиск с начала наименования города. 0 - содержит, 1 - начинается. По умолчанию: 0
[amount] int Кол-во городов. По умолчанию: 0 (все города)

Возвращаемые значения

array Массив обьектов deliveryServiceCity
bool False - в случае ошибки

Примеры кода




getNew

Синоним: new
Возвращает новую копию объекта класса

Возвращаемые значения

object deliveryServiceCity

Примеры кода




getTitle

Синоним: title
Возвращает название населенного пункта в системе службы доставки

Параметры

[id] int Id населенного пункта

Возвращаемые значения

string Название населенного пункта в системе службы доставки
bool False - в случае ошибки

Примеры кода




init

Инициализация класса

Параметры

[id] int Id населенного пункта в системе службы доставки

Возвращаемые значения

bool True - обьект инициализирован
bool False - в случае ошибки

Примеры кода




isExist

(Внимание! Метод временно не работает) Проверяет существование населенного пункта в системе службы доставки

Параметры

[id] string Id населенного пункта
[devName] string Имя для разработчика

Возвращаемые значения

bool True - если существует
bool False - если не существует или в случае ошибки

Примеры кода