Routing in Tina4

Please see the How Do I - Beginner section for more basics on Routes.

The simple syntax of a Route is as follows

<?php

\Tina4\Method::add(string $routePath, $function)

So the Route to capture the URL https://mywebsite.com/starthere would be as below. This uses a Get method, with a simple closure function, with the return using the Response object.

<?php

\Tina4\Get::add("/starthere", function(\Tina4\Response $response, \Tina4\Request $request) {
  // Put all the code that you want to here
  return $response("Hello Mars", HTTP_OK, TEXT_HTML);
});

There are a number of routing options in Tina4, they are based around the common API routing methods.

• GET - TINA4_GET
• POST - TINA4_POST
• PATCH - TINA4_PATCH
• DELETE - TINA4_DELETE
• PUT - TINA4_PUT

A further route is introduced which encapsulates all the above routes and intercepts all the different options

• ANY. - TINA4_ANY

<?php

Get::add("/starthere", $function) //--> this will retrieve data sent back and forth between your device and servers
||
Post::add("/starthere", $function) //--> this secures the retrieved data sent back and forth between your device and servers

Variables can be included in three different ways.

Variables can be included as part of the actual URL path and passed to the front of the closure function.

mywebsite.com/starthere/3 will return 3

<?php

\Tina4\Get::add("/starthere/{variable1}", function($variable1, \Tina4\Response $response, \Tina4\Request $request) {
  // Use the variables in your code or as the response
  return $response($variable1, HTTP_OK, TEXT_HTML);
});

mywebsite.com/starthere/3/nextlevel/5 will return 15

<?php

\Tina4\Get::add("/starthere/{variable1}/nextlevel/{variable2}",
function($variable1, $variable2, \Tina4\Response $response, \Tina4\Request $request)) {
  // Use the variables in your code or as the response
  $product = $variable1 * $variable2;
  return $response($product, HTTP_OK, TEXT_HTML);
});
 

Variables can also be included as query parameters in the url. The Request object packages these up into the params array. So mywebsite.com/starthere?variable1=3&variable2=5 will return 15

<?php

\Tina4\Get::add("/starthere", function(\Tina4\Response $response, \Tina4\Request $request) {
  // Variables are available from the params array
  $variable1 = $request->params["variable1"];
  $variable2 = $request->params["variable2"];

  $product = $variable1 * $variable2;
  return $response($product, HTTP_OK, TEXT_HTML);
});
 

Data posted from a form to a Post Route can be accessed from the Request data object. So a form submitted with two fields of a person's name “Joe” “Smith” will return “Hello Joe Smith”

<?php

\Tina4\Post::add("/endhere", function(\Tina4\Response $response, \Tina4\Request $request) {
  // Variables are available from the params array
  $firstName = $request->data->firstName;
  $lastName = $request->data->lastName;

  $message = "Hello ". $firstName . " ". $lastName;
  return $response($message, HTTP_OK, TEXT_HTML);
});

Tina4 makes use of phpDoc blocks through the Annotation class. This in combination with the Auth class allows us to secure routes with a single line of code. The @secure enables the Tina4\Auth class, which will now require at least a formToken, or can even make use of custom Bearer tokens.

<?php

/**
* @secure
**/
\Tina4\Get::add("/starthere", function(\Tina4\Response $response, \Tina4\Request $request) {
  // Put all the code that you want to here
  return $response("Hello Mars", HTTP_OK, TEXT_HTML);
});

The response object is an integral part of a Route. The Route object takes three parameters. Basic syntax is $response($content, $httpCode, $contentType).

The return from the Response object will always be a string, if the $content is an array or object it will be converted to a JSON or XML response.

The httpCode is a standard HTTP Response Status Code.

The contentType is a standard HTTP Mime Type, indicating what kind of content you are returning.

The basic syntax for Ruth Routes bear much resemblance to current Tina Routes.

<?php

Ruth::addRoute(TINA4_GET, "/hello/world", function(){
  echo "Hello World!";
});

And also includes Path variables

<?php

Ruth::addRoute(TINA4_GET, "/content/{name}", function($name){
  echo "OK {$name}!";
});

Ruth can also be used much like Tina, taking advantage of the Request and Response objects

<?php

Ruth::get("/hello/world", function(\Tina4\Response $response, \Tina4\Request $request) {
   return $response ("Hello World!", HTTP_OK, TEXT_HTML);
});

Ruth::get("/hello/{name}", function($name, \Tina4\Response $response, \Tina4\Request $request) {
   return $response ("Hello {$name}!", HTTP_OK, TEXT_HTML);
});