Laravel Mobile Pass

https://github.com/spatie/laravel-mobile-pass
Admin
A Laravel package that enables developers to generate and manage mobile passes for Apple Wallet,...
Tokens:19,308
Snippets:292
Trust Score:10
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Base64 encode certificate

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/getting-credentials-from-apple.md

Example of how to base64 encode the .p12 certificate file.

```bash
base64 -i path/to/certificate.p12 | pbcopy
```

--------------------------------

### Publish the configuration file

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/installation-setup.md

This command publishes the `laravel-mobile-pass` configuration file to your project, allowing for customization.

```bash
php artisan vendor:publish --tag="mobile-pass-config"
```

--------------------------------

### Google Offer Pass Example (Class and Object)

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/coupon.md

Example of how to create an offer pass for Google Pay, first declaring the class and then creating an object per redeemer.

```php
use Spatie\LaravelMobilePass\Builders\Google\OfferPassBuilder;
use Spatie\LaravelMobilePass\Builders\Google\OfferPassClass;

// Once, per offer
OfferPassClass::make('summer-2026-20off')
    ->setIssuerName('Spatie Store')
    ->setTitle('Save 20% this summer')
    ->setProvider('Spatie')
    ->setRedemptionChannel('ONLINE')
    ->setFinePrint('One use per customer. Expires 2026-08-31.')
    ->setLogoUrl('https://cdn.example.com/spatie-logo.png')
    ->save();

// Per redeemer
OfferPassBuilder::make()
    ->setClass('summer-2026-20off')
    ->setTitle('20% off for Dan')
    ->setRedemptionCode('DAN20SUMMER')
    ->save();
```

--------------------------------

### Publish and run migrations

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/installation-setup.md

These commands publish the package's migrations and then run them to create the necessary database tables.

```bash
php artisan vendor:publish --tag="mobile-pass-migrations"
php artisan migrate
```

--------------------------------

### Install the package via Composer

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/installation-setup.md

This command pulls the latest version of the spatie/laravel-mobile-pass package into your project.

```bash
composer require spatie/laravel-mobile-pass
```

--------------------------------

### Apple Loyalty Card Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/loyalty.md

Example of how to create a loyalty card for Apple Wallet using the StoreCardPassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\StoreCardPassBuilder;

StoreCardPassBuilder::make()
    ->setOrganizationName('Spatie Rewards')
    ->setSerialNumber('CARD-USER-7842')
    ->setDescription('Spatie Rewards member card')
    ->addField('balance', '1,250', label: 'Points')
    ->addSecondaryField('member', 'Ringo Starr')
    ->addSecondaryField('tier', 'Gold')
    ->save();
```

--------------------------------

### Getting the Add to Wallet URL for Apple Passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/testing-your-passes.md

Example of logging the URL to add an Apple pass to the wallet, for manual verification.

```php
logger()->info($mobilePass->addToWalletUrl());
```

--------------------------------

### Apple Coupon Pass Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/coupon.md

Example of how to create a coupon pass for Apple Wallet using CouponPassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\CouponPassBuilder;

CouponPassBuilder::make()
    ->setOrganizationName('Spatie Store')
    ->setSerialNumber('COUPON-SUMMER25')
    ->setDescription('20% off everything this summer')
    ->addField('offer', '20%', label: 'Save')
    ->addSecondaryField('expires', '2026-08-31')
    ->save();
```

--------------------------------

### Use a local file path for an image

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/hosting-images.md

Example of how to create an Image object from a local file path.

```php
use Spatie\LaravelMobilePass\Builders\Google\Entities\Image;

$image = Image::fromLocalPath(public_path('images/ticket-hero.png'));
```

--------------------------------

### Google Loyalty Card Class and Object Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/loyalty.md

Example of how to declare a loyalty card class and then create individual loyalty pass objects for Google Pay.

```php
use Spatie\LaravelMobilePass\Builders\Google\LoyaltyPassBuilder;
use Spatie\LaravelMobilePass\Builders\Google\LoyaltyPassClass;

// Once, per program
LoyaltyPassClass::make('spatie-rewards')
    ->setIssuerName('Spatie')
    ->setProgramName('Spatie Rewards')
    ->setProgramLogoUrl('https://cdn.example.com/spatie-logo.png')
    ->setAccountNameLabel('Member')
    ->setAccountIdLabel('Member ID')
    ->setBackgroundColor('#1d72b8')
    ->save();

// Per member
LoyaltyPassBuilder::make()
    ->setClass('spatie-rewards')
    ->setAccountId('USER-7842')
    ->setAccountName('Ringo Starr')
    ->setBalanceString('1,250 points')
    ->save();
```

--------------------------------

### Environment variables for issuer ID and key path

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/getting-credentials-from-google.md

Set the issuer ID and point the package at the service account key file.

```bash
MOBILE_PASS_GOOGLE_ISSUER_ID=3388000000022000000
MOBILE_PASS_GOOGLE_KEY_PATH=/absolute/path/to/service-account.json
```

--------------------------------

### Registering Mobile Pass Routes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/installation-setup.md

This code snippet shows how to register the necessary routes for Apple to communicate with your application for device registration and error logging.

```php
// in your routes file
Route::mobilePass();
```

--------------------------------

### Registering custom action in config

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/customizing-actions.md

Example of how to register a custom action in the mobile-pass config file.

