Download the PHP package goteborgco/open-api-php-client without Composer

Göteborg & Co API Client for PHP

Official PHP client library for interacting with the Göteborg & Co GraphQL API. This package provides a type-safe interface for accessing Göteborg & Co's API, offering both structured methods for common operations and flexible GraphQL query capabilities.

Features

• Type-safe methods for common operations (guides, events, places, search and taxonomies)
• Direct GraphQL query support for advanced use cases
• Built-in error handling and response parsing
• Comprehensive documentation and examples

Requirements

• PHP >= 8.1
• Composer

Installation

Install the package via composer:

Setup

Initialize the API Client with your API URL and subscription key:

Usage

Type-Specific Methods

While the general query method provides full flexibility, the API also includes type-specific methods for common operations. These methods provide:

• Type safety with proper PHP classes for each entity type
• Simpler parameter handling
• Structured field selection
• Default values for common use cases
• Full IDE support with autocompletion

Entity Types

The following entity types are available:

• WpEntity: Base entity for guides, events, and places

  • getId(): int - Get the WordPress post ID
  • getDate(): ?string - Get the creation date in ISO 8601 format
  • getModified(): ?string - Get the last modification date in ISO 8601 format
  • getType(): ?string - Get the content type (e.g., 'event', 'place', 'guide')
  • getLink(): ?string - Get the public URL of the content item
  • getTitle(): ?string - Get the content title
  • getContent(): ?string - Get the main content (may contain HTML)
  • getExcerpt(): ?string - Get a brief summary of the content
  • getCategories(): array - Get array of category IDs
  • getAreas(): array - Get array of area IDs
  • getTags(): array - Get array of tag IDs
  • getInvisibleTags(): array - Get array of invisible tag IDs (for internal use)
  • getLang(): string - Get the language code ('en'|'sv')
  • getTranslations(): ?Translations - Get available translations
  • getFeaturedMedia(): Media[] - Get array of featured media objects
  • getCategoryHeading(): ?string - Get optional category heading
  • getGallery(): Media[] - Get array of gallery media objects
  • getContact(): ?Contact - Get contact information
  • getLocation(): ?Location - Get location information
  • isFree(): ?bool - Check if admission is free (for events)
  • getDates(): EventDate[] - Get array of event dates
  • getPlaceId(): ?int - Get associated place ID (for events)
  • getClassification(): ?int - Get classification value
  • getCurrentInTime(): ?CurrentInTime - Get temporal availability information

• Location: Location information

  • getAddress(): ?string - Get complete address string
  • getLat(): ?float - Get latitude coordinate
  • getLng(): ?float - Get longitude coordinate
  • getZoom(): ?int - Get default map zoom level
  • getPlaceId(): ?string - Get Google Places ID
  • getName(): ?string - Get location/establishment name
  • getStreetNumber(): ?string - Get street number
  • getStreetName(): ?string - Get street name
  • getState(): ?string - Get state/region
  • getPostCode(): ?string - Get postal code
  • getCountry(): ?string - Get full country name
  • getCountryShort(): ?string - Get two-letter country code (ISO 3166-1 alpha-2)

• Media: Media assets

  • getId(): int - Get media item ID
  • getCredit(): ?string - Get attribution information
  • getCaption(): ?string - Get media description
  • getAltText(): ?string - Get alternative text for accessibility
  • getMediaType(): ?string - Get type of media (e.g., 'image', 'video')
  • getMimeType(): ?string - Get MIME type of the media file
  • getSizes(): ?MediaSizes - Get available size variations

• MediaSizes: Image size variants

  • getMedium(): ?Image - Get medium size version
  • getThumbnail(): ?Image - Get thumbnail version
  • getLarge(): ?Image - Get large size version
  • getFull(): ?Image - Get full/original size version

• Image: Individual image properties

  • getWidth(): int - Get width in pixels
  • getHeight(): int - Get height in pixels
  • getSourceUrl(): string - Get URL where the image can be accessed

