Skip to content

Commit

Permalink
docs: 📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rguezque committed Aug 21, 2024
1 parent 68ea039 commit 032646e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,6 @@ $katya->post('/', function(Request $request, Response $response) {

$response->json($data);
});

$katya->any('/hello', function(Request $request, Response $response) {
$response->send('Hello world!');
});
```

### Controllers
Expand Down Expand Up @@ -201,12 +197,12 @@ $katya->group('/foo', function(Group $group) {

## Wildcards

Los *wildcards* son parámetros definidos en la ruta. El router busca las coincidencias de acuerdo a la petición y los envía como argumentos al controlador de ruta a través del objeto `Request`, estos argumentos son recuperados con el método `Request::getParams` que devuelve un array asociativo donde cada clave se corresponde con el mismo nombre de los *wildcards*.
Los *wildcards* son parámetros definidos en la ruta. El router busca las coincidencias de acuerdo a la petición y los envía como argumentos al controlador de ruta a través del objeto `Request`, estos argumentos son recuperados con el método `Request::getParams` que devuelve un objeto `Parameters` donde cada clave se corresponde con el mismo nombre de los *wildcards*.

```php
$katya->get('/hola/{nombre}', function(Request $request, Response $response) {
$params = $request->getParams();
$response->send(sprintf('Hola %s', $params['nombre']));
$response->send(sprintf('Hola %s', $params->get('nombre')));
});
```

Expand All @@ -228,8 +224,8 @@ $katya->get('/hola/(\w+)/(\w+)', function(Request $request, Response $response)
Las vistas son el medio por el cual el router devuelve y renderiza un objeto `Response` con contenido HTML en el navegador. La única configuración que se necesita es definir el directorio donde estarán alojadas las plantillas.

```php
use rguezque\Forge\Router\View;
vistas
use rguezque\View;

$view = new View(
__DIR__.'/mis_plantillas', // Directorio donde se alojan los templates
);
Expand Down Expand Up @@ -627,5 +623,5 @@ $router = new Katya([

> [!NOTE]
>
> Si se define la configuración de CORS desde el constructor, está de más volver a configurarlo con `Katya::cors` pues ya no tendrá efecto.
> Si se define la configuración de CORS desde el constructor, no es necesario volver a configurarlo con `Katya::cors` pues no tendrá efecto este último.
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "rguezque/katya-router",
"version": "1.1.0",
"description": "A lightweight PHP router.",
"keywords": ["router", "routing", "mvc", "microframework", "php"],
"type": "router",
Expand Down

0 comments on commit 032646e

Please sign in to comment.