samlitowitz/php-collection-generator

A tool to generate PHP collection implementations

v1.0.1 2022-12-11 15:08 UTC

Requires

• php: >=7.4
• ext-json: *
• nikic/php-parser: ^4.14
• symfony/console: v5.4.11
• symfony/deprecation-contracts: v2.5.2
• symfony/service-contracts: v2.5.2
• symfony/string: v5.4.11

Requires (Dev)

• phpunit/phpunit: ^9.5

Apache-2.0

• Sam Litowitz

README

Generate type-safe PHP collections!

Table of Contents

1. Installation
2. Usage
   1. Configuration
3. Collection Interfaces and Additional Methods
   1. Interfaces
4. Future Features

Installation

composer require --dev samlitowitz/php-collection-generator

Usage

./vendor/bin/php-collection-generator --config /path/to/php-collection-generator.json generate /path/to/output/dir

Configuration

{
	"types": [
		{
			"itemFQN": "Type", // Fully qualified type name the collection will support
			"namespace": "PhpCollectionGenerator\\App\\Console\\Config", // Namespace the generated collection will belong to
			"className": "TypeCollection" // Class name the generated collection have
		} // Supports multiple typed collections in a single configuration
	]
}

Collection Interfaces and Additional Methods

Interfaces

The generated collection will implement the following interfaces

1. \Countable
2. \Iterator
3. \JsonSerializable

Additional Methods

The generated collection includes the following methods in addition to those needed to fulfil the above interfaces

1. public function toArray(): array
2. public function add(\Fully\Qualified\Namespace\Type ...$entities): void

Future Features

1. Output File Formatting
   1. Configuration options
      1. type-hint member variables
         1. inline
         2. as comment