Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community
Partners

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Str
- Tpl
- Url
- V
- Xml

new Options()
$options->add()

Adds a single object or an entire second collection to the current collection
$options->append()

Appends an element to the data array
$options->chunk()

Creates chunks of the same size.
$options->clone()

Returns a cloned instance of the collection
$options->count()

Counts all elements
$options->current()

Returns the current element
$options->data()

Getter and setter for the data
$options->empty()

Clone and remove all elements from the collection
$options->extend()

Adds all elements to the collection
Options::factory()
$options->filter()

Filters elements by one of the predefined filter methods, by a custom filter function or an array of filters
$options->filterBy()

Alias for Kirby\Toolkit\Collection::filter
$options->find()

Find one or multiple elements by id
$options->findBy()

Find a single element by an attribute and its value
$options->findByKey()

Find a single element by key (id)
$options->first()

Returns the first element
$options->flip()

Returns the elements in reverse order
$options->get()

Getter
$options->getAttribute()

Extracts an attribute value from the given element in the collection. This is useful if elements in the collection might be objects, arrays or anything else and you need to get the value independently from that. We use it for filter.
$options->getIterator()

Get an iterator for the items.
$options->group()

Groups the items by a given field or callback. Returns a collection with an item for each group and a collection for each group.
$options->groupBy()

Alias for Kirby\Toolkit\Collection::group
$options->has()

Checks if the given object or id is in the collection
$options->indexOf()

Correct position detection for objects.
$options->intersection()

Returns a Collection with the intersection of the given elements
$options->intersects()

Checks if there is an intersection between the given collection and this collection
$options->isEmpty()

Checks if the number of elements is zero
$options->isEven()

Checks if the number of elements is even
$options->isNotEmpty()

Checks if the number of elements is more than zero
$options->isOdd()

Checks if the number of elements is odd
$options->key()

Returns the current key
$options->keyOf()

Tries to find the key for the given element
$options->keys()

Returns an array of all keys
$options->last()

Returns the last element
$options->limit()

Returns a new object with a limited number of elements
$options->map()

Map a function to each element
$options->next()

Moves the cursor to the next element and returns it
$options->not()

Returns a Collection without the given element(s)
$options->nth()

Returns the nth element from the collection
$options->offset()

Returns a new object starting from the given offset
$options->paginate()

Add pagination and return a sliced set of data.
$options->pagination()

Get the previously added pagination object
$options->parent()

Returns the parent model
$options->pluck()

Extracts all values for a single field into a new array
$options->prepend()

Prepends an element to the data array
$options->prev()

Moves the cursor to the previous element and returns it
$options->query()

Runs a combination of filter, sort, not, offset, limit, search and paginate on the collection.
$options->random()

Returns a new collection consisting of random elements, from the original collection, shuffled or ordered
$options->remove()

Removes an object
$options->render()
$options->rewind()

Moves the cursor to the first element
$options->search()

Searches the collection
$options->set()

Adds a new element to the collection
$options->shuffle()

Shuffle all elements
$options->slice()

Returns a slice of the object
$options->sort()

Sorts the elements by any number of fields
Options::sortArgs()

Get sort arguments from a string
$options->sortBy()

Alias for Kirby\Toolkit\Collection::sort
$options->toArray()

Converts all objects in the collection to an array. This can also take a callback function to further modify the array result.
$options->toJson()

Converts the object into a JSON string
$options->toString()

Converts the object to a string
$options->valid()

Checks if the current element is valid
$options->values()

Returns a non-associative array with all values. If a mapping Closure is passed, all values are processed by the Closure.
$options->when()

The when method only executes the given Closure when the first parameter is true. If the first parameter is false, the Closure will not be executed.
$options->without()

Alias for $this->not()

$options->current()

Returns the current element

kirby/src/Toolkit/Iterator.php#L60

$options->current()

Parent class

Kirby\Option\Options inherited from Kirby\Toolkit\Iterator

Did you find an error? Help us improve our docs and edit this page on GitHub. Make sure to check out our styleguide →

Report an issue on this page