```php
// config/mobile-pass.php

return [
    // other keys

    'actions' => [
        // other actions
    
        'notify_apple_of_pass_update' => \App\Actions\CustomNotifyAppleOfPassUpdateAction::class,
    ],
];
```

--------------------------------

### Setting pass relevance with Wi-Fi credentials

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Example showing how to combine pass relevance settings (location and date) with Wi-Fi credentials for contextual display.

```php
use Illuminate\Support\Carbon;

$builder
    ->addLocation(
        latitude: 40.7559,
        longitude: -73.8456,
        relevantText: 'Welcome to Shea Stadium',
    )
    ->setRelevantDate(Carbon::parse('1965-08-15 19:00'))
    ->addWifiNetwork('SheaStadium-Guest', 'welcome1965');
```

--------------------------------

### Configuring a hidden SSID and custom alt text for Wi-Fi QR code

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Example of setting a hidden SSID and custom alternative text for the Wi-Fi QR code.

```php
$builder->setWifiBarcode(
    ssid: 'Spatie Guest',
    password: 'welcome',
    hidden: true,
    altText: 'Scan to join',
);
```

--------------------------------

### Encoding Wi-Fi credentials in a QR code

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Example of using `setWifiBarcode` to encode Wi-Fi credentials into a QR code for a generic pass.

```php
use Spatie\LaravelMobilePass\Builders\Apple\GenericPassBuilder;

GenericPassBuilder::make()
    ->setOrganizationName('Spatie')
    ->setDescription('Guest Wi-Fi')
    ->addField('ssid', 'Spatie Guest', label: 'Network')
    ->addSecondaryField('password', 'welcome', label: 'Password')
    ->setWifiBarcode('Spatie Guest', 'welcome')
    ->save();
```

--------------------------------

### Google Boarding Pass Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/boarding-pass.md

Example of creating a boarding pass class and then individual boarding pass objects for Google Pay.

```php
use Spatie\LaravelMobilePass\Builders\Google\BoardingPassBuilder;
use Spatie\LaravelMobilePass\Builders\Google\BoardingPassClass;

// Once, per flight
BoardingPassClass::make('lh123-2026-04-20')
    ->setIssuerName('Lufthansa')
    ->setAirlineCode('LH')
    ->setFlightNumber('LH123')
    ->setOriginAirportCode('FRA')
    ->setDestinationAirportCode('JFK')
    ->setLocalScheduledDepartureDateTime(Carbon::parse('2026-04-20 14:30'))
    ->setLogoUrl('https://cdn.example.com/lh-logo.png')
    ->save();

// Per passenger
BoardingPassBuilder::make()
    ->setClass('lh123-2026-04-20')
    ->setPassengerName('Paul McCartney')
    ->setSeatNumber('12A')
    ->setConfirmationCode('ABC123')
    ->save();
```

--------------------------------

### MobilePassAdded Event Listener

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Example listener for the MobilePassAdded event to track when a user installs a pass.

```php
namespace App\Listeners;

use Spatie\LaravelMobilePass\Events\MobilePassAdded;

class TrackPassInstalls
{
    public function handle(MobilePassAdded $event): void
    {
        $event->mobilePass->user->update([
            'wallet_pass_installed_at' => now(),
        ]);
    }
}
```

--------------------------------

### Listing All Classes of a Type

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/pass-classes.md

Example of how to retrieve all pass classes of a specific type associated with the issuer account.

```php
$classes = EventTicketPassClass::all();
```

--------------------------------

### Return MobilePass model from controller

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/generating-your-first-pass.md

Example of returning the MobilePass model from a controller to serve the signed .pkpass file to the user.

```php
// in a controller
return $mobilePass;
```

--------------------------------

### Retiring a Class

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/pass-classes.md

Example of how to retire a pass class, which marks it as rejected on Google's servers.

```php
EventTicketPassClass::find('beatles-shea-1965')?->retire();
```

--------------------------------

### Adding a Wi-Fi network using `addWifiNetwork`

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Example of how to add a Wi-Fi network with SSID and password to an event ticket pass using the `addWifiNetwork` method.

```php
use Spatie\LaravelMobilePass\Builders\Apple\EventTicketPassBuilder;

EventTicketPassBuilder::make()
    ->setOrganizationName('Fab Four Promotions')
    ->setSerialNumber('BTL-SHEA-0042')
    ->setDescription('The Beatles at Shea Stadium')
    ->addWifiNetwork('SheaStadium-Guest', 'welcome1965')
    ->save();
```

--------------------------------

### Environment variable for inline key contents

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/getting-credentials-from-google.md

Inline the service account key contents directly into the environment variable.

```bash
MOBILE_PASS_GOOGLE_KEY='{"type":"service_account",...}'
```

--------------------------------

### Environment variable with base64 encoded key

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/getting-credentials-from-google.md

Store the base64 encoded service account key in the environment variable.

```bash
MOBILE_PASS_GOOGLE_KEY=ewogICJ0eXBlIjogInNlcnZpY2VfYWNjb3VudCIsCi...
```

--------------------------------

### Fetching a Class by Suffix

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/pass-classes.md

Example of how to find a previously declared pass class using its unique suffix.

```php
$class = EventTicketPassClass::find('beatles-shea-1965');

if ($class) {
    // class exists on Google
}
```

--------------------------------

### Apple Generic Pass Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/generic.md

Example of how to create a generic pass for Apple Wallet using the GenericPassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\GenericPassBuilder;

