Download the PHP package gitsbt/waylume-sdk without Composer

On this page you can find all versions of the php package gitsbt/waylume-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of gitsbt/waylume-sdk

Informations about the package waylume-sdk

Waylume SDK — PHP

日本語

Add multi-page Waylume navigation guides to PHP-rendered websites, including Laravel, Symfony, WordPress, and plain PHP applications.

Requirements

Install

Local development without credentials

On localhost, 127.0.0.1, and the IPv6 loopback address, no Waylume license, credentials, proof endpoint, or local Waylume server is required. Use SdkMode::Auto with an internet connection.

Credentials and the proof endpoint in the next two sections are required only when the site is viewed on a non-local hostname.

1. Configure production credentials

Store the credentials issued in the Waylume dashboard on your server. Never expose the private key in HTML or browser JavaScript.

The dashboard exports private_key as the Base64 body only, without -----BEGIN PRIVATE KEY----- / -----END PRIVATE KEY----- lines. Pass that value directly to LicenseProofSigner; do not add PEM markers. The environment variable names shown here are examples and may be changed to match your app.

2. Add a production proof endpoint

Create a server-side POST endpoint such as /api/waylume-proof:

Replace app.example.com with the licensed hostname stored in your existing application configuration. Do not accept an arbitrary hostname supplied by the browser.

3. Mark guide targets

The data-waylume value must match the flow step's target.

4. Define and register flows

Flows can also be loaded from JSON:

5. Publish the browser loader

Copy the packaged browser loader to a public directory during deployment.

6. Render the bootstrap

Render the bootstrap on every page that participates in a guide:

Place this before </body> in your shared layout:

7. Add a launcher or navigation trigger

Launcher listing every registered flow:

Trigger for one specific flow:

Pass only trusted markup to children; it is intentionally not escaped.

Multi-page flows

Set expectedUrlPattern on the first step and on steps that wait for navigation. Only same-site paths beginning with / are accepted. Render the bootstrap in the shared layout so the guide can resume after a full page load.

For Inertia, Livewire, or another client-side router, call this after a route change:

Main APIs

The browser emits waylume:step-change, waylume:flow-complete, and waylume:flow-skip events.

License

Production use requires a Waylume site license. See LICENSE and waylume.app.

All versions of waylume-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-json Version *
ext-sodium Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package gitsbt/waylume-sdk contains the following files

Loading the files please wait ...