Izartu API

Controller

in package

• Application

Route handlers for the front controller (index.php). Each handler deals with one route and returns a `[template, variables]` pair to render, or redirects and exits directly.

Table of Contents

Methods

add()  : array{0: string, 1: array}

Add bookmark (POST action): validate and create it, then return to the list the form was on. A GET redirects to the user's own page with the inline add form open (`?add`).

delete()  : array{0: string, 1: array}

Delete bookmark (POST action, the Delete button of the inline edit form), then return to the list the form was on.

edit()  : array{0: string, 1: array}

Edit bookmark (POST action): validate and save it, then return to the list the form was on. A GET redirects to the user's own page with that row's inline edit form open (`?edit=ID`).

home()  : array{0: string, 1: array}

Home page: one page of the bookmark feed (`?page=N`) and the tag cloud.

login()  : array{0: string, 1: array}

Login: show the form (GET) or process it (POST).

logout()  : never

Logout: destroy the session and redirect to the home page.

notFound()  : array{0: string, 1: array}

Not found: send a 404 status and render the not-found view.

redirect()  : never

Send a redirect to the given path and stop the request.

tag()  : array{0: string, 1: array}

Tag page: the feed filtered by tag names (`/tag/NAME` or `/tag/NAME,NAME,...`, comma-separated: bookmarks carrying ALL of them), paginated.

tagError()  : string|null

Validate a bookmark's normalised tag names.

tags()  : array{0: string, 1: array}

Tag index page (`/tags`): every visible tag with its count, paginated and alphabetical; `?q=TERM` narrows it to the matching tags. The list context travels along (`?tag=NAMES` and/or `?user=NAME`), scoping the index/search to that list, exactly like the cloud.

user()  : array{0: string, 1: array}

User page: the feed filtered by one username (`/user/USERNAME`), paginated.

validate()  : array<string, string>

Validate a bookmark's user-supplied fields.

apply()  : array<string, string>

Fill a bookmark from form input and validate it (CSRF included).

feed()  : array{0: string, 1: array}

The variables every list view shares. Inline form state comes from the query string: `?edit=ID` renders that row as an in-place edit form (the template still gates it with `Auth::canManage`) and `?add` renders an empty form on top of the list. Both are view states of the list, so they live in the query string; mutations POST to the `/add`, `/edit/ID` and `/delete/ID` action routes.

isValidLink()  : bool

Whether a string is an acceptable bookmark URL.

listFromReturn()  : array{0: string, 1: array}

Rebuild the list view the submitted form was on (see `returnPath()`), to re-render it with the inline form when validation fails.

ownPage()  : string

The logged-in user's own list page (`user/USERNAME`).

page()  : int

The requested list page number (`?page=N`, 1-based).

returnPath()  : string

The list the submitted form was on, as a safe relative path: the form's hidden `return` field, accepted only when it matches a known list route plus an optional page (never an absolute URL, so it cannot be turned into an open redirect). Falls back to the user's own page.

tagNames()  : array<int, string>

Parse a comma-separated tag list into the canonical tag-name set: a comma can never be part of a tag (it is the input separator), so the names are split on it, then trimmed, lower-cased, deduplicated and sorted.

tagRoute()  : string

The list route for a set of tag names (`tag/NAME,NAME`).