GenericPassBuilder::make()
    ->setOrganizationName('Spatie Conference')
    ->setSerialNumber('BADGE-042')
    ->setDescription('Conference attendee badge')
    ->addField('name', 'Ringo Starr')
    ->addSecondaryField('track', 'All-access')
    ->save();
```

--------------------------------

### Setting the Class for a Google Pass Object

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/object-methods.md

Example of creating an EventTicketPassBuilder and setting the class, attendee name, section, row, and seat.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassBuilder;

EventTicketPassBuilder::make()
    ->setClass('beatles-shea-1965')
    ->setAttendeeName('John Lennon')
    ->setSection('Floor A')
    ->setRow('12')
    ->setSeat('24')
    ->save();
```

--------------------------------

### Apple Airline Pass Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/boarding-pass.md

Example of creating an airline boarding pass for Apple Wallet using AirlinePassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\AirlinePassBuilder;
use Spatie\LaravelMobilePass\Builders\Apple\Entities\Seat;

AirlinePassBuilder::make()
    ->setOrganizationName('Etihad')
    ->setSerialNumber('TICKET-123')
    ->setDescription('Etihad flight EY066 boarding pass')
    ->setDepartureAirportCode('AUH')
    ->setDestinationAirportCode('LHR')
    ->setPassengerName('Paul McCartney')
    ->setSeats(Seat::make(number: '12A'))
    ->addField('departure', 'AUH', label: 'Abu Dhabi')
    ->addField('destination', 'LHR', label: 'London')
    ->save();
```

--------------------------------

### Apple Custom Transit Pass Example

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/boarding-pass.md

Example of creating a custom transit boarding pass (e.g., train) for Apple Wallet by subclassing BoardingPassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\BoardingPassBuilder;
use Spatie\LaravelMobilePass\Enums\TransitType;

class TrainPassBuilder extends BoardingPassBuilder
{
    protected ?TransitType $transitType = TransitType::Train;
}

TrainPassBuilder::make()
    ->setOrganizationName('SNCB')
    ->setSerialNumber('TICKET-456')
    ->setDescription('Brussels to Antwerp, coach 3')
    ->setPassengerName(PersonName::make(givenName: 'George', familyName: 'Harrison'))
    ->setSeats(Seat::make(number: '24B'))
    ->addField('departure', 'BRU', label: 'Brussels-Central')
    ->addField('destination', 'ANT', label: 'Antwerp-Central')
    ->save();
```

--------------------------------

### Queueing updates in tests

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/testing-your-passes.md

This example shows how to use `Queue::fake()` to prevent actual update pushes during tests and assert that the `PushPassUpdateJob` is queued.

```php
use Illuminate\Support\Facades\Queue;
use Spatie\LaravelMobilePass\Jobs\PushPassUpdateJob;

Queue::fake();

$mobilePass->update(['content' => [...]]);

Queue::assertPushed(PushPassUpdateJob::class);
```

--------------------------------

### Custom NotifyAppleOfPassUpdateAction

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/customizing-actions.md

Example of extending the default NotifyAppleOfPassUpdateAction to add custom logic before notifying Apple.

```php
namespace App\Actions;

use Spatie\LaravelMobilePass\Actions\Apple\NotifyAppleOfPassUpdateAction;
use Spatie\LaravelMobilePass\Models\MobilePass;

class CustomNotifyAppleOfPassUpdateAction extends NotifyAppleOfPassUpdateAction
{
    public function execute(MobilePass $mobilePass)
    {
        // Your custom code here

        parent::execute($mobilePass);
    }
}
```

--------------------------------

### Base64 encoding service account key

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/getting-credentials-from-google.md

Base64 encode the service account key file and store it in the environment variable.

```bash
base64 -i path/to/service-account.json | pbcopy
```

--------------------------------

### Class and object round-trip testing

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/testing-your-passes.md

This example demonstrates how to use the `find()` method to retrieve a pass class and assert its properties, catching schema-level mistakes without a device.

```php
$class = EventTicketPassClass::find('beatles-shea-1965');
expect($class->getEventName())->toBe('The Beatles | Live at Shea');
```

--------------------------------

### Google Generic Pass Example (Class and Object)

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/generic.md

Example of how to create a generic pass for Google Wallet, first declaring the class and then creating an object per person.

```php
use Spatie\LaravelMobilePass\Builders\Google\GenericPassBuilder;
use Spatie\LaravelMobilePass\Builders\Google\GenericPassClass;

// Once, per use case
GenericPassClass::make('spatie-conference-badge')
    ->setIssuerName('Spatie Conference')
    ->setCardTitle('Spatie Conference 2026')
    ->setSubheader('Attendee badge')
    ->setLogoUrl('https://cdn.example.com/conf-logo.png')
    ->save();

// Per attendee
GenericPassBuilder::make()
    ->setClass('spatie-conference-badge')
    ->setHeader('Ringo Starr')
    ->setCardTitle('All-access badge')
    ->setSubheader('Speaker')
    ->save();
```

--------------------------------

### Google Event Ticket Pass with Barcode

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-barcodes.md

Example of creating a Google Event Ticket Pass and setting a QR code barcode.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassBuilder;
use Spatie\LaravelMobilePass\Enums\BarcodeType;

EventTicketPassBuilder::make()
    ->setClass('beatles-shea-1965')
    ->setBarcode(BarcodeType::Qr, 'TICKET-12345')
    ->save();
