Reference

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$asset
$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Config
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

new Users()
Creates a new Collection with the given objects
$users->add()
Adds a single user or an entire second collection to the current collection
$users->append()
Appends an element to the data array
$users->chunk()
Creates chunks of the same size.
$users->clone()
Returns a cloned instance of the collection
$users->count()
Counts all elements
$users->create()
$users->current()
Returns the current element
$users->data()
Getter and setter for the data
$users->empty()
Clone and remove all elements from the collection
$users->extend()
Adds all elements to the collection
Users::factory()
Takes an array of user props and creates a nice and clean user collection from it
$users->filter()
Filters elements by a custom filter function or an array of filters
$users->filterBy()
Filters elements by one of the predefined filter methods.
$users->find()
Find one or multiple elements by id
$users->findBy()
Find a single element by an attribute and its value
$users->findByKey()
Finds a user in the collection by id or email address
$users->first()
Returns the first element
$users->flip()
Returns the elements in reverse order
$users->get()
Getter
$users->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 filterBy.
$users->group()
Groups the elements by a given callback
$users->groupBy()
Groups the items by a given field
$users->has()
Checks if the given object or id is in the collection
$users->indexOf()
Correct position detection for objects.
$users->isEmpty()
Checks if the number of elements is zero
$users->isEven()
Checks if the number of elements is even
$users->isNotEmpty()
Checks if the number of elements is more than zero
$users->isOdd()
Checks if the number of elements is odd
$users->key()
Returns the current key
$users->keyOf()
Tries to find the key for the given element
$users->keys()
Returns an array of all keys
$users->last()
Returns the last element
$users->limit()
Returns a new object with a limited number of elements
Users::load()
Loads a user from disk by passing the absolute path (root)
$users->map()
Map a function to each element
$users->next()
Moves the cursor to the next element and returns it
$users->not()
Returns a Collection without the given element(s)
$users->nth()
Returns the nth element from the collection
$users->offset()
Returns a new object starting from the given offset
$users->paginate()
Add pagination
$users->pagination()
Get the previously added pagination object
$users->parent()
Returns the parent model
$users->pluck()
Extracts all values for a single field into a new array
$users->prepend()
Prepends an element to the data array
$users->prev()
Moves the cursor to the previous element and returns it
$users->query()
Runs a combination of filterBy, sortBy, not offset, limit, search and paginate on the collection.
$users->remove()
Removes an object
$users->rewind()
Moves the cusor to the first element
$users->search()
Searches the collection
$users->set()
Adds a new element to the collection
$users->shuffle()
Shuffle all elements
$users->slice()
Returns a slice of the object
$users->sortBy()
Sorts the elements by any number of fields
$users->toArray()
Converts all objects in the collection to an array. This can also take a callback function to further modify the array result.
$users->toJson()
Converts the object into a JSON string
$users->toString()
Convertes the object to a string
$users->valid()
Checks if the current element is valid
$users->values()
Returns an non-associative array with all values
$users->without()
Alias for $this->not()

$users->shuffle()

Shuffle all elements

$users->shuffle(): Collection

Return type

Collection

Inherited from

Kirby\Toolkit\Collection

Source code

kirby/src/Toolkit/Collection.php#L806