Pass classes | laravel-mobile-pass | Spatie SPATIE Laravel Mobile Pass ====================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-mobile-pass](https://spatie.be/docs/laravel-mobile-pass/v1) Google-wallet Pass classes Version v1 Other versions for crawler [v1](https://spatie.be/docs/laravel-mobile-pass/v1) Pass classes - [ Introduction ](https://spatie.be/docs/laravel-mobile-pass/v1/introduction) - [ Support us ](https://spatie.be/docs/laravel-mobile-pass/v1/support-us) - [ Requirements ](https://spatie.be/docs/laravel-mobile-pass/v1/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-mobile-pass/v1/installation-setup) - [ Getting credentials from Apple ](https://spatie.be/docs/laravel-mobile-pass/v1/getting-credentials-from-apple) - [ Getting credentials from Google ](https://spatie.be/docs/laravel-mobile-pass/v1/getting-credentials-from-google) - [ Questions and issues ](https://spatie.be/docs/laravel-mobile-pass/v1/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-mobile-pass/v1/changelog) - [ About us ](https://spatie.be/docs/laravel-mobile-pass/v1/about-us) Basic usage ----------- - [ Generating your first pass ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/generating-your-first-pass) - [ Delivering passes to users ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/handing-out-passes) - [ Adding images ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/adding-images) - [ Adding barcodes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/adding-barcodes) - [ Updating a pass ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/updating-a-pass) - [ Retrieving mobile passes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/retrieving-mobile-passes) - [ Expiring passes ](https://spatie.be/docs/laravel-mobile-pass/v1/basic-usage/expiring-passes) Available pass types -------------------- - [ Introduction ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/introduction) - [ Boarding pass ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/boarding-pass) - [ Event ticket ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/event-ticket) - [ Coupon ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/coupon) - [ Loyalty card ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/loyalty) - [ Generic ](https://spatie.be/docs/laravel-mobile-pass/v1/available-pass-types/generic) Apple Wallet ------------ - [ Field zones ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/field-zones) - [ Apple-specific methods ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/apple-specific-methods) - [ Pass relevance ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/pass-relevance) - [ NFC passes ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/nfc) - [ Attaching Wi-Fi credentials ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/attaching-wifi-credentials) - [ Storing mobile passes ](https://spatie.be/docs/laravel-mobile-pass/v1/apple-wallet/storing-mobile-passes) Google Wallet ------------- - [ Pass classes ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/pass-classes) - [ Object methods ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/object-methods) - [ Hosting pass images ](https://spatie.be/docs/laravel-mobile-pass/v1/google-wallet/hosting-images) Advanced usage -------------- - [ Handling errors ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/handling-errors) - [ Customizing actions ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/customizing-actions) - [ Customizing models ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/customizing-models) - [ Reading stored passes ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/reading-stored-passes) - [ Events ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/events) - [ Testing your passes ](https://spatie.be/docs/laravel-mobile-pass/v1/advanced-usage/testing-your-passes) Pass classes ============ ### On this page 1. [ Declaring a Class ](#content-declaring-a-class) 2. [ Fetching classes back ](#content-fetching-classes-back) 3. [ Adding locations, links, and modules ](#content-adding-locations-links-and-modules) 4. [ Retiring a class ](#content-retiring-a-class) 5. [ Available Class builders ](#content-available-class-builders) Google Wallet splits a pass into two pieces: a Class and an Object. The Class is a shared template (the event itself, the loyalty program, the flight). The Object is one pass for one user, built on top of a Class. Think of a Beatles concert. You declare the "Beatles at Shea Stadium on August 15" Class once. Every ticket sold is an Object pointing at that Class. Or think of a Starbucks loyalty program: the program is one Class, and each member's card is its own Object. Apple has no equivalent of this. On Apple, every pass stands on its own. Declaring a Class ----------------------------------------------------------------------------------------------------------- Every Google pass type has a matching Class. You create one by calling `make()` with a unique suffix, setting the template fields, then calling `save()`. Here's the Beatles concert Class, declared once per event: ``` 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(); ``` The suffix (`'beatles-shea-1965'` here) is what you'll reference later when creating individual ticket passes. The full class ID Google sees is `{issuer-id}.{suffix}`, which the package stitches together for you. Google stores Classes on its own servers, not in your database. Fetching classes back ----------------------------------------------------------------------------------------------------------------------- You can look a class up later by its suffix. ``` $class = EventTicketPassClass::find('beatles-shea-1965'); if ($class) { // class exists on Google } ``` Or list every class of this type on your issuer account: ``` $classes = EventTicketPassClass::all(); ``` Both methods return instances with the fields Google sends back hydrated onto them. Adding locations, links, and modules ---------------------------------------------------------------------------------------------------------------------------------------------------------------- Every Google class type supports a few extra building blocks that show up on the back of the pass: geographic locations, a links module (the "main page URL" and any other URIs), text modules, and image modules. Because these are shared across all class types, the same methods are available on every Class builder. ``` EventTicketPassClass::make('beatles-shea-1965') ->setIssuerName('Fab Four Promotions') ->setEventName('The Beatles | Live at Shea') ->addLocation(40.7569, -73.8458) ->addLink('https://fabfour.example.com', 'Official site') ->addLink('tel:+15551234567') ->addTextModule('Doors', 'Doors open at 18:30') ->addImageModule('https://example.com/seating-chart.png', 'seating') ->save(); ``` - `addLocation(float $latitude, float $longitude)` adds a point to the class's `locations`. - `addLink(string $uri, ?string $description = null)` adds a URI to the links module. The description is optional. - `addTextModule(string $header, string $body, ?string $id = null)` adds a text module. - `addImageModule(string $imageUrl, ?string $id = null)` adds an image module. The image must be a hosted URL. Each method can be called multiple times to add more than one entry. When you fetch a class back with `find()` or `all()`, these are hydrated onto the instance and readable through `getLocations()`, `getLinks()`, `getTextModules()`, and `getImageModules()`. Retiring a class -------------------------------------------------------------------------------------------------------- Google has no hard delete for classes. What you can do is call `retire()`, which flips the class's `reviewStatus` to `REJECTED`. Google will stop promoting it, but every pass you've already issued against it keeps working. ``` EventTicketPassClass::find('beatles-shea-1965')?->retire(); ``` Available Class builders -------------------------------------------------------------------------------------------------------------------------------- The package ships a Class for each Google pass type: - `EventTicketPassClass` - `BoardingPassClass` - `LoyaltyPassClass` - `OfferPassClass` - `GenericPassClass` See [Object methods](google-wallet/object-methods) for how to issue a per-user pass once your Class is declared. A good match? ------------- ### What we do best - All things Laravel - Custom frontend components - Building APIs - AI-powered features - Simplifying things - Clean solutions - Integrating services ### Not our cup of tea - WordPress themes - Cutting corners - Free mockups to win a job - "Just execute the briefing" In short: we'd like to be a **substantial part** of your project. [ Get in touch via email ](mailto:info@spatie.be?subject=A%20good%20match%21&body=Tell%20us%20as%20much%20as%20you%20can%20about%0A-%20your%20online%20project%0A-%20your%20planning%0A-%20your%20budget%0A-%20%E2%80%A6%0A%0AAnything%20that%20helps%20us%20to%20start%20straightforward%21)