```

--------------------------------

### User model with HasMobilePasses trait

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/generating-your-first-pass.md

Example of how to add the HasMobilePasses trait to your User model to associate passes with users.

```php
use Spatie\LaravelMobilePass\Models\Concerns\HasMobilePasses;

class User extends Model
{
    use HasMobilePasses;
}
```

--------------------------------

### Apple Wallet Event Ticket Pass Builder

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/generating-your-first-pass.md

Example of building an Apple Wallet event ticket pass with custom fields.

```php
use Spatie\LaravelMobilePass\Builders\Apple\EventTicketPassBuilder;

$mobilePass = EventTicketPassBuilder::make()
    ->setOrganizationName('Fab Four Promotions')
    ->setSerialNumber('BTL-SHEA-0042')
    ->setDescription('The Beatles at Shea Stadium')
    ->addField('event', 'Beatles Live at Shea')
    ->addField('attendee', 'John Lennon', label: 'Name')
    ->addField('seat', 'Floor A, Row 12')
    ->save();
```

--------------------------------

### Apple Event Ticket Pass

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/event-ticket.md

Example of creating an event ticket pass for Apple Wallet using the EventTicketPassBuilder.

```php
use Spatie\LaravelMobilePass\Builders\Apple\EventTicketPassBuilder;

EventTicketPassBuilder::make()
    ->setOrganizationName('Fab Four Promotions')
    ->setSerialNumber('BTL-SHEA-0042')
    ->setDescription('The Beatles at Shea Stadium')
    ->addField('event', 'Beatles Live at Shea')
    ->addSecondaryField('section', 'B12')
    ->addSecondaryField('seat', 'Row 8, Seat 22')
    ->save();
```

--------------------------------

### Google Wallet Event Ticket Pass Builder

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/generating-your-first-pass.md

Example of building a Google Wallet event ticket pass with class, attendee details, and barcode.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassBuilder;
use Spatie\LaravelMobilePass\Enums\BarcodeType;

$mobilePass = EventTicketPassBuilder::make()
    ->setClass('beatles-shea-1965')
    ->setAttendeeName('John Lennon')
    ->setSection('Floor A')
    ->setRow('12')
    ->setSeat('24')
    ->setBarcode(BarcodeType::Qr, 'TICKET-12345')
    ->save();
```

--------------------------------

### Declaring an Event Ticket Pass Class

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/pass-classes.md

Example of how to declare a new event ticket pass class with various fields.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassClass;

EventTicketPassClass::make('beatles-shea-1965')
    ->setIssuerName('Fab Four Promotions')
    ->setEventName('The Beatles | Live at Shea')
    ->setVenueName('Shea Stadium')
    ->setVenueAddress('126th Street & Roosevelt Avenue, Flushing, NY')
    ->setStartDate(Carbon::parse('1965-08-15 20:00'))
    ->setLogoUrl('https://example.com/beatles-logo.png')
    ->setHeroImageUrl('https://example.com/beatles-hero.png')
    ->setBackgroundColor('#1a1a1a')
    ->save();
```

--------------------------------

### Apple Event Ticket Pass with Barcode

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-barcodes.md

Example of creating an Apple Event Ticket Pass and setting a QR code barcode.

```php
use Spatie\LaravelMobilePass\Builders\Apple\EventTicketPassBuilder;
use Spatie\LaravelMobilePass\Enums\BarcodeType;

EventTicketPassBuilder::make()
    ->setOrganizationName('Fab Four Promotions')
    ->setSerialNumber('BTL-SHEA-0042')
    ->setDescription('The Beatles at Shea Stadium')
    ->setBarcode(BarcodeType::Qr, 'TICKET-12345')
    ->save();
```

--------------------------------

### Update multiple fields at once for Apple passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/updating-a-pass.md

This example shows how to update multiple fields simultaneously using the builder pattern before saving.

```php
$mobilePass->builder()
    ->updateField('seat', '13A')
    ->updateField('gate', 'D68')
    ->save();
```

--------------------------------

### Mocking Google Pass Requests

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/testing-your-passes.md

Example of how to fake requests to Google's Wallet API and assert on outgoing payloads, including priming the access token cache.

```php
use Illuminate\Support\Facades\Http;

Http::fake();
cache()->put('mobile-pass.google.access-token', 'test-token', 3600);

$mobilePass = EventTicketPassBuilder::make()
    ->setClass('beatles-shea-1965')
    ->setAttendeeName('Test User')
    ->save();

Http::assertSent(fn ($request) => str_contains($request->url(), '/eventTicketObject')
    && $request->method() === 'POST'
    && $request['classId'] === '3388000000000000001.beatles-shea-1965'
);
```

--------------------------------

### Mocking Apple Pass Notifications

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/testing-your-passes.md

Example of how to use Http::fake() to mock Apple's APNs push notifications when updating a pass.

```php
use Illuminate\Support\Facades\Http;

Http::fake();

$mobilePass = AirlinePassBuilder::make()
    ->setOrganizationName('Spatie')
    ->setSerialNumber('abc')
    // ...
    ->save();

$mobilePass->update(['content' => [...]]);

Http::assertSent(fn ($request) => str_starts_with($request->url(), 'https://api.push.apple.com'));
```

--------------------------------

### Set logo and hero image URLs

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/hosting-images.md

Example of how to set public URLs for the logo and hero image of an event ticket pass class.

```php
use Spatie\LaravelMobilePass\Builders\Google\Entities\Image;
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassClass;

