PHPackages                             amtgard/ork-iam-orn-definitions - 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. [Utility & Helpers](/categories/utility)
4. /
5. amtgard/ork-iam-orn-definitions

ActiveLibrary[Utility & Helpers](/categories/utility)

amtgard/ork-iam-orn-definitions
===============================

ORN Definitions for ORK Services

v2.0.0(1mo ago)015↓85.7%2MITPHPPHP ^8.3

Since Jun 8Pushed 1mo agoCompare

[ Source](https://github.com/amtgard/ork-iam-orn-definitions)[ Packagist](https://packagist.org/packages/amtgard/ork-iam-orn-definitions)[ Docs](https://github.com/amtgard/ork-iam-orn-definitions)[ RSS](/packages/amtgard-ork-iam-orn-definitions/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (3)Dependencies (4)Versions (6)Used By (2)

ork-iam-orn-definitions
=======================

[](#ork-iam-orn-definitions)

Standard ORN definition classes for ORK IAM. This package depends on [amtgard/ork-iam](https://github.com/amtgard/ork-iam) and is **optional** — use it when you want the built-in Attendance and ORK schemas without writing your own.

Installation
------------

[](#installation)

```
composer require amtgard/ork-iam amtgard/ork-iam-orn-definitions
```

### Version lines

[](#version-lines)

LineBranchPair with `ork-iam`Composer constraintLatest tag1.x (maintenance)`1.x``"amtgard/ork-iam": "^1.4"``"amtgard/ork-iam-orn-definitions": "^1.0"``v0.9.0`2.x (current)`main``"amtgard/ork-iam": "^2.1"``"amtgard/ork-iam-orn-definitions": "^2.0"`*(pending `v2.0.0`)*Pin the definitions package to the same major line as `ork-iam`. Do not mix `ork-iam` 1.x with definitions 2.x (or vice versa).

### Branching

[](#branching)

- **1.x fixes** — branch from `1.x`, name `feature/1.x/`, open PRs against `1.x`. Tag releases `v1.0.0`, `v1.1.0`, … on `1.x`.
- **2.x features** — branch from `main`, name `feature/`, open PRs against `main`. Tag releases `v2.0.0`, `v2.1.0`, … on `main`.

On autoload, `src/register.php` registers claim and requirement classes with `OrnClassMap`. No additional bootstrap is required.

Included definitions
--------------------

[](#included-definitions)

Schemas are defined in `bin/orn_definitions.json` and generated into `src/ORN/`.

ServiceClassesAttendance`AttendanceFormat`, `AttendanceClaim`, `AttendanceRequirement`ORK`OrkFormat`, `OrkClaim`, `OrkRequirement`All generated classes live in the `Amtgard\IAM\Definitions\ORN` namespace.

### Attendance

[](#attendance)

- **Schema labels:** Configuration, Game, Kingdom, Park, Event, EventInstance
- **Resources:** `ORK/AddAttendance`, `ORK/SetAttendance`, `ORK/RemoveAttendance`, `Classes/GetClasses`, `Classes/SetClass`

### ORK

[](#ork)

- **Schema labels:** Configuration, Game, Kingdom, Park, Event
- **Resources:** `ORK/AddKingdom`

Usage
-----

[](#usage)

Once installed, use `ork-iam` factories and definition classes as usual:

```