amphp/amphp.github.io

Main website repository.

amphp.github.io's Issues

Aerys Docs TODO

SIMPLE

START

• Intro [php bin/aerys -d -c demo.php]
• Very simple setup of Host + static Root

HTTP

• Sample http function [mention Router, Response, Request]
• Response [headers, end()]
• Request [headers, query array]
• parseBody function + ParsedBody class
• Router [methodname('/route', $callable), mention dynamic routes]
• Dynamic routes [having route info as last arg, explain route info]
• Cookies [refer to Session, Request::getCookie(), Response::setCookie()]

WEBSOCKET

• websocket(instanceof Websocket) [explain clientId, onOpen, onClose, onData, yield $message]
• Websocket\Endpoint [send(), close(), Websocket::onStart()]
• Websocket::onHandshake [second parameter of onOpen]

HOST

• expose(), name()
• encrypt() [HTTPS ... per port! HTTP2 needs openssl 1.0.2 !!!]
• use() [explain exactly]
• redirect() [is the last action, e.g. combine with router, redirect in case of not found]

I/O

• Typical Amp promises usable in Websocket methods and HTTP callable [refer to Amp docs]
• Big fat warning about blocking I/O

HELPERS (only intros)

• Overview (Reverse proxy, Session) (link to docs / github repo)

LOGGING

• PSR3 Logger
• Bootable imports Logger

OPTIONS

• AERYS_OPTIONS, Server::get/setOption, Request::getOption
• "simple" options [user, sendServerToken, allowedMethods]

ADVANCED

HTTP

• Response::stream()
• Response::push()
• Managing routes

PERFORMANCE

• Aerys is not the bottleneck. Your App is. [explain (careful about memory_limit), tips?]
• Perf critical options [balance against DOS etc.]
• Response::stream() and Websocket\Endpoint::send() return Promises!
• explain Body = Websocket\Message PromiseStream [only increase accepted data limit for these] + ClientException may be thrown in while waiting. No need to catch.
• BodyParser (incremental API)

MIDDLEWARES

• Intro [powerful, use with care, ...]
• Middleware::do() [no I/O, "protocol" of string, array, null and false]
• InternalRequest [headers, locals, Request::get/setLocalVar()]

END

• Sum it up [mention CommandClient, HttpDriver]

CLASSES

• All APIs documented per class

Document Amp's helpers

Stubs already created here: http://amphp.org/docs/amp/managing-concurrency.html#helpers

Reference

We need to generate a PHPDoc reference for every project. We need our own template for it, because the existing ones are really ugly.

logo ideas

image
image
image
image
image
image

Tables need to be responsive

Currently, we have overflow-x: hidden to prevent too large elements from creating a horizontal scrollbar. Those elements must shrink so we can remove the overflow-x: hidden.

The samples provided in the Getting Started section don't work

This section needs to be updated. None of the provided examples seem to be working.

The code sample provided here https://amphp.org/getting-started/tcp-chat/basic-echo-server throws this error:

PHP Fatal error: Uncaught TypeError: Argument 1 passed to {closure}() must be an instance of Amp\Socket\ServerSocket, instance of Amp\Socket\ResourceSocket given, called in [REDACTED]vendor/amphp/amp/lib/functions.php on line 60 and defined in [REDACTED]/test.php:13

Same thing here: https://amphp.org/getting-started/tcp-chat/broadcasting - i only tried running the first code sample

PHP Fatal error: Uncaught TypeError: Argument 1 passed to class@anonymous::handleClient() must be an instance of Amp\Socket\ServerSocket, instance of Amp\Socket\ResourceSocket given, called in [REDACTED]/index.php on line 20 and defined in [REDACTED]/index.php:25

Steps to reproduce:

1. Create a new test directory:
   mkdir test; cd test
2. Within that test directory download amphp/socket:
   composer require amphp/socket
3. Create a test.php file, copy and paste one of the samples then execute the file with this command:
   php test.php
   This will start the script and wait for connections
4. From another terminal try to connect with "nc":
   nc localhost 1337

As soon as nc attempts to connect the script will throw the errors mentioned above.

Tested on:

• Ubuntu 18.04 with PHP 7.2.19 (installed from the distro's official repositories)
• MacOS 10.14.6 with PHP 7.3.4 (installed with homebrew)

Search Input on Mozilla Firefox overlaps side nav

In Firefox the search input breaks out of the top menu and overlaps the side navigation. This prevents access from the side nav's top most link and suggest edit action within the package documentation.

Here is a screenshot with the broken element.

Here is a screenshot with the element working as intended in Chromium (https://www.chromium.org/).

---

OS: Ubuntu 18.10
Mozilla Firefox: 68.0
Chromium: 75.0.3770.90

Add "edit content" button on doc pages

So people reading the docs can immediately improve articles/fix typos etc.

Domain is expired

It seems like the domain is expired at amphp.org.

Sphynx Docs?

Has the project considered Sphynx for docs? I found it super useful. It does have some learning curve but really makes fantastic docs. Fabien created a plugin for PHP code highlighting that works quite well. The Symfony docs are written using Sphynx as are the docs I wrote for LaunchKey: https://docs.launchkey.com. Not being critical or anything, just wondering. If the idea is intriguing, I could build a proof of concept.