Pass classes

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.

##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 for how to issue a per-user pass once your Class is declared.