# php_snowflake

**Repository Path**: towers/php_snowflake

## Basic Information

- **Project Name**: php_snowflake
- **Description**: 推特分布式主键生成算法的php扩展
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 4
- **Created**: 2016-08-05
- **Last Updated**: 2024-11-22

## Categories & Tags

**Categories**: utils

**Tags**: None

## README

# php_snowflake

[中文文档](https://github.com/Sxdd/php_snowflake/wiki/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3)
## What is php_snowflake?

Twitter distributed ID generating Algorithm [SnowFlake](https://github.com/twitter/snowflake) PHP implementation version.

## Requires
* PHP >= 5.6  (Below 5.5 self-testing)
* Linux

## Description
Pure PHP can not be achieved SnowFlake algorithm，because version of thread-safe(requires tid)and 
non-thread-safe(requires pid)can not generate same the format id(The only tid of this project system, 
so don't worried about pid conflict of multiple processes). And PHP as scripting language can not maintain sequence,
sequence will be initialized again when the script is finished. In case of high concurrency pure PHP 
Implemented version of  Snowflate algorithm does not have any effect. So was born this project, 
below is the different of Thread-safe version and Non-thread-safe version.

### Non-thread-safe version (NTS)
```
0　2　　　　　　    15　　　　　　 　20   28　　　   32
---+----------------+--------------+----+----------+
00 |timestamp(ms)  | service_no 　 |pid | sequence |
---+----------------+--------------+----+----------+
```

### Thread-safe version (TS)
```
0　2　　　　　 　   15　　　　　　 　20   28　　　   32
---+----------------+--------------+----+----------+
00 |timestamp(ms)  | service_no 　 |tid | sequence |
---+----------------+--------------+----+----------+
```

## Installation
```
phpize
./configure --with-php-config=/you/phppath/php-config
make
make install
```
## Example
Attention： Interval of $service_no in the range of 0-99999. Beyond that scope, PHP will report a fatal mistake.
```
$service_no = 999;
for ($i=0; $i < 10; $i++) { 
        echo PhpSnowFlake::nextId($service_no)."\n";
}
/*

00146523488416500999000634280001
00146523488416500999000634280002
00146523488416500999000634280003
00146523488416500999000634280004
00146523488416500999000634280005
00146523488416600999000634280001
00146523488416600999000634280002
00146523488416600999000634280003
00146523488416600999000634280004
00146523488416600999000634280005

*/
```
## License
Copyright (c) 2016 by [Towers](http://towers.pub) released under MIT License.