cmercado93/laravel-simple-sitemap

1.0.0 2024-04-02 14:14 UTC

Requires

• php: >=7.1|>=8
• illuminate/http: ^5.8|^6|^7|^8|^9|^10|^11
• illuminate/routing: ^5.8|^6|^7|^8|^9|^10|^11
• illuminate/support: ^5.8|^6|^7|^8|^9|^10|^11

Requires (Dev)

• php: >=7.1|>=8
• orchestra/testbench: ^3|^4|^5|^6|^7|^8|^9
• phpunit/phpunit: ^7.5|^8.5|^9.6

MIT

• Carlos Mercado

README

Esta librería simplifica la creación de un archivo sitemap.xml utilizando directamente los datos proporcionados en la definición de las rutas.

Fue probado en Laravel 5.8, 6.x, 7.x, 8.x, 9.x, 10.x, 11.x

Instalación:

Instala la librería mediante Composer:

composer require cmercado93/laravel-simple-sitemap

Forma de uso

Para usarlo simplemente hay que agregar el método sitemap a la definición de la ruta.

/routes/web.php

<?php

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\TestController;
use Cmercado93\LaravelSimpleSitemap\Common\Frequency;

Route::get('/', function () {
    return view('welcome');
})
    ->sitemap([
        'priority' => 1,
        'frequency' => Frequency::WEEKLY,
        'last_update' => '2024-01-01',
    ]);

Route::get('/test', [TestController::class, 'test'])
    ->sitemap()
    ->name('test');

Resultado del ejemplo anterior

El sitemap se mostrara al ingresar a la URL http://mi.sitio/sitemap.xml Cada una de las entradas del sitemap.xml estan ordenadas por su prioridad, de mayor a menor.

<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>http://mi.sitio/</loc>
    <lastmod>2024-01-01T00:00:00+00:00</lastmod>
    <changefreq>weekly</changefreq>
    <priority>1.0</priority>
  </url>
  <url>
    <loc>http://mi.sitio/test</loc>
  </url>
</urlset>

Definición del Método sitemap

El método sitemap facilita la inclusión de una entrada en el archivo de salida /sitemap.xml. Puede ser utilizado con o sin argumento, siendo el argumento principal un arreglo con varias propiedades:

• priority (opcional):

  • Definición: Prioridad asignada a la URL en el sitemap.
  • Tipo: Valor flotante entre 0 y 1.

• frequency (opcional):

  • Definición: Frecuencia de actualizaciones que recibe la URL.
  • Referencia: Constantes de la clase Cmercado93\LaravelSimpleSitemap\Common\Frequency.

• last_update (opcional):

  • Definición: Fecha de la última modificación de la ruta.
  • Tipo: Cadena de texto con formato Y-m-d u objeto que implemente la interfaz \DateTimeInterface.

• parameters (opcional):

  • Descripción: Permite especificar los parámetros necesarios para construir la URL de la ruta en el sitemap.xml. Además, podes incluir parámetros extra para la query de la URL.
  • Tipo: Arreglo asociativo.
  • Ejemplo: ['param1' => 'value1', 'param2' => 'value2', 'extra_param' => 'extra_value'].

En caso de que alguno de los datos ingresados no sea valido se lanzara una excepción Cmercado93\LaravelSimpleSitemap\Common\SitemapException.

Licencia

Distribuido bajo la licencia MIT. Vea LICENSE.md para más información.