EventTicketPassClass::make('beatles-shea-1965')
    ->setLogoUrl('https://cdn.example.com/beatles-logo.png')
    ->setHeroImageUrl('https://cdn.example.com/beatles-hero.png')
    ->save();
```

--------------------------------

### Registering Listeners in EventServiceProvider

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Example of how to register event listeners explicitly in Laravel's EventServiceProvider.

```php
protected $listen = [
    \Spatie\LaravelMobilePass\Events\MobilePassAdded::class => [
        \App\Listeners\TrackPassInstalls::class,
    ],
    \Spatie\LaravelMobilePass\Events\MobilePassRemoved::class => [
        \App\Listeners\ReactToUninstall::class,
    ],
];
```

--------------------------------

### Apple Event Ticket Pass with Barcode and Alt Text

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-barcodes.md

Example of setting a QR code barcode with human-readable fallback text for Apple passes.

```php
$builder->setBarcode(
    BarcodeType::Qr,
    'TICKET-12345',
    altText: 'Show this at the gate',
);
```

--------------------------------

### Update a field with a change message for Apple passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/updating-a-pass.md

This example demonstrates updating a field and providing a `changeMessage` to notify the user about the change.

```php
$mobilePass->updateField(
    'seat',
    '13A',
    changeMessage: 'Your seat was changed to :value',
);
```

--------------------------------

### Querying Google Mobile Pass Events

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Example of how to query the history of Google Mobile Pass events.

```php
$mobilePass->googleEvents;

$mobilePass->googleEvents()->saves()->get();
$mobilePass->googleEvents()->removes()->get();
```

--------------------------------

### Update a single field on an Apple pass

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/updating-a-pass.md

This example shows how to update a specific field on an Apple pass using the `updateField` method.

```php
$mobilePass->updateField('seat', '13A');
```

--------------------------------

### MobilePassRemoved Event Listener

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Example listener for the MobilePassRemoved event to react to a user uninstalling a pass.

```php
namespace App\Listeners;

use Spatie\LaravelMobilePass\Events\MobilePassRemoved;

class ReactToUninstall
{
    public function handle(MobilePassRemoved $event): void
    {
        // e.g. send a follow-up email, flip a flag, log an analytics event
    }
}
```

--------------------------------

### Update Google pass content

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/updating-a-pass.md

This example shows how to update the content of a Google pass by directly modifying the `content` array and saving the model.

```php
use Spatie\LaravelMobilePass\Models\MobilePass;

$mobilePass = MobilePass::find($id);

$content = $mobilePass->content;
$content['googleObjectPayload']['ticketHolderName'] = 'John Winston Lennon';

$mobilePass->update(['content' => $content]);
```

--------------------------------

### Generating a shareable URL

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

Call `addToWalletUrl()` on the `MobilePass` model to get a shareable link. The model knows its platform and returns the right one.

```php
$url = $mobilePass->addToWalletUrl();
```

--------------------------------

### AppleMobilePassLogsReceived Event Listener

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Example listener for the AppleMobilePassLogsReceived event to forward Apple Wallet error logs.

```php
namespace App\Listeners;

use Illuminate\Support\Facades\Log;
use Spatie\LaravelMobilePass\Events\AppleMobilePassLogsReceived;

class ForwardAppleWalletLogs
{
    public function handle(AppleMobilePassLogsReceived $event): void
    {
        foreach ($event->logEntries as $line) {
            Log::channel('apple-wallet')->info($line);
        }
    }
}
```

--------------------------------

### Setting a Wi-Fi QR code for an open network

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Demonstrates how to set a Wi-Fi QR code for an open network by omitting the password.

```php
$builder->setWifiBarcode('Spatie Guest');
```

--------------------------------

### Setting a Custom Object Suffix for Object ID

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/google-wallet/object-methods.md

Example of setting a custom suffix for the Google pass Object ID, often used to align with database primary keys.

```php
$builder->setObjectSuffix("ticket-{$ticketId}");
```

--------------------------------

### Google Event Ticket Pass Class and Builder

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/available-pass-types/event-ticket.md

Example of defining an event ticket pass class once per event and then creating individual ticket objects for Google Pay.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassBuilder;
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassClass;
use Spatie\LaravelMobilePass\Enums\BarcodeType;

// Once, per event
EventTicketPassClass::make('beatles-shea-1965')
    ->setIssuerName('Fab Four Promotions')
    ->setEventName('Beatles Live at Shea')
    ->setVenueName('Shea Stadium')
    ->setVenueAddress('126th Street & Roosevelt Avenue, Flushing, NY')
    ->setStartDate(Carbon::parse('1965-08-15 20:00'))
    ->setLogoUrl('https://cdn.example.com/beatles-logo.png')
    ->save();

// Per ticket
EventTicketPassBuilder::make()
    ->setClass('beatles-shea-1965')
    ->setAttendeeName('John Lennon')
    ->setSection('B12')
    ->setRow('8')
    ->setSeat('22')
    ->setBarcode(BarcodeType::Qr, 'BTL-SHEA-0042')
    ->save();
```

--------------------------------

### Checking if a Pass is Currently in the Wallet

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Helper method to check if a MobilePass is currently installed in the user's wallet across platforms.

```php
if ($mobilePass->isCurrentlyInWallet()) {
    // Apple: at least one device has it registered
    // Google: latest save/remove callback was a save
}
```

--------------------------------

### Instantiating PkPassReader

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/reading-stored-passes.md

Demonstrates how to instantiate the PkPassReader class from a file or a string.

```php
use Spatie\LaravelMobilePass\Support\Apple\PkPassReader;

// from file
$reader = PkPassReader::fromFile('path/to/pass.pkpass');

// from string
$reader = PkPassReader::fromString($passData);
```

--------------------------------

### Adding multiple Wi-Fi networks

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/attaching-wifi-credentials.md

Demonstrates chaining multiple `addWifiNetwork` calls to include more than one network on a pass.

```php
$builder
    ->addWifiNetwork('SheaStadium-Guest', 'welcome1965')
    ->addWifiNetwork('SheaStadium-VIP', 'backstage1965');
```

--------------------------------

### Generating a QR code

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

If you're printing confirmations or showing them on another screen, wrap the URL in a QR code. Any QR library works.

```php
use SimpleSoftwareIO\QrCode\Facades\QrCode;

QrCode::size(240)->generate($mobilePass->addToWalletUrl());
```

--------------------------------

### Apple: Set logo and icon images

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-images.md

Pass the path to the image file on disk for the logo and icon.

```php
$builder
    ->setLogoImage(public_path('images/logo.png'))
    ->setIconImage(public_path('images/icon.png'));
```

--------------------------------

### Apple: Provide higher-density image versions

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-images.md

Apple renders passes at 1x, 2x, and 3x pixel densities. Providing higher-density versions gives crisper results.

```php
$builder->setLogoImage(
    x1Path: public_path('images/logo.png'),
    x2Path: public_path('images/logo@2x.png'),
    x3Path: public_path('images/logo@3x.png'),
);
```

--------------------------------

### Google: Set logo and hero image URLs

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-images.md

Provide publicly reachable URLs for images. Google fetches these when it renders the pass.

```php
use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassClass;

EventTicketPassClass::make('beatles-shea-1965')
    // ...
    ->setLogoUrl('https://cdn.example.com/beatles-logo.png')
    ->setHeroImageUrl('https://cdn.example.com/beatles-hero.png')
    ->save();
```

--------------------------------

### Handling Missing Image Files

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

This code snippet illustrates how to catch `ImageNotFound` exceptions when an invalid image path is provided to the builder methods.

```php
use Spatie\LaravelMobilePass\Exceptions\ImageNotFound;

try {
    $builder->setLogoImage('/no/such/file.png');
} catch (ImageNotFound $exception) {
    // $exception->getMessage() includes the missing path
}
```

--------------------------------

### Run tests

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/README.md

This command runs the tests for the package.

```bash
composer test
```

--------------------------------

### Colors

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/apple-specific-methods.md

Set foreground and label colors for the pass using hex strings.

```php
$builder
    ->setForegroundColor('#ffffff')
    ->setLabelColor('#a7c7e7');
```

--------------------------------

### Apple: Set background color

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-images.md

Set a background color for Apple passes using a hex string.

```php
$builder->setBackgroundColor('#1d72b8');
```

--------------------------------

### Handling Certificate Signing Failures

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

This code snippet shows how to catch and report `InvalidCertificate` exceptions that occur during pass generation due to certificate issues.

```php
use Spatie\LaravelMobilePass\Exceptions\InvalidCertificate;

try {
    $mobilePass->generate();
} catch (InvalidCertificate $exception) {
    report($exception);
}
```

--------------------------------

### Total price

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/apple-specific-methods.md

Record a monetary value on the pass using the Price class.

```php
use Spatie\LaravelMobilePass\Builders\Apple\Entities\Price;

$builder->setTotalPrice(Price::make(amount: '49.50', currencyCode: 'USD'));
```

--------------------------------

### Google: Set background color

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/adding-images.md

Set a background color for Google passes using a hex string on the Class.

```php
EventTicketPassClass::make('beatles-shea-1965')
    ->setBackgroundColor('#1d72b8')
    ->save();
```

--------------------------------

### Set a relevant date

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/pass-relevance.md

Set a Carbon instance for the relevant date. Apple Wallet will surface the pass about four hours before this moment.

```php
use Illuminate\Support\Carbon;

$builder->setRelevantDate(Carbon::parse('2026-08-15 20:00', 'America/New_York'));
```

--------------------------------

### Configure asynchronous update pushes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/updating-a-pass.md

These environment variables configure the queue connection and name for asynchronous update pushes.

```bash
MOBILE_PASS_QUEUE_CONNECTION=redis
MOBILE_PASS_QUEUE_NAME=wallet
```

--------------------------------

### Catching any MobilePassException

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

You can catch any exception thrown by the package using the MobilePassException marker interface.

```php
use Spatie\LaravelMobilePass\Exceptions\MobilePassException;

try {
    // something that touches the package
} catch (MobilePassException $exception) {
    report($exception);
}
```

--------------------------------

### Tune the radius

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/pass-relevance.md

Override the default surfacing radius with `setMaxDistance()`, which takes a distance in meters.

```php
$builder->setMaxDistance(500);
```

--------------------------------

### Handling Apple Wallet Request Failures

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

This code snippet demonstrates how to catch and log `AppleWalletRequestFailed` exceptions when updating a pass in Apple Wallet.

