Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinri/ark
A fundamental toolkit for PHP 7
https://github.com/sinri/ark
php-framework php-library php7
Last synced: 2 months ago
JSON representation
A fundamental toolkit for PHP 7
- Host: GitHub
- URL: https://github.com/sinri/ark
- Owner: sinri
- License: mit
- Created: 2018-02-13T02:51:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T05:11:53.000Z (8 months ago)
- Last Synced: 2024-12-02T00:15:17.217Z (2 months ago)
- Topics: php-framework, php-library, php7
- Language: PHP
- Homepage: https://sinri.github.io/Ark/
- Size: 406 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ark
[](https://raw.githubusercontent.com/sinri/Ark/master/LICENSE)
[](https://github.com/sinri/Ark/releases)
[](https://packagist.org/packages/sinri/ark)
A fundamental toolkit for PHP 7.
```bash
composer require sinri/ark
```
It is a new generation for [Enoch Project](https://github.com/sinri/enoch), as which might continuously support projects in PHP 5.4+.
If you have problem to connect to GitHub or too slow, try use mirror:
`composer config repo.packagist composer https://mirrors.aliyun.com/composer/`
> And every living substance was destroyed which was upon the face of the ground, both man, and cattle, and the creeping things, and the fowl of the heaven; and they were destroyed from the earth: and Noah only remained [alive], and they that [were] with him in the ark. (Genesis 7:23)
## Environment
Ark requests PHP 7.
If you need Redis, you might need to declare the reference of `predis/predis`.
Since version 2.1, Ark-Core and Ark-Curl use version 2.
Since version 2.4, Ark-Cache use version 2 to support PSR-16.
Since version 3.3, Ark-Web became independent as 1.0.0.
Now Ark has been in 3.x.
## Toolkit Map
### Components
Basic Functions
* `sinri/ark-core` [](https://packagist.org/packages/sinri/ark-core)
* `sinri/ark-web` [](https://packagist.org/packages/sinri/ark-web)
* `sinri/ark-curl` [](https://packagist.org/packages/sinri/ark-curl)
* `sinri/ark-cache` [](https://packagist.org/packages/sinri/ark-cache)
* `sinri/ark-xml` [](https://packagist.org/packages/sinri/ark-xml)
Database Related
* `sinri/ark-pdo` [](https://packagist.org/packages/sinri/ark-pdo)
* `sinri/ark-mysqli` [](https://packagist.org/packages/sinri/ark-mysqli)
* `sinri/ark-sqlite3` [](https://packagist.org/packages/sinri/ark-sqlite3)
* `sinri/ark-couchdb` [](https://packagist.org/packages/sinri/ark-couchdb)
* `sinri/ark-redis` [](https://packagist.org/packages/sinri/ark-redis)
Email Related
* `sinri/ark-mail` [](https://packagist.org/packages/sinri/ark-mail)
* `sinri/ark-imap` [](https://packagist.org/packages/sinri/ark-imap)
Queue Related
* `sinri/ark-queue` [](https://packagist.org/packages/sinri/ark-queue)
* `sinri/ark-lock` [](https://packagist.org/packages/sinri/ark-lock)
* `sinri/ark-event` [](https://packagist.org/packages/sinri/ark-event)
Lightweight Directory Access Protocol
* `sinri/ark-ldap` [](https://packagist.org/packages/sinri/ark-ldap)
QR Code
* `sinri/ark-qr-builder` [](https://packagist.org/packages/sinri/ark-qr-builder)
Remote File System Access
* `sinri/ark-ftp` [](https://packagist.org/packages/sinri/ark-ftp)
* `sinri/ark-sftp` [](https://packagist.org/packages/sinri/ark-sftp)
WebSocket Server
* `sinri/ark-websocket` 
### Independent Toolkit
Class ArkHelper is designed for the convenience of developing, it help you to operate data structure safely, and some environment shortcuts.
Class ArkLogger is an implementation of [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md).
You might create an instance with certain log storage path, or use a silent one as default.
Class ArkCurl provides a higher level usage of CURL.
Class ArkCache defined the interface of being a cache handler, and implementations by File System and Redis, also the fallback choice Dummy.
(Note, if you want to use Redis, `predis/predis` is needed in `composer.json`.)
Class ArkPDO with model encapsulation are there for you Database Operation.
Class ArkSqlite3 is an extended tool for working on SQLite3.
### Web Toolkit
The main reference is `Ark()`, which would provide a singleton of class TheArk.
For web service, Class TheArk contains:
* Method `webInput`, give the global instance of class ArkWebInput.
* Method `webOutput`, give the global instance of class ArkWebOutput.
* Method `webService`, give the global instance of class ArkWebService.
For general routines, the multi-instance hubs (register and get) are provided:
* Hub for ArkPDO
* Hub for ArkLogger
* Hub for ArkCache
### CLI Toolkit
Class ArkCliProgram is designed to support a whole CLI project with certain namespace and class rule.
### Server Config Reference
If you use Apache to load the project, you need to add the .htaccess file and open the allow override option.
```apacheconfig
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]
```
For Nginx, you should use try_files.
```nginx
server {
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
}
```
## Who use this?
Not so many in fact. Amongst them, Leqee is one.
## Donation
BitCoin/BTC: 18wCjV8mnepDpLzASKdW7CGo6U8F9rPuV4
Alipay Account:
