PHPackages                             dataworksbi/open-loyalty-framework - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. dataworksbi/open-loyalty-framework

ActiveProject[Framework](/categories/framework)

dataworksbi/open-loyalty-framework
==================================

3.2.0(7y ago)0985[1 PRs](https://github.com/dataworksbi/open-loyalty-framework/pulls)proprietaryPHPPHP >=7.1

Since Sep 8Pushed 3y agoCompare

[ Source](https://github.com/dataworksbi/open-loyalty-framework)[ Packagist](https://packagist.org/packages/dataworksbi/open-loyalty-framework)[ RSS](/packages/dataworksbi-open-loyalty-framework/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (50)Versions (39)Used By (0)

api login
=========

[](#api-login)

jwt token structure
-------------------

[](#jwt-token-structure)

```
{
 exp: 1470299383,
 username: "admin",
 roles: [
  "ROLE_ADMIN"
 ],
 iat: "1470212983"
}

```

obtaining jwt token
-------------------

[](#obtaining-jwt-token)

admin url: /api/admin/login\_check customer url: /api/customer/login\_check seller url: /api/seller/login\_check

method: POST

body:

- \_username: admin
- \_password: open

response:

```
{
"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHA",
"refresh_token":"44588da231e2f480bd4"
}

```

refreshing jwt token
--------------------

[](#refreshing-jwt-token)

url: /api/token/refresh

method: POST

body:

- refresh\_token: 'token'

response:

```
{
"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHA",
"refresh_token":"44588da231e2f480bd4"
}

```

events
======

[](#events)

system events
-------------

[](#system-events)

Proper listener should be created to handle system events. Example definition of such listener:

```
    oloy.listener:
        class: 'OpenLoyalty\Listener.php'
        tags:
          - { name: broadway.event_listener, event: oloy.customer.registered, method: handle }

```

### 'oloy.customer.registered' - customer added to PL

[](#oloycustomerregistered---customer-added-to-pl)

Event class: OpenLoyalty\\Domain\\Customer\\SystemEvent\\CustomerRegisteredSystemEvent

### 'oloy.customer.updated'

[](#oloycustomerupdated)

Event class: OpenLoyalty\\Domain\\Customer\\SystemEvent\\CustomerUpdatedSystemEvent

### 'oloy.customer.agreements\_updated'

[](#oloycustomeragreements_updated)

Event class: OpenLoyalty\\Domain\\Customer\\SystemEvent\\CustomerAgreementsUpdatedSystemEvent

### 'oloy.customer.deactivated'

[](#oloycustomerdeactivated)

Event class: OpenLoyalty\\Domain\\Customer\\SystemEvent\\CustomerDeactivatedSystemEvent

### 'oloy.segment.customer\_added\_to\_segment'

[](#oloysegmentcustomer_added_to_segment)

Event class: OpenLoyalty\\Domain\\Segment\\SystemEvent\\CustomerAddedToSegmentSystemEvent

### 'oloy.segment.customer\_removed\_from\_segment'

[](#oloysegmentcustomer_removed_from_segment)

Event class: OpenLoyalty\\Domain\\Segment\\SystemEvent\\CustomerRemovedFromSegmentSystemEvent

domain events
-------------

[](#domain-events)

Proper listener should be created to handle domain events. This listener must implement Broadway\\EventHandling\\EventListenerInterface

Example definition of such listener:

```
    oloy.listener:
        class: 'OpenLoyalty\Listener.php'
        lazy: true
        tags:
          - { name: broadway.domain.event_listener }

```

### OpenLoyalty\\Domain\\Customer\\Event\\CampaignWasBoughtByCustomer - dispatched when campaign was bought by customer

[](#openloyaltydomaincustomereventcampaignwasboughtbycustomer---dispatched-when-campaign-was-bought-by-customer)

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 54.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~13 days

Recently: every ~23 days

Total

37

Last Release

2717d ago

Major Versions

1.4.0 → 2.0.02017-11-16

2.10.0 → 3.0.02018-10-23

PHP version history (4 changes)1.2PHP >=5.5.9

1.0PHP >=5.6

2.0.0PHP >=7.0

2.5.0PHP >=7.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/58574869?v=4)[rksleung](/maintainers/rksleung)[@rksleung](https://github.com/rksleung)

---

Top Contributors

[![klobermajer](https://avatars.githubusercontent.com/u/2846864?v=4)](https://github.com/klobermajer "klobermajer (13 commits)")[![pskorka](https://avatars.githubusercontent.com/u/19946119?v=4)](https://github.com/pskorka "pskorka (7 commits)")[![emgiezet](https://avatars.githubusercontent.com/u/1410665?v=4)](https://github.com/emgiezet "emgiezet (2 commits)")[![kardasz](https://avatars.githubusercontent.com/u/1894170?v=4)](https://github.com/kardasz "kardasz (1 commits)")[![rksleung](https://avatars.githubusercontent.com/u/58574869?v=4)](https://github.com/rksleung "rksleung (1 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/dataworksbi-open-loyalty-framework/health.svg)

```
[![Health](https://phpackages.com/badges/dataworksbi-open-loyalty-framework/health.svg)](https://phpackages.com/packages/dataworksbi-open-loyalty-framework)
```

###  Alternatives

[kimai/kimai

Kimai - Time Tracking

4.8k9.0k1](/packages/kimai-kimai)[oro/platform

Business Application Platform (BAP)

645143.5k114](/packages/oro-platform)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M733](/packages/sylius-sylius)[pimcore/pimcore

Content & Product Management Framework (CMS/PIM/E-Commerce)

3.8k3.8M508](/packages/pimcore-pimcore)[open-dxp/opendxp

Content & Product Management Framework (CMS/PIM)

9421.6k61](/packages/open-dxp-opendxp)[akeneo/pim-community-dev

Akeneo PIM, the future of catalog management is open!

1.0k624.1k86](/packages/akeneo-pim-community-dev)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)