Download the PHP package redis/ranking without Composer

On this page you can find all versions of the php package redis/ranking. 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 redis/ranking

Informations about the package ranking

Ranking API for Redis

Stable Version Download Count

A small, typed wrapper around a Redis sorted set for rankings and leaderboards: users are members, their scores order them.

Used in production by AKB勝手に総選挙 (source).

Requirements

Installation

Usage

Method Redis Returns
setUserScore($user, $score) ZADD bool true when the user was added
incrementScore($user, $delta) ZINCRBY float new score
getScore($user) ZSCORE ?float
getRank($user) / getRevRank($user) ZRANK / ZREVRANK ?int 0-based, from the lowest / highest score
getRange($start, $end) / getRevRange(...) ZRANGE / ZREVRANGE list<string>
getRangeWithScores(...) / getRevRangeWithScores(...) ZRANGE / ZREVRANGE WITHSCORES array<user, float>
getRangeByScores($min, $max, $offset, $count) ZRANGEBYSCORE list<string>
getRangeByScoresWithScores(...) ZRANGEBYSCORE WITHSCORES array<user, float>
countUsers() / countUsersByScores($min, $max) ZCARD / ZCOUNT int
deleteUser($user) ZREM bool true when the user was there
deleteUsersByScores($min, $max) / deleteUsersByRanks($start, $end) ZREMRANGEBYSCORE / ZREMRANGEBYRANK int removed
deleteAllUser() MULTI ZRANGE + DEL list<string> the removed users
expire($ms, ?ExpireMode) / ttl() PEXPIRE / PTTL bool / ?int ms

More: sample/usecase.php, sample/benchmark.php.

Upgrading from 1.x

2.0 is typed and requires PHP 8.3 and phpredis 6. Code changes:

1.x 2.0
new Ranking() connected to 127.0.0.1 itself pass the key and a connected Redis: new Ranking($key, $redis)
getScore() / getRank() returned false for a missing user they return null
setUserScore() returned an int returns bool (true when added)
getRange($start, $end, true) getRangeWithScores($start, $end); same for getRevRange and getRangeByScores
getRangeByScores($min, $max, $withscores, $offset, $count) getRangeByScores($min, $max, $offset, $count); a count with offset 0 now works
deleteUser() returned an int returns bool
countUsers(), deleteUser(), deleteAllUser() failed on phpredis 6 (zSize/zDelete) work
Ranking::STATUS_OK / STATUS_FAILURE removed
class could be extended final
PSR-0 autoload PSR-4; the class name Matsubo\Redis\Ranking is unchanged

Development

Everything runs in Docker (PHP, phpredis, Redis):

History

License

Released under the Apache License, Version 2.0.

All versions of ranking with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
ext-redis Version ^6.0
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 redis/ranking contains the following files

Loading the files please wait ...