method public

CollectionBase::key()

Класс: \Bitrix\Sale\Internals\CollectionBase

Сигнатура

public key() : mixed

Описание

Возвращает ключ текущего элемента.

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

mixed

Как применяется в CollectionBase

CollectionBase::key() — метод класса \Bitrix\Sale\Internals\CollectionBase модуля «Интернет-магазин».

Метод объекта: сначала нужен экземпляр CollectionBase.

use Bitrix\Main\Loader;
use Bitrix\Sale\Internals\CollectionBase;

Loader::includeModule('sale');

/** @var CollectionBase $object */
$result = $object->key();
// $result: mixed

Другие методы CollectionBase

count() Подсчитывает количество элементов объекта.
current() Возвращает текущий элемент.
getIterator()
isEmpty() Проверяет, пуста ли коллекция.
next() Переходит к следующему элементу.
offsetExists() Существует ли смещение.
offsetGet() Смещение для получения.
offsetSet() Смещение для установки.
offsetUnset() Смещение для удаления.
rewind() Перематывает итератор на первый элемент.
toArray()
valid() Проверяет, является ли текущая позиция допустимой.

key() есть и у других классов модуля «Интернет-магазин»: Basket, BasketBase, BasketItemCollection, BasketPropertiesCollection, BasketPropertiesCollectionBase, EntityCollection, Fields, ShipmentCollection.

Исходный файл: source/sale/lib/internals/collectionbase.php:100