Skip to content

Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️

4.5 KB
Raw Blame
<?php

declare(strict_types=1);

namespace HiEvents\Services\Domain\Sitemap;

use Carbon\Carbon;
use HiEvents\DomainObjects\EventDomainObject;
use HiEvents\DomainObjects\OrganizerDomainObject;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use XMLWriter;

class SitemapGeneratorService
{
    private const SITEMAP_NAMESPACE = 'http://www.sitemaps.org/schemas/sitemap/0.9';

    private const XML_VERSION = '1.0';

    private const XML_ENCODING = 'UTF-8';

    private const INDENT_STRING = '  ';

    private const DEFAULT_EVENT_SLUG = 'event';

    private const DEFAULT_ORGANIZER_SLUG = 'organizer';

    private const EVENT_URL_PATTERN = '/event/%d/%s';

    private const ORGANIZER_URL_PATTERN = '/events/%d/%s';

    private const SITEMAP_EVENTS_URL_PATTERN = '/sitemap-events-%d.xml';

    private const SITEMAP_ORGANIZERS_URL_PATTERN = '/sitemap-organizers-%d.xml';

    public function generateSitemapIndex(
        int $totalEventPages,
        int $totalOrganizerPages,
        string $baseUrl,
        string $lastMod,
    ): string {
        $writer = $this->createXmlWriter();

        $writer->startDocument(self::XML_VERSION, self::XML_ENCODING);
        $writer->startElement('sitemapindex');
        $writer->writeAttribute('xmlns', self::SITEMAP_NAMESPACE);

        for ($page = 1; $page <= $totalEventPages; $page++) {
            $this->writeSitemapEntry($writer, $baseUrl.sprintf(self::SITEMAP_EVENTS_URL_PATTERN, $page), $lastMod);
        }

        for ($page = 1; $page <= $totalOrganizerPages; $page++) {
            $this->writeSitemapEntry($writer, $baseUrl.sprintf(self::SITEMAP_ORGANIZERS_URL_PATTERN, $page), $lastMod);
        }

        $writer->endElement();
        $writer->endDocument();

        return $writer->outputMemory();
    }

    private function writeSitemapEntry(XMLWriter $writer, string $loc, string $lastMod): void
    {
        $writer->startElement('sitemap');
        $writer->writeElement('loc', $loc);
        $writer->writeElement('lastmod', $lastMod);
        $writer->endElement();
    }

    /**
     * @param  Collection<int, EventDomainObject>  $events
     */
    public function generateEventsSitemap(Collection $events, string $baseUrl): string
    {
        $writer = $this->createXmlWriter();

        $writer->startDocument(self::XML_VERSION, self::XML_ENCODING);
        $writer->startElement('urlset');
        $writer->writeAttribute('xmlns', self::SITEMAP_NAMESPACE);

        foreach ($events as $event) {
            $this->writeEventUrl($writer, $event, $baseUrl);
        }

        $writer->endElement();
        $writer->endDocument();

        return $writer->outputMemory();
    }

    private function createXmlWriter(): XMLWriter
    {
        $writer = new XMLWriter;
        $writer->openMemory();
        $writer->setIndent(true);
        $writer->setIndentString(self::INDENT_STRING);

        return $writer;
    }

    private function writeEventUrl(XMLWriter $writer, EventDomainObject $event, string $baseUrl): void
    {
        $slug = Str::slug($event->getTitle()) ?: self::DEFAULT_EVENT_SLUG;
        $eventUrl = $baseUrl.sprintf(self::EVENT_URL_PATTERN, $event->getId(), $slug);

        $this->writeUrlEntry($writer, $eventUrl, $event->getUpdatedAt());
    }

    /**
     * @param  Collection<int, OrganizerDomainObject>  $organizers
     */
    public function generateOrganizersSitemap(Collection $organizers, string $baseUrl): string
    {
        $writer = $this->createXmlWriter();

        $writer->startDocument(self::XML_VERSION, self::XML_ENCODING);
        $writer->startElement('urlset');
        $writer->writeAttribute('xmlns', self::SITEMAP_NAMESPACE);

        foreach ($organizers as $organizer) {
            $this->writeOrganizerUrl($writer, $organizer, $baseUrl);
        }

        $writer->endElement();
        $writer->endDocument();

        return $writer->outputMemory();
    }

    private function writeOrganizerUrl(XMLWriter $writer, OrganizerDomainObject $organizer, string $baseUrl): void
    {
        $slug = Str::slug($organizer->getName()) ?: self::DEFAULT_ORGANIZER_SLUG;
        $organizerUrl = $baseUrl.sprintf(self::ORGANIZER_URL_PATTERN, $organizer->getId(), $slug);

        $this->writeUrlEntry($writer, $organizerUrl, $organizer->getUpdatedAt());
    }

    private function writeUrlEntry(XMLWriter $writer, string $loc, string $updatedAt): void
    {
        $writer->startElement('url');
        $writer->writeElement('loc', $loc);
        $writer->writeElement('lastmod', Carbon::parse($updatedAt)->toAtomString());
        $writer->endElement();
    }
}