1. Documentation
  2. API
  3. Library
  4. Halcyon
  5. Collection

October\Rain\Halcyon\Collection

Source: ~/vendor/october/rain/src/Halcyon/Collection.php

Extends:

Implements:

  • ArrayAccess
  • Illuminate\Contracts\Support\Arrayable
  • Countable
  • IteratorAggregate
  • Traversable
  • Illuminate\Contracts\Support\Jsonable
  • JsonSerializable

This class represents a collection of Halcyon models.

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

  • protected array $items - defined in Illuminate\Support\Collection. The items contained in the collection.
  • protected static array $proxies - defined in Illuminate\Support\Collection. The methods that can be proxied.
  • protected static array $macros - defined in Illuminate\Support\Collection. The registered string macros.

Public methods

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Illuminate\Support\Collection. Dynamically handle calls to the class.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Support\Collection. Dynamically handle calls to the class.
  • public void __construct(mixed $items=array()) - defined in Illuminate\Support\Collection. Create a new collection.
  • public mixed __get(string $key) - defined in Illuminate\Support\Collection. Dynamically access collection proxies.
  • public string __toString() - defined in Illuminate\Support\Collection. Convert the collection to its string representation.
  • public array all() - defined in Illuminate\Support\Collection. Get all of the items in the collection.
  • public mixed average(callable|string|null $callback=NULL) - defined in Illuminate\Support\Collection. Alias for the "avg" method.
  • public mixed avg(callable|string|null $callback=NULL) - defined in Illuminate\Support\Collection. Get the average value of a given key.
  • public static chunk(int $size) - defined in Illuminate\Support\Collection. Chunk the underlying collection array.
  • public static collapse() - defined in Illuminate\Support\Collection. Collapse the collection of items into a single array.
  • public static combine(mixed $values) - defined in Illuminate\Support\Collection. Create a collection by using this collection for keys and another for its values.
  • public $this concat(Traversable $source) - defined in Illuminate\Support\Collection. Push all of the given items onto the collection.
  • public bool contains(mixed $key, mixed $operator=NULL, mixed $value=NULL) - defined in Illuminate\Support\Collection. Determine if an item exists in the collection.
  • public bool containsStrict(mixed $key, mixed $value=NULL) - defined in Illuminate\Support\Collection. Determine if an item exists in the collection using strict comparison.
  • public int count() - defined in Illuminate\Support\Collection. Count the number of items in the collection.
  • public static crossJoin(mixed $lists=NULL) - defined in Illuminate\Support\Collection. Cross join with the given lists, returning all possible permutations.
  • public void dd($args=NULL) - defined in Illuminate\Support\Collection. Dump the collection and end the script.
  • public static diff(mixed $items) - defined in Illuminate\Support\Collection. Get the items in the collection that are not present in the given items.
  • public static diffAssoc(mixed $items) - defined in Illuminate\Support\Collection. Get the items in the collection whose keys and values are not present in the given items.
  • public static diffKeys(mixed $items) - defined in Illuminate\Support\Collection. Get the items in the collection whose keys are not present in the given items.
  • public $this dump() - defined in Illuminate\Support\Collection. Dump the collection.
  • public $this each(callable $callback) - defined in Illuminate\Support\Collection. Execute a callback over each item.
  • public static eachSpread(callable $callback) - defined in Illuminate\Support\Collection. Execute a callback over each nested chunk of items.
  • public bool every(string|callable $key, mixed $operator=NULL, mixed $value=NULL) - defined in Illuminate\Support\Collection. Determine if all items in the collection pass the given test.
  • public static except(Illuminate\Support\Collection|mixed $keys) - defined in Illuminate\Support\Collection. Get all items except for those with the specified keys.
  • public static filter(callable|null $callback=NULL) - defined in Illuminate\Support\Collection. Run a filter over each of the items.
  • public mixed first(callable|null $callback=NULL, mixed $default=NULL) - defined in Illuminate\Support\Collection. Get the first item from the collection.
  • public static firstWhere(string $key, mixed $operator, mixed $value=NULL) - defined in Illuminate\Support\Collection. Get the first item by the given key value pair.
  • public static flatMap(callable $callback) - defined in Illuminate\Support\Collection. Map a collection and flatten the result by a single level.
  • public static flatten(int $depth=INF) - defined in Illuminate\Support\Collection. Get a flattened array of the items in the collection.
  • public static flip() - defined in Illuminate\Support\Collection. Flip the items in the collection.
  • public static forPage(int $page, int $perPage) - defined in Illuminate\Support\Collection. "Paginate" the collection by slicing it into a smaller collection.
  • public $this forget(string|array $keys) - defined in Illuminate\Support\Collection. Remove an item from the collection by key.
  • public mixed get(mixed $key, mixed $default=NULL) - defined in Illuminate\Support\Collection. Get an item from the collection by key.
  • public CachingIterator getCachingIterator(int $flags=1) - defined in Illuminate\Support\Collection. Get a CachingIterator instance.
  • public ArrayIterator getIterator() - defined in Illuminate\Support\Collection. Get an iterator for the items.
  • public static groupBy(callable|string $groupBy, bool $preserveKeys=false) - defined in Illuminate\Support\Collection. Group an associative array by a field or using a callback.
  • public bool has(mixed $key) - defined in Illuminate\Support\Collection. Determine if an item exists in the collection by key.
  • public static bool hasMacro(string $name) - defined in Illuminate\Support\Collection. Checks if macro is registered.
  • public string implode(string $value, string $glue=NULL) - defined in Illuminate\Support\Collection. Concatenate values of a given key as a string.
  • public static intersect(mixed $items) - defined in Illuminate\Support\Collection. Intersect the collection with the given items.
  • public static intersectByKeys(mixed $items) - defined in Illuminate\Support\Collection. Intersect the collection with the given items by key.
  • public bool isEmpty() - defined in Illuminate\Support\Collection. Determine if the collection is empty or not.
  • public bool isNotEmpty() - defined in Illuminate\Support\Collection. Determine if the collection is not empty.
  • public array jsonSerialize() - defined in Illuminate\Support\Collection. Convert the object into something JSON serializable.
  • public static keyBy(callable|string $keyBy) - defined in Illuminate\Support\Collection. Key an associative array by a field or using a callback.
  • public static keys() - defined in Illuminate\Support\Collection. Get the keys of the collection items.
  • public mixed last(callable|null $callback=NULL, mixed $default=NULL) - defined in Illuminate\Support\Collection. Get the last item from the collection.
  • public array lists(string $value, string $key=NULL) - defined in October\Rain\Support\Collection. Get an array with the values of a given key.
  • public static void macro(string $name, object|callable $macro) - defined in Illuminate\Support\Collection. Register a custom macro.
  • public static static make(mixed $items=array()) - defined in Illuminate\Support\Collection. Create a new collection instance if the value isn't one already.
  • public static map(callable $callback) - defined in Illuminate\Support\Collection. Run a map over each of the items.
  • public static mapInto(string $class) - defined in Illuminate\Support\Collection. Map the values into a new class.
  • public static mapSpread(callable $callback) - defined in Illuminate\Support\Collection. Run a map over each nested chunk of items.
  • public static mapToDictionary(callable $callback) - defined in Illuminate\Support\Collection. Run a dictionary map over the items.
  • public static mapToGroups(callable $callback) - defined in Illuminate\Support\Collection. Run a grouping map over the items.
  • public static mapWithKeys(callable $callback) - defined in Illuminate\Support\Collection. Run an associative map over each of the items.
  • public mixed max(callable|string|null $callback=NULL) - defined in Illuminate\Support\Collection. Get the max value of a given key.
  • public mixed median(null $key=NULL) - defined in Illuminate\Support\Collection. Get the median of a given key.
  • public static merge(mixed $items) - defined in Illuminate\Support\Collection. Merge the collection with the given items.
  • public mixed min(callable|string|null $callback=NULL) - defined in Illuminate\Support\Collection. Get the min value of a given key.
  • public static void mixin(object $mixin) - defined in Illuminate\Support\Collection. Mix another object into the class.
  • public array|null mode(mixed $key=NULL) - defined in Illuminate\Support\Collection. Get the mode of a given key.
  • public static nth(int $step, int $offset=0) - defined in Illuminate\Support\Collection. Create a new collection consisting of every n-th element.
  • public bool offsetExists(mixed $key) - defined in Illuminate\Support\Collection. Determine if an item exists at an offset.
  • public mixed offsetGet(mixed $key) - defined in Illuminate\Support\Collection. Get an item at a given offset.
  • public void offsetSet(mixed $key, mixed $value) - defined in Illuminate\Support\Collection. Set the item at a given offset.
  • public void offsetUnset(string $key) - defined in Illuminate\Support\Collection. Unset the item at a given offset.
  • public static only(mixed $keys) - defined in Illuminate\Support\Collection. Get the items with the specified keys.
  • public static pad(int $size, mixed $value) - defined in Illuminate\Support\Collection. Pad collection to the specified length with a value.
  • public static partition(callable|string $callback) - defined in Illuminate\Support\Collection. Partition the collection into two arrays using the given callback or key.
  • public mixed pipe(callable $callback) - defined in Illuminate\Support\Collection. Pass the collection to the given callback and return the result.
  • public static pluck(string|array $value, string|null $key=NULL) - defined in Illuminate\Support\Collection. Get the values of a given key.
  • public mixed pop() - defined in Illuminate\Support\Collection. Get and remove the last item from the collection.
  • public $this prepend(mixed $value, mixed $key=NULL) - defined in Illuminate\Support\Collection. Push an item onto the beginning of the collection.
  • public static void proxy(string $method) - defined in Illuminate\Support\Collection. Add a method to the list of proxied methods.
  • public mixed pull(mixed $key, mixed $default=NULL) - defined in Illuminate\Support\Collection. Get and remove an item from the collection.
  • public $this push(mixed $value) - defined in Illuminate\Support\Collection. Push an item onto the end of the collection.
  • public $this put(mixed $key, mixed $value) - defined in Illuminate\Support\Collection. Put an item in the collection by key.
  • public mixed random(int|null $number=NULL) - defined in Illuminate\Support\Collection. Get one or a specified number of items randomly from the collection.
  • public mixed reduce(callable $callback, mixed $initial=NULL) - defined in Illuminate\Support\Collection. Reduce the collection to a single value.
  • public static reject(callable|mixed $callback) - defined in Illuminate\Support\Collection. Create a collection of all elements that do not pass a given truth test.
  • public static reverse() - defined in Illuminate\Support\Collection. Reverse items order.
  • public mixed search(mixed $value, bool $strict=false) - defined in Illuminate\Support\Collection. Search the collection for a given value and return the corresponding key if successful.
  • public mixed shift() - defined in Illuminate\Support\Collection. Get and remove the first item from the collection.
  • public static shuffle(int $seed=NULL) - defined in Illuminate\Support\Collection. Shuffle the items in the collection.
  • public static slice(int $offset, int $length=NULL) - defined in Illuminate\Support\Collection. Slice the underlying collection array.
  • public static sort(callable|null $callback=NULL) - defined in Illuminate\Support\Collection. Sort through each item with a callback.
  • public static sortBy(callable|string $callback, int $options=0, bool $descending=false) - defined in Illuminate\Support\Collection. Sort the collection using the given callback.
  • public static sortByDesc(callable|string $callback, int $options=0) - defined in Illuminate\Support\Collection. Sort the collection in descending order using the given callback.
  • public static splice(int $offset, int|null $length=NULL, mixed $replacement=array()) - defined in Illuminate\Support\Collection. Splice a portion of the underlying collection array.
  • public static split(int $numberOfGroups) - defined in Illuminate\Support\Collection. Split a collection into a certain number of groups.
  • public mixed sum(callable|string|null $callback=NULL) - defined in Illuminate\Support\Collection. Get the sum of the given values.
  • public static take(int $limit) - defined in Illuminate\Support\Collection. Take the first or last {$limit} items.
  • public $this tap(callable $callback) - defined in Illuminate\Support\Collection. Pass the collection to the given callback and then return it.
  • public static static times(int $number, callable $callback=NULL) - defined in Illuminate\Support\Collection. Create a new collection by invoking the callback a given amount of times.
  • public array toArray() - defined in Illuminate\Support\Collection. Get the collection of items as a plain array.
  • public Illuminate\Support\Collection toBase() - defined in Illuminate\Support\Collection. Get a base Support collection instance from this collection.
  • public string toJson(int $options=0) - defined in Illuminate\Support\Collection. Get the collection of items as JSON.
  • public $this transform(callable $callback) - defined in Illuminate\Support\Collection. Transform each item in the collection using a callback.
  • public static union(mixed $items) - defined in Illuminate\Support\Collection. Union the collection with the given items.
  • public static unique(string|callable|null $key=NULL, bool $strict=false) - defined in Illuminate\Support\Collection. Return only unique items from the collection array.
  • public static uniqueStrict(string|callable|null $key=NULL) - defined in Illuminate\Support\Collection. Return only unique items from the collection array using strict comparison.
  • public mixed unless(bool $value, callable $callback, callable $default=NULL) - defined in Illuminate\Support\Collection. Apply the callback if the value is falsy.
  • public static array unwrap(array|static $value) - defined in Illuminate\Support\Collection. Get the underlying items from the given collection if applicable.
  • public static values() - defined in Illuminate\Support\Collection. Reset the keys on the underlying array.
  • public mixed when(bool $value, callable $callback, callable $default=NULL) - defined in Illuminate\Support\Collection. Apply the callback if the value is truthy.
  • public static where(string $key, mixed $operator, mixed $value=NULL) - defined in Illuminate\Support\Collection. Filter items by the given key value pair.
  • public static whereIn(string $key, mixed $values, bool $strict=false) - defined in Illuminate\Support\Collection. Filter items by the given key value pair.
  • public static whereInStrict(string $key, mixed $values) - defined in Illuminate\Support\Collection. Filter items by the given key value pair using strict comparison.
  • public static whereNotIn(string $key, mixed $values, bool $strict=false) - defined in Illuminate\Support\Collection. Filter items by the given key value pair.
  • public static whereNotInStrict(string $key, mixed $values) - defined in Illuminate\Support\Collection. Filter items by the given key value pair using strict comparison.
  • public static whereStrict(string $key, mixed $value) - defined in Illuminate\Support\Collection. Filter items by the given key value pair using strict comparison.
  • public static static wrap(mixed $value) - defined in Illuminate\Support\Collection. Wrap the given value in a collection if applicable.
  • public static zip(mixed $items) - defined in Illuminate\Support\Collection. Zip the collection together with one or more arrays.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected array getArrayableItems(mixed $items) - defined in Illuminate\Support\Collection. Results array of items from Collection or Arrayable.
  • protected Closure operatorForWhere(string $key, string $operator, mixed $value=NULL) - defined in Illuminate\Support\Collection. Get an operator checker callback.
  • protected bool useAsCallable(mixed $value) - defined in Illuminate\Support\Collection. Determine if the given value is callable, but not a string.
  • protected callable valueRetriever(string $value) - defined in Illuminate\Support\Collection. Get a value retrieving callback.