README

A PHP package for working with map geometries (Markers, Polylines, Polygons, etc.) with full Livewire support.

Features

• 🎯 Marker Support: Create and manage map markers
• 🔄 Livewire Integration: Full Wireable support for real-time updates
• 📦 Collections: Powerful MarkerCollection with Iterator, Countable, ArrayAccess
• 🎨 Fluent API: Chainable methods for clean, readable code
• ✅ Well Tested: Comprehensive test suite with 36+ tests
• 📚 Fully Documented: Complete PHPDoc and usage examples

Requirements

• PHP 8.1 or higher
• Composer

Installation

composer require lbcdev/map-geometries

Quick Start

Creating a Marker

use LBCDev\MapGeometries\Marker;

$marker = Marker::make(40.7128, -74.0060, 'New York City')
    ->tooltip('The Big Apple')
    ->iconColor('blue')
    ->icon('custom-icon');

Using MarkerCollection

use LBCDev\MapGeometries\MarkerCollection;

$markers = new MarkerCollection();

$markers->add(
    Marker::make(40.7128, -74.0060, 'New York')
);

$markers->add(
    Marker::make(51.5074, -0.1278, 'London')
);

// Iterate
foreach ($markers as $marker) {
    echo $marker->getLabel();
}

// Count
echo count($markers); // 2

// Access by index
$firstMarker = $markers[0];

API Documentation

Marker

Creation

Marker::make(float $latitude, float $longitude, ?string $label = null): self

Methods

MarkerCollection

Methods of MarkerCollection

Livewire Integration

Markers are fully compatible with Livewire:

use LBCDev\MapGeometries\Marker;
use Livewire\Component;

class MapComponent extends Component
{
    public Marker $marker;
    
    public function mount()
    {
        $this->marker = Marker::make(40.7128, -74.0060, 'NYC');
    }
    
    public function updateMarker()
    {
        $this->marker->iconColor('red');
    }
}

Testing

composer test

With coverage:

composer test-coverage

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email luinux81@gmail.com instead of using the issue tracker.

Credits

• Luinux81
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Related Packages

This package is part of the LBCDev Maps Suite:

• livewire-maps-core - Core Livewire map component
• filament-maps-fields - Map form fields for Filament
• filament-maps-widgets - Map widgets for Filament panels