```php
use Spatie\LaravelMobilePass\Exceptions\AppleWalletRequestFailed;

try {
    $mobilePass->updateField('seat', '13A');
} catch (AppleWalletRequestFailed $exception) {
    logger()->error('APNs push was rejected', [
        'status' => $exception->status,
        'body' => $exception->body,
        'endpoint' => $exception->endpoint,
    ]);
}
```

--------------------------------

### Handling GoogleWalletRequestFailed exceptions

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

This exception is thrown for any call to Google's Wallet API and includes the original HTTP response details.

```php
use Spatie\LaravelMobilePass\Exceptions\GoogleWalletRequestFailed;

try {
    EventTicketPassClass::make('duplicate-id')
        ->setIssuerName('...')
        ->save();
} catch (GoogleWalletRequestFailed $exception) {
    logger()->error('Google Wallet rejected the request', [
        'status' => $exception->status,
        'body' => $exception->body,
        'endpoint' => $exception->endpoint,
    ]);
}
```

--------------------------------

### Returning MobilePass from a controller

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

The `MobilePass` model implements `Responsable`, so the simplest way to deliver a pass is to return the model itself from a controller. Laravel takes it from there, serving the signed `.pkpass` for Apple passes and redirecting to the Google Wallet save URL for Google passes.

```php
use Spatie\LaravelMobilePass\Models\MobilePass;

class AddToWalletController
{
    public function __invoke(MobilePass $mobilePass)
    {
        return $mobilePass;
    }
}
```

--------------------------------

### Add methods for field zones

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/field-zones.md

Shows the available add methods for each of the five field zones in Apple Wallet passes.

```php
addHeaderField(string $key, string $value, ?string $label, ?string $changeMessage, ?DateType $dateStyle, ?TimeStyleType $timeStyle, ?bool $showDateAsRelative)
addField(string $key, string $value, FieldType $type = FieldType::Primary, ...)
addSecondaryField(string $key, string $value, ...)
addAuxiliaryField(string $key, string $value, ...)
addBackField(string $key, string $value, ...)
```

--------------------------------

### Fetching specific Apple or Google passes by PassType

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/retrieving-mobile-passes.md

The firstApplePass and firstGooglePass methods accept an optional PassType to further narrow down the results.

```php
use Spatie\LaravelMobilePass\Enums\PassType;

$user->firstApplePass(PassType::EventTicket);
```

--------------------------------

### Generate and store a mobile pass from a model

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/storing-mobile-passes.md

This snippet shows how to generate the .pkpass file content from a MobilePass model and then save it to a file.

```php
use Spatie\LaravelMobilePass\Models\MobilePass;

$mobilePassContent = $mobilePass->generate();

file_put_contents('path/to/store/pass.pkpass', $mobilePassContent);
```

--------------------------------

### Attaching a MobilePass to a Mailable

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

For Apple passes, you can attach the `.pkpass` file directly to a mailable. The `MobilePass` model implements Laravel's `Attachable` contract, so attaching it is a one-liner. Google passes aren't files (Google hosts them for you), so this route is Apple-only.

```php
use App\Models\User;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Attachment;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Envelope;
use Spatie\LaravelMobilePass\Models\MobilePass;

class TicketPurchased extends Mailable
{
    public function __construct(
        public User $user,
        public MobilePass $mobilePass,
    ) {}

    public function envelope(): Envelope
    {
        return new Envelope(subject: 'Your ticket');
    }

    public function content(): Content
    {
        return new Content(markdown: 'mail.ticket-purchased');
    }

    /** @return array<int, MobilePass> */
    public function attachments(): array
    {
        return [$this->mobilePass];
    }
}
```

--------------------------------

### Generate a mobile pass without a model

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/storing-mobile-passes.md

This snippet demonstrates generating a .pkpass file content directly from an Apple pass builder, bypassing the need for a MobilePass model.

```php
$mobilePassContent = AirlinePassBuilder::make()
    ->setOrganizationName('My organization')
//  other calls
    ->generate();

file_put_contents('path/to/store/pass.pkpass', $mobilePassContent);
```

--------------------------------

### Fetching a single pass

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/retrieving-mobile-passes.md

The firstMobilePass method retrieves a single mobile pass.

```php
$mobilePass = User::first()->firstMobilePass();
```

--------------------------------

### Extend the default MobilePass model and enable SoftDeletes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/customizing-models.md

This code snippet shows how to create a custom MobilePass model that extends the default one and uses the SoftDeletes trait.

```php
use Illuminate\Database\Eloquent\SoftDeletes;
use Spatie\LaravelMobilePass\Models\MobilePass;

class CustomMobilePass extends MobilePass
{
    use SoftDeletes;
}
```

--------------------------------

### Embedding the URL in an anchor tag

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

The URL works behind any anchor or form. This sits nicely on a post-checkout confirmation page.

```blade
<a href="{{ $mobilePass->addToWalletUrl() }}" class="btn">
    Add to Wallet
</a>
```

--------------------------------

### Fetching a single pass with specific criteria

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/retrieving-mobile-passes.md

The firstMobilePass method accepts optional arguments for PassType, Platform, and a filter closure for custom queries.

```php
use Spatie\LaravelMobilePass\Enums\PassType;
use Spatie\LaravelMobilePass\Enums\Platform;

$couponPass = User::first()->firstMobilePass(PassType::Coupon);

$appleEventTicket = User::first()->firstMobilePass(PassType::EventTicket, Platform::Apple);

$customQuery = User::first()->firstMobilePass(filter: function ($query) {
    $query->where('type', PassType::Coupon);
});
```

