PHPackages                             kzykhys/php-class-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. kzykhys/php-class-generator

ActiveApplication[Utility & Helpers](/categories/utility)

kzykhys/php-class-generator
===========================

Generate PSR compliant classes from plain text document

1.0.0(13y ago)121014MITPHPPHP >=5.3.3

Since Nov 20Pushed 12y ago1 watchersCompare

[ Source](https://github.com/kzykhys/php-class-generator)[ Packagist](https://packagist.org/packages/kzykhys/php-class-generator)[ RSS](/packages/kzykhys-php-class-generator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (3)Used By (0)

PHP Class Generator [![Build Status](https://camo.githubusercontent.com/723796a263fe3ffde1252962254d7e402ba83387f70c1150140eda13862ebc88/68747470733a2f2f7472617669732d63692e6f72672f6b7a796b6879732f7068702d636c6173732d67656e657261746f722e706e67)](https://travis-ci.org/kzykhys/php-class-generator)
========================================================================================================================================================================================================================================================================================================

[](#php-class-generator-)

Generate PSR compliant classes from plain text document

Requirements
------------

[](#requirements)

- PHP 5.3.3 +

Installation
------------

[](#installation)

### Download phar

[](#download-phar)

[Download php-cg.phar](https://github.com/downloads/kzykhys/php-class-generator/php-cg.phar) and store anywhere.

### via Composer

[](#via-composer)

```
{
    "require": {
        "kzykhys/php-class-generator": "dev-master"
    }
}

```

Usage
-----

[](#usage)

Write your class and save the text file to \*.pcg (Syntax is described below) For example `./doc/myclass.pcg`

```
KzykHys\ClassGenerator\Sample < KzykHys\ClassGenerator\Container  The sample of PHP Class Generator
> Generates PHP classes from plain text document (*.pcg)
+ iterator:\ArrayIterator
# container:array
# length:integer[get set] > The length of code
# compiled:boolean[is set] > Whether this class is compiled or not
- options:array
- generator:Generator[get set]
+ __construct(options:array)
+ generate(document:string version:string):\KzykHys\ClassGenerator\Compiler\StreamWriter
+ getString():string > Returns the code as a string
+ write(filename:string) > Write the code to file
+ count():integer
# traverseContainer():Container

```

Run the command

```
$ php php-pcg.phar --from ./doc --to ./src

```

PHP file will be generated to `./src/Full/Qualified/ClassName.php`

```