{"id":20162478,"url":"https://github.com/willavelar/php-design-pattern-behavioral-iterator","last_synced_at":"2025-08-04T08:42:12.154Z","repository":{"id":204772923,"uuid":"712600614","full_name":"willavelar/php-design-pattern-behavioral-iterator","owner":"willavelar","description":"a simple php example about the behavioral pattern: Iterator","archived":false,"fork":false,"pushed_at":"2023-10-31T20:18:34.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T02:45:16.557Z","etag":null,"topics":["behavioral-patterns","design-patterns","iterator","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willavelar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-31T19:47:11.000Z","updated_at":"2023-10-31T22:11:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab6f62b1-b1d1-4a14-9623-dd99b617cf4f","html_url":"https://github.com/willavelar/php-design-pattern-behavioral-iterator","commit_stats":null,"previous_names":["willavelar/php-design-partner-behavioral-iterator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/willavelar/php-design-pattern-behavioral-iterator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willavelar%2Fphp-design-pattern-behavioral-iterator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willavelar%2Fphp-design-pattern-behavioral-iterator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willavelar%2Fphp-design-pattern-behavioral-iterator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willavelar%2Fphp-design-pattern-behavioral-iterator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willavelar","download_url":"https://codeload.github.com/willavelar/php-design-pattern-behavioral-iterator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willavelar%2Fphp-design-pattern-behavioral-iterator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268672082,"owners_count":24288244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["behavioral-patterns","design-patterns","iterator","php"],"created_at":"2024-11-14T00:25:19.394Z","updated_at":"2025-08-04T08:42:12.081Z","avatar_url":"https://github.com/willavelar.png","language":"PHP","readme":"## Iterator\r\n\r\nIterator is a behavioral design pattern that lets you traverse elements of a collection without exposing its underlying representation (list, stack, tree, etc.).\r\n\r\n-----\r\n\r\nWe need to create a list of budgets and then show information about them.\r\n\r\n### The problem\r\n\r\nThis way, by grouping via array, we can place other types of information that will not be part of the budget, thus creating gaps in our code.\r\n\r\n```php\r\n\u003c?php\r\nclass Budget\r\n{\r\n    public float $value;\r\n    public int $items;\r\n}\r\n```\r\n```php\r\n\u003c?php\r\n\r\n$budget1 = new Budget();\r\n$budget1-\u003eitems = 7;\r\n$budget1-\u003evalue = 1500.75;\r\n\r\n$budget2 = new Budget();\r\n$budget2-\u003eitems = 3;\r\n$budget2-\u003evalue = 150;\r\n\r\n$budget3 = new Budget();\r\n$budget3-\u003eitems = 5;\r\n$budget3-\u003evalue = 1350;\r\n\r\n$budgetList = [\r\n    $budget1,\r\n    $budget2,\r\n    $budget3\r\n];\r\n\r\nforeach ($budgetList as $budget) {\r\n    echo \"Value: \". $budget-\u003evalue . PHP_EOL;\r\n    echo \"Items: \". $budget-\u003eitems . PHP_EOL;\r\n\r\n    echo PHP_EOL;\r\n}\r\n```\r\n\r\n\r\n### The solution\r\n\r\nNow, using the Itarator pattern, we create an object that is a list of budgets, which only accepts budgets, and then we make it traversable by the PHP Iterator.\r\n\r\n```php\r\n\u003c?php\r\nclass BudgetList implements \\IteratorAggregate\r\n{\r\n    public array $budget = [];\r\n\r\n    public function addBudget(Budget $budget): void\r\n    {\r\n        $this-\u003ebudget[] = $budget;\r\n    }\r\n\r\n    public function getIterator(): \\ArrayIterator\r\n    {\r\n        return new \\ArrayIterator($this-\u003ebudget);\r\n    }\r\n}\r\n```\r\n```php\r\n\u003c?php\r\n$budget1 = new Budget();\r\n$budget1-\u003eitems = 7;\r\n$budget1-\u003evalue = 1500.75;\r\n\r\n$budget2 = new Budget();\r\n$budget2-\u003eitems = 3;\r\n$budget2-\u003evalue = 150;\r\n\r\n$budget3 = new Budget();\r\n$budget3-\u003eitems = 5;\r\n$budget3-\u003evalue = 1350;\r\n\r\n$budgetList = new BudgetList();\r\n$budgetList-\u003eaddBudget($budget1);\r\n$budgetList-\u003eaddBudget($budget2);\r\n$budgetList-\u003eaddBudget($budget3);\r\n\r\nforeach ($budgetList as $budget) {\r\n    echo \"Value: \". $budget-\u003evalue . PHP_EOL;\r\n    echo \"Items: \". $budget-\u003eitems . PHP_EOL;\r\n\r\n    echo PHP_EOL;\r\n}\r\n```\r\n\r\n-----\r\n\r\n### Installation for test\r\n\r\n![PHP Version Support](https://img.shields.io/badge/php-7.4%2B-brightgreen.svg?style=flat-square) ![Composer Version Support](https://img.shields.io/badge/composer-2.2.9%2B-brightgreen.svg?style=flat-square)\r\n\r\n```bash\r\ncomposer install\r\n```\r\n\r\n```bash\r\nphp wrong/test.php\r\nphp right/test.php\r\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillavelar%2Fphp-design-pattern-behavioral-iterator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillavelar%2Fphp-design-pattern-behavioral-iterator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillavelar%2Fphp-design-pattern-behavioral-iterator/lists"}