Download the PHP package muradyanvano/php-lexorank without Composer
On this page you can find all versions of the php package muradyanvano/php-lexorank. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download muradyanvano/php-lexorank
More information about muradyanvano/php-lexorank
Files in muradyanvano/php-lexorank
Package php-lexorank
Short Description Production-ready LexoRank implementation for PHP — deterministic lexicographic ranking for ordered lists, Kanban boards, and drag-and-drop UIs.
License MIT
Homepage https://github.com/muradyanvano/php-lexorank
FAQ
Example:
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 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.
Informations about the package php-lexorank
php-lexorank
Production-ready LexoRank-style lexicographic ranking for PHP — deterministic ordered lists, Kanban boards, and drag-and-drop UIs without renumbering entire tables.
Package: muradyanvano/php-lexorank
GitHub: muradyanvano/php-lexorank
Namespace: MuradyanVano\LexoRank
Author: Vano Muradyan
Demo: php-lexorank-demo-app
1. Overview
LexoRank assigns each item a string rank. Sorting by that string matches logical order. Inserting between two items computes a new rank from neighbours only — O(1) per move, no cascade updates.
This implementation uses base-36 digit arrays (no floats, BCMath, or GMP), three rotating buckets for safe rebalance migrations, and an optional Laravel layer (cast, trait, facade).
2. Features
- Immutable
LexoRankvalue objects with canonical serialization between(),before(),after()with scale expansion for adjacent ranks- Bulk allocation via recursive midpoint partitioning (
betweenMany,initialRanks) - Rebalancer with explicit old→new mapping (no hidden DB I/O)
strcmpon canonical strings matchescompareTo()- Laravel:
LexoRankCast,HasLexoRank,LexoRankServiceProvider,LexoRankFacade - PHPStan level 9, strict types, MIT license
3. Requirements
- PHP ^8.1 (framework-independent core)
- Laravel integration is optional (not a runtime dependency)
- Developing/testing the Laravel layer needs PHP 8.2+ and an explicit install of Laravel 12.61.1+ / Testbench 10 (not part of default
require-dev, so PHP 8.1composer updatekeeps working)
4. Installation
Laravel apps auto-discover the service provider. Publish config:
5. Quick start
Demo application
A complete Laravel and React demonstration is available in php-lexorank-demo-app.
The app is a polished drag-and-drop Kanban board with a Laravel REST API and a React SPA. It shows real-world rank generation, insertion at the start/end/between neighbours, same-column and cross-column moves, canonical persistence, Eloquent cast and HasLexoRank usage, container/service wiring, diagnostics, duplicate detection, bucket visibility, manual rebalancing, reload-safe ordering, and an API-driven LexoRank playground.
Demo stack: Laravel 13, React 19, TypeScript, Tailwind CSS v4, and dnd-kit.
The demo lives in a separate repository as a practical integration example. Its Laravel 13 app stack does not change this package’s official support matrix — see Laravel integration (CI-verified Laravel 12.61.1+).
6. Rank format
Canonical shape: {bucket}|{integer}:{fraction}
| Part | Rule |
|---|---|
| Bucket | 0, 1, or 2 |
| Integer | Base-36 (0-9a-z), zero-padded to 6 digits |
| Fraction | Base-36 after :, trailing zeros stripped |
| Radix | : always present (e.g. 0|hzzzzz:) |
Sentinels (bucket 0):
| Constant | Value |
|---|---|
| Min | 0\|000000: |
| Max | 0\|zzzzzz: |
| Middle | 0\|hzzzzz: |
| Initial | 0\|100000: |
7. Buckets
Three buckets rotate 0 → 1 → 2 → 0 for rebalance migrations. Use inNextBucket() / inPreviousBucket() / withBucket() to move the decimal to another bucket without changing its numeric value.
8. LexoRank API
| Method | Description |
|---|---|
min(?LexoRankBucket $bucket = null) |
Minimum rank |
max(?LexoRankBucket $bucket = null) |
Maximum rank |
middle(?LexoRankBucket $bucket = null) |
Midpoint between min and max |
initial(?LexoRankBucket $bucket = null) |
Starting rank for empty lists |
parse(string $rank, int $maxLength = 255) |
Parse or throw |
tryParse(string $rank, int $maxLength = 255) |
Parse or null |
between(LexoRank $other) |
Strictly between (same bucket) |
before() |
Previous rank (step 8, or midpoint near bounds) |
after() |
Next rank |
compareTo(LexoRank $other) |
<=> ordering |
equals, isBefore, isAfter |
Comparisons |
bucket() |
LexoRankBucket |
value(), toString(), __toString() |
Canonical string |
inNextBucket(), inPreviousBucket(), withBucket() |
Bucket moves |
isMin(), isMax() |
Boundary checks |
length() |
Serialized byte length |
9. LexoRankBucket API
| Method | Description |
|---|---|
bucket0(), bucket1(), bucket2(), all() |
Factories |
fromString(string), fromId(int) |
Parse or throw |
tryFromString(string) |
Parse or null |
next(), previous() |
Rotation |
equals, compareTo, value(), id(), toString() |
Accessors |
10. LexoRankService API
Constructor: new LexoRankService(int $maxCount = 100_000, int $maxRankLength = 255)
| Method | Description |
|---|---|
parse, tryParse |
Respect service maxRankLength |
min, max, middle, initial |
Delegates to LexoRank |
between(?LexoRank $lower, ?LexoRank $upper) |
Open-ended bounds; enforces max length |
betweenMany(?$lower, ?$upper, int $count) |
Bulk strictly ordered ranks |
initialRanks(int $count, ?LexoRankBucket $bucket = null) |
Evenly spaced in bucket |
findDuplicates(iterable $ranks) |
Returns duplicate canonical strings |
assertNoDuplicates(iterable $ranks) |
Throws DuplicateRankException |
maxRankLength() |
Configured limit |
11. LexoRankCollection
Also: all(), count(), isEmpty(), isStrictlyOrdered(), maxLength().
12. Rebalancing
When rank strings grow long from dense inserts, redistribute into the next bucket:
Apply mapping() inside a database transaction. See docs/rebalancing.md.
13. Laravel integration
Optional. The core installs without Laravel. Supported integration testing target:
| Laravel | Testbench | PHP |
|---|---|---|
| 12.61.1+ | ^10 | 8.2+ |
Default composer update in this repo does not install Laravel (so PHP 8.1 works). For Laravel tests:
Laravel 10/11 are not claimed or CI-verified (unpatched advisories on those lines).
Cast:
Trait:
Facade (alias LexoRankFacade):
Full guide: docs/laravel.md.
14. Configuration (Laravel)
| Key | Default | Description |
|---|---|---|
max_count |
100_000 |
Bulk allocation cap |
max_rank_length |
255 |
Max generated rank length |
column |
rank |
Default column name (trait uses $lexoRankColumn) |
15. Database recommendations
- Column:
VARCHAR(255)(or equivalent), UNIQUE - Store canonical strings from
$rank->toString() - Scope uniqueness per list: composite
(list_id, rank)when needed - Order:
ORDER BY rank ASCwithin a single bucket
16. Exceptions
Namespace: MuradyanVano\LexoRank\Exception\
| Class | When |
|---|---|
LexoRankException |
Base InvalidArgumentException |
InvalidRankFormatException |
Bad input string |
InvalidBucketException |
Invalid bucket |
InvalidBoundsException |
Bad between() bounds |
DuplicateRankException |
Duplicate rank in set |
InvalidRebalanceInputException |
Bad rebalance input |
RankSpaceExhaustedException |
Min/max exhausted or rank too long |
17. Compatibility boundary
Inspired by Atlassian LexoRank and community references (e.g. kvandake). Not a byte-for-byte clone.
- Same general format and base-36 lowercase alphabet
- Not guaranteed: identical midpoint strings vs Jira or other implementations
Always parse() external ranks and persist canonical output. Details: docs/architecture.md.
18. Documentation
| Document | Contents |
|---|---|
| docs/architecture.md | Design, public vs internal API |
| docs/algorithm.md | Grammar, math, invariants |
| docs/laravel.md | Eloquent, migrations, transactions |
| docs/rebalancing.md | Rebalance procedure, concurrency |
| docs/troubleshooting.md | Common errors |
| Demo Application | Laravel 13 + React 19 Kanban demo (separate repo) |
19. Development
Scripts:
| Command | Action |
|---|---|
composer test:core |
PHPUnit Unit + Integration (PHP 8.1+) |
composer test |
All suites (Laravel suite needs extra deps on PHP 8.2+) |
composer analyse |
PHPStan level 9 (core; src/Laravel excluded) |
composer format-check |
PHP CS Fixer dry run |
composer validate-package |
Composer schema strict (composer validate --strict) |
20. Contributing
See CONTRIBUTING.md. Please run composer check before opening a PR.
21. Security
See SECURITY.md for vulnerability reporting and input validation notes.
22. License
MIT © Vano Muradyan
Acknowledgments
LexoRank concept by Atlassian. This library implements an independent PHP design with digit-array arithmetic and documented compatibility limits.
