17 KiB
YooKassa API SDK
Class: \YooKassa\Model\Leg
Namespace: \YooKassa\Model
Summary:
Класс, описывающий маршрут
Constants
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | ISO8601 | Формат даты |
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $departure_airport | Трёхбуквенный IATA-код аэропорта вылета | |
| public | $departure_date | Дата вылета в формате YYYY-MM-DD ISO 8601:2004 | |
| public | $departureAirport | Трёхбуквенный IATA-код аэропорта вылета | |
| public | $departureDate | Дата вылета в формате YYYY-MM-DD ISO 8601:2004 | |
| public | $destination_airport | Трёхбуквенный IATA-код аэропорта прилёта | |
| public | $destinationAirport | Трёхбуквенный IATA-код аэропорта прилёта |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | AbstractObject constructor. | |
| public | __get() | Возвращает значение свойства | |
| public | __isset() | Проверяет наличие свойства | |
| public | __set() | Устанавливает значение свойства | |
| public | __unset() | Удаляет свойство | |
| public | fromArray() | Устанавливает значения свойств текущего объекта из массива | |
| public | getDepartureAirport() | Возвращает трёхбуквенный IATA-код аэропорта вылета | |
| public | getDepartureDate() | Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | |
| public | getDestinationAirport() | Возвращает трёхбуквенный IATA-код аэропорта прилёта | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | setDepartureAirport() | Устанавливает трёхбуквенный IATA-код аэропорта вылета | |
| public | setDepartureDate() | Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | |
| public | setDestinationAirport() | Устанавливает трёхбуквенный IATA-код аэропорта прилёта | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Model/Leg.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\Leg
- Implements:
Constants
ISO8601
Формат даты
ISO8601 = 'Y-m-d'
Properties
public $departure_airport : string
Description
Трёхбуквенный IATA-код аэропорта вылета
Type: string
Details:
public $departure_date : string
Description
Дата вылета в формате YYYY-MM-DD ISO 8601:2004
Type: string
Details:
public $departureAirport : string
Description
Трёхбуквенный IATA-код аэропорта вылета
Type: string
Details:
public $departureDate : string
Description
Дата вылета в формате YYYY-MM-DD ISO 8601:2004
Type: string
Details:
public $destination_airport : string
Description
Трёхбуквенный IATA-код аэропорта прилёта
Type: string
Details:
public $destinationAirport : string
Description
Трёхбуквенный IATA-код аэропорта прилёта
Type: string
Details:
Methods
public __construct() : mixed
public __construct(array $data = array()) : mixed
Summary
AbstractObject constructor.
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array |
data |
Returns: mixed -
public __get() : mixed
public __get(string $propertyName) : mixed
Summary
Возвращает значение свойства
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
Returns: mixed - Значение свойства
public __isset() : bool
public __isset(string $propertyName) : bool
Summary
Проверяет наличие свойства
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя проверяемого свойства |
Returns: bool - True если свойство имеется, false если нет
public __set() : mixed
public __set(string $propertyName, mixed $value) : mixed
Summary
Устанавливает значение свойства
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя свойства |
mixed |
value | Значение свойства |
Returns: mixed -
public __unset() : mixed
public __unset(string $propertyName) : mixed
Summary
Удаляет свойство
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
string |
propertyName | Имя удаляемого свойства |
Returns: mixed -
public fromArray() : mixed
public fromArray(array|\Traversable $sourceArray) : mixed
Summary
Устанавливает значения свойств текущего объекта из массива
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \Traversable |
sourceArray | Ассоциативный массив с настройками |
Returns: mixed -
public getDepartureAirport() : string
public getDepartureAirport() : string
Summary
Возвращает трёхбуквенный IATA-код аэропорта вылета
Details:
- Inherited From: \YooKassa\Model\Leg
Returns: string - Трёхбуквенный IATA-код аэропорта вылета
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public getDepartureDate() : string
public getDepartureDate() : string
Summary
Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004
Details:
- Inherited From: \YooKassa\Model\Leg
Returns: string - Дата вылета в формате YYYY-MM-DD ISO 8601:2004
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public getDestinationAirport() : string
public getDestinationAirport() : string
Summary
Возвращает трёхбуквенный IATA-код аэропорта прилёта
Details:
- Inherited From: \YooKassa\Model\Leg
Returns: string - Трёхбуквенный IATA-код аэропорта прилёта
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public jsonSerialize() : mixed
public jsonSerialize() : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: mixed -
public offsetExists() : mixed
public offsetExists(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public offsetGet() : mixed
public offsetGet(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public offsetSet() : mixed
public offsetSet(mixed $offset, mixed $value) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset | |
mixed |
value |
Returns: mixed -
public offsetUnset() : mixed
public offsetUnset(mixed $offset) : mixed
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Parameters:
| Type | Name | Description |
|---|---|---|
mixed |
offset |
Returns: mixed -
public setDepartureAirport() : mixed
public setDepartureAirport(string $value) : mixed
Summary
Устанавливает трёхбуквенный IATA-код аэропорта вылета
Details:
- Inherited From: \YooKassa\Model\Leg
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value |
Returns: mixed -
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public setDepartureDate() : mixed
public setDepartureDate(\DateTime|string $value) : mixed
Summary
Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004
Details:
- Inherited From: \YooKassa\Model\Leg
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string |
value |
Throws:
| Type | Description |
|---|---|
| \Exception |
Returns: mixed -
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public setDestinationAirport() : mixed
public setDestinationAirport(string $value) : mixed
Summary
Устанавливает трёхбуквенный IATA-код аэропорта прилёта
Details:
- Inherited From: \YooKassa\Model\Leg
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value |
Returns: mixed -
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
public toArray() : array
public toArray() : array
Summary
Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив со свойствами текущего объекта
protected getUnknownProperties() : array
protected getUnknownProperties() : array
Summary
Возвращает массив свойств которые не существуют, но были заданы у объекта
Details:
- Inherited From: \YooKassa\Common\AbstractObject
Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney