PHP.GT

Example project

The repository includes a project under example/project/simple-site/ that shows how the pieces fit together.

It is not a full framework. Its value is that we can see the routing flow directly, without any extra abstraction.

Project structure

The example contains:

  • app-router.php for the router class
  • config.ini for router and application configuration
  • page/ for page view and page logic files
  • api/v1/ for API logic files
  • class/ for ordinary application classes

The flow

The entry script in example/01-test.php does the following:

  1. loads configuration
  2. creates a PSR-7 request
  3. creates a service container
  4. configures a PathMatcher
  5. loads the application router class
  6. handles redirects if a CSV file exists
  7. calls route()
  8. reads the resulting logic and view assemblies
  9. registers the logic stream wrapper
  10. loads each logic file and calls its go() function

That is essentially the routing part of a framework laid out in one file.

Router callbacks in the example

The router has three callbacks:

api()

#[Any(name: "api-route", accept: "application/json,application/xml")]

This callback adds matching logic files from api/v1/ to the logic assembly.

page()

#[Get(name: "page-route", accept: "text/html,application/xhtml+xml")]

This callback adds matching PHP logic files from page/ and matching HTML view files from page/.

dynamicText()

#[Post(path: "/greet/@name", function: "greet", accept: "text/plain")]

This callback is part of the example project’s layout, but it is worth noting that callback path matching in BaseRouter is currently exact. Dynamic placeholder matching in this repository is handled by the path-matching layer described in Path matching and Dynamic path mapping.

Path matching in the example

The example’s PathMatcher filter uses:

  • BasicFileMatch for direct file matches
  • MagicFileMatch for _common, _header and _footer style files

That combination is enough to build a request assembly for both nested pages and dynamic routes.

Dynamic path access

The example’s page logic reads values from DynamicPath, for example:

function go(DynamicPath $path) {
	echo "SHOP ITEM: " . $path->get("itemName"), PHP_EOL;
}

This shows how placeholder values from the route can be injected into ordinary PHP logic.

Why this matters

This example is the clearest place to see the repository’s boundary:

  • the router decides what belongs to the request
  • the assemblies record the result
  • another layer then loads the files and produces the response

That same separation is what allows WebEngine to use this library as a component.