augustohp

#!/usr/bin/env python3
import argparse
import sys

def tokenize(source):
    return list(source)

def parse(tokens):
    ast = []
    stack = [ast]

augustohp

<?php

use FooBar\Test\Mock;

// In the sample below, $mock expects the method "sayHelloTo" to be called one time 
// with the parameter $name equals "Alexandre" and return "Hello Alexandre"

$mock = (new Mock('NamespaceVendor\\ClassName'))([
    'sayHelloTo' => function($name="Alexandre") {
        return "Hello Alexandre";

augustohp

Making documentation useful again

Or trying. We, as developers, love code. We read, we study, we do stare at a nice code and get amused by it. In the end of the day what we really care about is code and its functionality. Making our work useful is always the main objective and to do that, we have to - let me take a deep breath here - document it.

We have solutions today that circle around documentation blocks for classes, methods, properties and so on. We even made that documentation do something with @Annotations. So we code and (hopefully) document it using an specific markup: PHPDoc.

Don't get me wrong here. I really think PHPDoc is great, but the documentation generated by it is really usefull? Yeah, I know: IDEs do use them and so on. But how many times have an API doc been useful? Can you just give an API doc to someone and expect a lot of understanding from it?

README to the rescue

augustohp

Example 1:

$math = new Math;
$balance = 12.30;
$deposit = 1.70;
$total = $math->sum($balance, $deposit);
if ($total === 14)
    echo 'Ok';
else

echo 'Fail';

augustohp

view_path = '/app/views'

[options]
debug = false
charset = 'UTF-8'
base_template_class = 'Twig_Template'
strict_variables = false
autoescape = true
cache = false
auto_reload = null

augustohp

<?php

namespace MyApp;

class HtmlHandler implements ViewHandler
{
    public function __invoke(Response $response)
    {
        foreach ($response->getHeaders() as $header)
            header($header);

augustohp

; Configurations
db_host                = 'localhost'
db_user                = 'zend'
db_passwd              = ''
db_name                = 'test'
db_driver              = 'mysql'
;db_port               = 3306
;db_charset            = 'utf8'
dsn                    = '[db_driver]:host=[db_host];dbname=[db_name]'
dsn                    = 'sqlite::memory:'

augustohp

<?php

/**
 * Simple loader class
 *
 * Usage: new Vortice\Common\Loader('Zend', './Zend');
 * @author Carlos André Ferrari <[email protected]>
 */
namespace Vortice\Common;

augustohp

<?php
class Entidade
{
	public function toArray()
	{
		return array('uhull');
	}
}

class EntityIterator extends \ArrayIterator

augustohp

{% if cases_list.ProcessInstance is defined %}
            {% for case in cases_list.ProcessInstance %}
                {% for activity in case.activities.children() %}
            		<tr>
                        {% for variable in case.clientVariables.children() %}
                            {{ set value = variable.xpath('string[2]') }}
                            <td>{{ array_pop(value) }}</td>
                        {% endfor %}
                        <td><a href="{{ cloud_link_address }}{{ activity.uuid.value }}" target="_blank">{{ activity.name }}</a></td>
                        <td>#</td>