• Contact: Contact information

  • getEmail(): ?string - Get contact email address
  • getPhone(): ?string - Get contact phone number
  • getWebsite(): ?string - Get website URL
  • getFacebook(): ?string - Get Facebook profile/page URL
  • getInstagram(): ?string - Get Instagram profile URL

• EventDate: Date range for events

  • getStart(): ?string - Get start date in ISO 8601 format
  • getEnd(): ?string - Get end date in ISO 8601 format

• CurrentInTime: Temporal availability information

  • getMonths(): array - Get array of month numbers (1-12) when item is active
  • getWeekdays(): array - Get array of weekday numbers (0-6) when item is active

• Features: GeoJSON Feature

  • getType(): string - Get GeoJSON object type
  • getGeometry(): Geometry - Get geometric data
  • getProperties(): Properties - Get feature properties

• Geometry: GeoJSON geometry

  • getType(): string - Get geometry type (e.g., 'Point', 'LineString', 'Polygon')
  • getCoordinates(): array - Get coordinates in GeoJSON format
  • getLatitude(): ?float - Get latitude (for Point geometries)
  • getLongitude(): ?float - Get longitude (for Point geometries)

• Properties: GeoJSON feature properties

  • getName(): string - Get feature display name
  • getId(): int - Get unique identifier
  • getIcon(): string - Get icon URL/identifier
  • getThumbnail(): string - Get thumbnail image URL
  • getType(): string - Get feature classification type
  • getSlug(): string - Get URL-friendly identifier

• Markers: GeoJSON FeatureCollection

  • getType(): string - Get GeoJSON object type (typically 'FeatureCollection')
  • getFeatures(): Features[] - Get array of Feature objects

• Related: Related content collection

  • getPlaces(): WpEntity[] - Get array of related place entities
  • getGuides(): WpEntity[] - Get array of related guide entities
  • getEvents(): WpEntity[] - Get array of related event entities
• Translations: Content translations
  • getSv(): ?int - Get ID of Swedish content version
  • getEn(): ?int - Get ID of English content version

Listing Guides

List guides using GraphQL field selection:

Getting a Single Guide

Retrieve a specific guide:

Error Handling

The API uses exception handling for errors. Wrap your API calls in try-catch blocks:

Places

The API provides methods to list places and retrieve individual places by ID. All responses are mapped to proper PHP classes for type safety.

Listing Places

List places with field selection:

Getting a Single Place

Events

The API provides methods to list events and retrieve individual events by ID. Events include support for date filtering and sorting.

Listing Events

Getting a Single Event

Search

Taxonomies

The API provides methods to list all available taxonomies. This is useful for getting an overview of all taxonomy types in the system.

Taxonomy

The API provides methods to list all terms within a specific taxonomy. Terms can be retrieved either as a flat list or as a hierarchical tree structure based on parent-child relationships.

Listing Taxonomy Terms (Flat)

Listing Taxonomy Terms (Hierarchical)

When working with hierarchical taxonomies like categories, you can retrieve terms in a tree structure:

Notes

• Empty fields are not allowed and will throw an InvalidArgumentException
• Related content is only available when retrieving a single guide using getById
• All dates are in ISO 8601 format
• All entity classes provide proper type hints for IDE support
• Nested objects are automatically mapped to their corresponding classes

Array Structure for Fields

As an alternative to GraphQL strings, you can also specify fields using an array structure. This can be useful when building queries dynamically:

General GraphQL Queries

The API provides a general-purpose query method for executing any GraphQL query. This method accepts raw GraphQL syntax and returns the unprocessed API response:

Query Structure

The query method expects a complete GraphQL query string. The query must:

• Start with the query keyword
• Include any necessary filters in the GraphQL syntax
• Specify all required fields and nested structures

Examples of valid queries:

Error Handling

The query method will throw exceptions for:

• Empty queries
• Invalid GraphQL syntax
• API errors

Always wrap query calls in try-catch blocks:

This array structure will be automatically converted to the equivalent GraphQL fields string internally.