Phico is a work in progress

Phico is currently a work in progress, errors, omissions and changes are to be expected.

Request

Request standardises CGI and Workerman requests in a consistent API. The current Request instance will be passed as the first argument to your Action or Controller classes.

NOTE: Requests are essentially immutable, where they return Capsule instances these will be readonly. The only properties that can be set on a Request is via the attr() method.

Request

methodIs

Checks the current Request method against the passed argument. Returns true on a match, false otherwise.

$request->methodIs('get'); // true/false
// the argument is case insensitive

isAjax / isXhr

Returns true if the X-Requested-With header is present.

$request->isAjax(); // true/false
$request->isXhr(); // true/false

Accepts

Provides access to the accepts headers. With no arguments it will return all the accepts headers.

$request->accepts();
// returns an array of accepts headers

If the first argument is provided then any matching headers are returned.

$request->accepts("language");
// returns the accepts-language header content

// use 'media' to scan the media types header
$request->accepts("media");
// returns the media type, e.g. */*, text/html, application/json ...

If the first and second arguments are provided then bool true is returned if a match is found, false if no match is found.

$request->accepts("charset", "utf-8");
// returns true if accepts-charset header content is utf-8

// use 'media' to scan the media types header
$request->accepts("media", "application/json");
// returns true if the accepts media type is application/json

Use the Request attributes to attach context to the request. This is most useful when attaching behaviours through middleware. For example, the LocaleMiddleware will attach a Translation object configured for the current users locale. Or the SessionMiddleware will attach a Session object to the Request representing the current users Session.

Attr

Get or set a Request attribute.

// set a request attribute
$request->attr("locale" "en-GB");
...
// get a request attribute
$locale = $request->attr("locale");

Attrs

Returns a map of defined Request attributes.

foreach ($attrs as $k => $v) {
    echo "Got request attribute $k";
}

Cookies

The cookies() method returns a list of Request Cookies.

foreach ($request->cookies as $cookie) {
    // cookie is a string
    ...
}

Headers

The headers() method returns a list of HTTP headers.

foreach ($request-->headers() as $header => $content) {
    ...
}

First

Returns the first header value if value is an array, or the only value if a single header was sent.

$lang = $request-->headers()->first("accept-language");
// en-GB, en;q=0.9, en-US;q=0.8, pt;q=0.7, *;q=0.5

Sort

Returns an array in order of request preference, useful for accept headers

$lang = $request-->headers()->sort("accept-language");
// en-GB

Input

Returns a new immutable Capsule instance containing the request body. The has(), get(), only(), except() and all() methods can be used on the returned object.

$input = $request->input();
$input->has("agreed_terms") {
    process($input->except("agreed_terms"));
}

Method

Returns the http request method, GET, POST etc.. NOTE Phico does not support custom request methods.

$method = $request->method();

Route

The matched Route instance is attached to the Request and can be accessed using the route() method on the Request_ instance.

$route = $request->route();

The Route class has the following methods:

Params

Returns a Capsule containing the route parameters.

// example route definition
$routes->get("/blog[/{year}[/{month}]]", Blog\Browse::class);
...
// in your code
$params = $route()->params();
echo "Results for {$params->year} during {$params->month}";

Param

Returns a single parameter or a default.

// example route definition
$routes->get("/blog[/{year}[/{month}]]", Blog\Browse::class);
...
// in your code
$params = $route->params();
if ($params->year and $params->month) {
    // filter by year and month
} elseif ($params->year) {
    // filter by year
} else {
    // no filter
}

Name

Returns the name of the Route.

$route->name(); // home

PathFor

Returns the path to the route, any required placeholders must be provided.

// route definition
$routes->get("/blog[/{year}[/{month}]]", Blog\Browse::class)->name("blog.browse");

// returns /blog
$route->pathFor("blog.browse", []);

// returns /blog/2024
$route->pathFor("blog.browse", ["year" => 2024]);

// returns /blog/2024/dec
$route->pathFor("blog.browse", [
    "year" => 2024,
    "month" => "dec"
]);

$uri = $request->uri();

The URI object has the following methods.