--------------------------------

### Update the mobile-pass config to use the custom model

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/customizing-models.md

This code snippet shows how to update the `config/mobile-pass.php` file to use the custom `App\Models\CustomMobilePass` model.

```php
// config/mobile-pass.php

return [
    'models' => [
        'mobile_pass' =>  App\Models\CustomMobilePass::class,
    ],
];
```

--------------------------------

### Add location with relevant text

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/pass-relevance.md

Optionally add altitude and a relevant text message that shows up on the lock screen when the pass surfaces.

```php
$builder->addLocation(
    latitude: 40.7559,
    longitude: -73.8456,
    relevantText: 'Welcome to Shea Stadium',
);
```

--------------------------------

### Fetching all passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/retrieving-mobile-passes.md

To retrieve all mobile passes associated with a model, regardless of platform, use the mobilePasses property.

```php
$mobilePasses = User::first()->mobilePasses;
```

--------------------------------

### Customizing MobilePass model for expiring Apple URLs

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/handing-out-passes.md

By default the Apple link is a `signedRoute`, not a `temporarySignedRoute`, so it doesn't expire. That matches how wallet download links are usually used in practice (people open them days later on a new device), but you can change it by swapping in a custom `MobilePass` model and overriding `addToAppleWalletUrl()`.

```php
namespace App\Models;

use Illuminate\Support\Facades\URL;
use Spatie\LaravelMobilePass\Models\MobilePass as BaseMobilePass;

class MobilePass extends BaseMobilePass
{
    protected function addToAppleWalletUrl(): string
    {
        return URL::temporarySignedRoute(
            'mobile-pass.apple.download',
            now()->addHour(),
            ['mobilePass' => $this->id],
        );
    }
}
```

--------------------------------

### NFC payload with authentication

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/nfc.md

Sets an NFC message, encryption public key, and requires authentication before transmission.

```php
$builder->setNfc(
    message: 'TICKET-12345',
    encryptionPublicKey: 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...',
    requiresAuthentication: true,
);
```

--------------------------------

### Add locations

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/pass-relevance.md

Attach one or more physical locations (latitude and longitude) to make the pass surface when the user is near them.

```php
$builder
    ->addLocation(latitude: 40.7559, longitude: -73.8456)
    ->addLocation(latitude: 40.7580, longitude: -73.9855);
```

--------------------------------

### Basic NFC payload

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/apple-wallet/nfc.md

Sets a basic NFC message and encryption public key.

```php
$builder->setNfc(
    message: 'TICKET-12345',
    encryptionPublicKey: 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...',
);
```

--------------------------------

### Fetching Apple or Google passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/retrieving-mobile-passes.md

The HasMobilePasses trait provides dedicated helpers to fetch Apple or Google passes separately.

```php
$user = User::first();

$user->applePasses;   // only Apple passes
$user->googlePasses;  // only Google passes

$user->firstApplePass();
$user->firstGooglePass();
```

--------------------------------

### Filter expired passes

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/expiring-passes.md

Query for passes that have not yet expired by checking the `expired_at` column.

```php
MobilePass::whereNull('expired_at')->get();
```

--------------------------------

### Database Migration for Upgrading

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/UPGRADING.md

This migration updates the database schema to accommodate changes in how mobile pass serial numbers are handled, including renaming columns and adding a new 'pass_serial' column.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::table('apple_mobile_pass_registrations', function (Blueprint $table) {
            $table->dropForeign(['pass_serial']);
            $table->renameColumn('pass_serial', 'mobile_pass_id');
        });

        Schema::table('apple_mobile_pass_registrations', function (Blueprint $table) {
            $table->foreign('mobile_pass_id')->references('id')->on('mobile_passes');
        });

        Schema::table('mobile_passes', function (Blueprint $table) {
            $table->string('pass_serial')->nullable()->after('id');
        });

        DB::table('mobile_passes')
            ->whereNull('pass_serial')
            ->update(['pass_serial' => DB::raw('id')]);

        Schema::table('mobile_passes', function (Blueprint $table) {
            $table->string('pass_serial')->nullable(false)->change();
            $table->unique('pass_serial');
        });
    }
};
```

--------------------------------

### Handling InvalidPass exceptions

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/handling-errors.md

InvalidPass exceptions are thrown when a validation error occurs before saving a pass. They extend Laravel's ValidationException.

```php
use Spatie\LaravelMobilePass\Exceptions\InvalidPass;

try {
    EventTicketPassBuilder::make()
        ->setOrganizationName('Fab Four Promotions')
        // setSerialNumber omitted
        ->setDescription('The Beatles at Shea Stadium')
        ->save();
} catch (InvalidPass $exception) {
    report($exception);
}
```

--------------------------------

### Expire a mobile pass

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/basic-usage/expiring-passes.md

Call the `expire()` method on the `MobilePass` model to expire a pass.

```php
$mobilePass->expire();
```

--------------------------------

### Checking if Currently Saved to Google Wallet

Source: https://github.com/spatie/laravel-mobile-pass/blob/main/docs/advanced-usage/events.md

Specific helper to check if a pass is currently saved to Google Wallet.

```php
$mobilePass->isCurrentlySavedToGoogleWallet();
```
Tokens:
Raw