mindplay-dk

How do you document model attributes implemented using synchronous accessor methods?

Example - bare model, no documentation:

class Contact
{
    protected $phone;
    
    public function getPhone() {

mindplay-dk

/// This interface defines an event listener
interface IListener<Event> {
    (event: Event): void
}

/// This interface represents an event hook
interface IHook<Event> {
    /// Attach a handler to this hookable
    (handler: IListener<Event>): void

mindplay-dk

/// This interface defines an event listener
interface Listener<Event> {
	(event: Event): void
}

/// This interface represents a hookable type
interface Hookable<Event> {
	/// Attach a handler to this hookable
	(handler: Listener<Event>): void
}

mindplay-dk

This page provides a full overview of PHP's SessionHandler life-cycle - this was generated by a set of test-scripts, in order to provide an exact overview of when and what you can expect will be called in your custom SessionHandler implementation.

Each example is a separate script being run by a client with cookies enabled.

To the left, you can see the function being called in your script, and to the right, you can see the resulting calls being made to a custom session-handler registed using session_set_save_handler().

mindplay-dk

type Handler<TEvent> = (event: TEvent) => void;

interface Hook<TEvent> {
  (handler: Handler<TEvent>): void;
  send(event: TEvent): void;
}

function hook<TEvent>(): Hook<TEvent> {
  const handlers: Array<Handler<TEvent>> = [];

mindplay-dk

/**
 * Basic UUID v4 creator
 */
abstract class UUID
{
    /**
     * @type string path to the dev/urandom device on Linux
     */
    const DEV_URANDOM = '/dev/urandom';

mindplay-dk

module cookie {

    export function read(name: string) {
        var result = new RegExp('(?:^|; )' + encodeURIComponent(name) + '=([^;]*)').exec(document.cookie);
        return result ? result[1] : null;
    }
    
    export function write(name: string, value: string, days?: number) {
        if (!days) {
            days = 365 * 20;

mindplay-dk

/**
 * jQuery wrapper/plugin for console functions in FF/IE/Chrome.
 *
 * These functions execute silently when no console is available, so
 * you can safely leave diagnotics calls in place during development
 * and beta-testing.
 *
 * Examples:
 *
 *    $.log('Hello, World.',1,2,3);

mindplay-dk

<?php

// Sample implementation of a FilterInterface apadater for Conduit (UNTESTED)

use Phly\Conduit\MiddlewareInterface;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\FilterInterface as Filter;

class ConduitFilterAdapter implements MiddlewareInterface

mindplay-dk

<?php

use mindplay\walkway\Route;
use Phly\Conduit\MiddlewareInterface;
use Phly\Conduit\MiddlewarePipe;
use Phly\Http\Server;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;

require __DIR__ . '/vendor/autoload.php';