CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.3 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
      • Iterator
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class UnfoldIterator

An iterator that can be used to generate nested iterators out of a collection of items by applying an function to each of the elements in this iterator.

Namespace: Cake\Collection\Iterator
See: \Cake\Collection\Collection::unfold()

Property Summary

  • $_innerIterator protected
    Iterator

    A reference to the internal iterator this object is wrapping.

  • $_unfolder protected
    callable

    A function that is passed each element in this iterator and must return an array or Traversable object.

Method Summary

  • __construct() public

    Creates the iterator that will generate child iterators from each of the elements it was constructed with.

  • getChildren() public

    Returns an iterator containing the items generated by transforming the current value with the callable function.

  • hasChildren() public

    Returns true as each of the elements in the array represent a list of items

Method Detail

__construct() ¶ public

__construct(array|Traversable $items, callable $unfolder)

Creates the iterator that will generate child iterators from each of the elements it was constructed with.

Parameters
array|Traversable $items

The list of values to iterate

callable $unfolder

A callable function that will receive the current item and key. It must return an array or Traversable object out of which the nested iterators will be yielded.

getChildren() ¶ public

getChildren(): RecursiveIterator

Returns an iterator containing the items generated by transforming the current value with the callable function.

Returns
RecursiveIterator

hasChildren() ¶ public

hasChildren(): bool

Returns true as each of the elements in the array represent a list of items

Returns
bool

Property Detail

$_innerIterator ¶ protected

A reference to the internal iterator this object is wrapping.

Type
Iterator

$_unfolder ¶ protected

A function that is passed each element in this iterator and must return an array or Traversable object.

Type
callable
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs