Skip to main content

A PHP code generator which use Python Like grammar

Project description

#PingPHP
[![Build Status](https://travis-ci.org/zxylvlp/PingPHP.svg?branch=master)](https://travis-ci.org/zxylvlp/PingPHP)
###A PHP code generator which use Python Like grammar



##Introduction

- PingPHP essentially is a PHP code generator, similar to CoffeeScript(CS). However there is a big difference between this code and CS.
- This library is in order to efficiently write Ping code with Python like grammar, and generate the PHP code which is not different from manual code. So it can improve the production efficiency, and the generated code is easy to maintain.
- The purpose of the CS is to maintain the CS code, with a lot of syntax sugar, it improved the efficiency of the code but loss the readability of the code.
- For the most of PHPer, such a large number of syntax sugar is very hard to accept.
- Moreover, when we work with other developers, maintaining the Ping or CS code directly would impede communication.

- Ping is my wife's name. And one of the purposes of writen this library is help PHPer to improve the work efficiency. Help us to spend more time with our family and friends.

##Installation

To install PingPHP, simply:

`$ sudo pip install redis`

or from source:

`$ sudo python setup.py install`

##Getting Started

Generate PingPHP.conf.json file.

```
$ pinginit
```

Then edit the config file with Wildcard.

```
{
"ignoreFiles": [
"test1/*"
],
"transFiles": [
"test/**/*.ping"
],
"destDir": "dest"
}
```

Generate files:

```
$ pingrun
```
Generate files and observe their changes:

```
$ pingsee
```

##CodeSample

Input file: part of typeHinting.ping

```
''''''
#如下面的类
class MyClass:

'''
* 测试函数
* 第一个参数必须为 OtherClass 类的一个对象
'''
public test(otherclass:OtherClass):
echo otherclass.var



'''
* 另一个测试函数
* 第一个参数必须为数组
'''
public test_array(input_array:array):
print_r(input_array)



'''
* 第一个参数必须为递归类型
'''
public test_interface(iterator:Traversable):
echo get_class(iterator)


'''
* 第一个参数必须为回调类型
'''
public test_callable(callback:callable, data):
call_user_func(callback, data)

myclass = new MyClass()

```

Output file: part of typeHinting.php

```
<?php
/****/
//如下面的类
class MyClass {

/**
* 测试函数
* 第一个参数必须为 OtherClass 类的一个对象
**/
public function test(OtherClass $otherclass) {
echo $otherclass->var;
}



/**
* 另一个测试函数
* 第一个参数必须为数组
**/
public function test_array(array $input_array) {
print_r($input_array);
}



/**
* 第一个参数必须为递归类型
**/
public function test_interface(Traversable $iterator) {
echo get_class($iterator);
}


/**
* 第一个参数必须为回调类型
**/
public function test_callable(callable $callback, $data) {
call_user_func($callback, $data);
}
}

$myclass = new MyClass();
```

## Related

* Vim Syntax highlighting plugin: [vim-PingPHP](https://github.com/PingPHP/Vim-PingPHP)
* Sublime Text Syntax highlighting plugin: (Temporarily not supported)

##Author

* [Weibo http://weibo.com/zxylvlp](http://weibo.com/zxylvlp)

* [Mail 937141576@qq.com](mailto:937141576@qq.com)

##License (MIT)

Copyright (c) 2015 zxylvlp

[MIT](https://github.com/zxylvlp/PingPHP/blob/master/LICENSE)

Project details


Release history Release notifications

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page