hyperf/docs/en
2022-03-01 11:38:31 +08:00
..
component-guide fix en 2020-06-22 09:58:59 +08:00
db Update doc 2022-02-16 02:13:55 +08:00
imgs Correct the translations on Mar 31, 2021 (#3440) 2021-04-02 12:58:11 +08:00
middleware Use Hyperf/Context/Context instead of Hyperf/Utils/Context. (#4565) 2022-03-01 11:13:47 +08:00
quick-start Added type and default value for Attribute when using ide-helper. (#4352) 2021-12-13 18:35:02 +08:00
tutorial Changed the recommend subnet for swarm network. (#4115) 2021-10-06 14:10:46 +08:00
upgrade Update doc 2022-02-16 02:13:55 +08:00
amqp.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
annotation.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
aop.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
async-queue.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
awesome-components.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
cache.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
changelog.md Release v2.2.3 2021-08-09 09:37:46 +08:00
circuit-breaker.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
command.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
communication.md Translating the introduction section (About, Communication, Donate, Contribute), update the README.md to match the new About section, adding a CONTRIBUTING.md file to match the contribute section (#4105) 2021-09-29 11:54:56 +08:00
config-center.md fix typo 2020-07-21 17:45:08 +08:00
config.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
consul.md Fix incorrect markdown links in the documentation 2021-09-22 14:22:06 +08:00
contribute.md Translating the introduction section (About, Communication, Donate, Contribute), update the README.md to match the new About section, adding a CONTRIBUTING.md file to match the contribute section (#4105) 2021-09-29 11:54:56 +08:00
controller.md Correct translations on Mar 22, 2021 (#3413) 2021-03-23 18:21:18 +08:00
coroutine-server.md Update doc 2022-02-16 02:13:55 +08:00
coroutine.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
crontab.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
dag.md Update doc 2022-02-16 02:13:55 +08:00
devtool.md Correct translations on Mar 22, 2021 (#3413) 2021-03-23 18:21:18 +08:00
di.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
donate.md Translating the introduction section (About, Communication, Donate, Contribute), update the README.md to match the new About section, adding a CONTRIBUTING.md file to match the contribute section (#4105) 2021-09-29 11:54:56 +08:00
elasticsearch.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
etcd.md Update doc 2022-02-16 02:13:55 +08:00
event.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
exception-handler.md Translate exception-handler, grpc, and guzzle from zh-cn to en. 2021-03-31 18:19:43 +08:00
grpc.md 更改grpc文档,代码位置变更 (#3847) 2021-07-22 11:09:39 +08:00
guzzle.md Correct the translations on Mar 31, 2021 (#3440) 2021-04-02 12:58:11 +08:00
jet.md Update jet.md 2020-08-11 01:39:21 +08:00
json-rpc.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
kafka.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
lifecycle.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
logger.md Fixed multiple handlers description error for logger. 2021-07-06 18:50:01 +08:00
memory.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
microservice.md Translate json-rpc, logger and microservice from zh-cn to en. Apr 8, 2021 (#3461) 2021-04-08 18:00:29 +08:00
nacos.md Update doc 2022-02-16 02:13:55 +08:00
nano.md Do not separate the docs folders by version, use git branch to distinguish the difference versions docs 2020-06-11 13:55:15 +08:00
nsq.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
paginator.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
phar.md Update doc 2022-02-16 02:13:55 +08:00
pool.md Translate paginator, pool and rate-limit from zh-cn to en. Apr 18, 2021 (#3496) 2021-04-18 17:12:52 +08:00
process.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
rate-limit.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
README.md Translating the introduction section (About, Communication, Donate, Contribute), update the README.md to match the new About section, adding a CONTRIBUTING.md file to match the contribute section (#4105) 2021-09-29 11:54:56 +08:00
redis.md Update redis.md 2020-08-11 00:28:32 +08:00
release-planning.md Update release planning 2022-02-25 19:18:20 +08:00
request.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
response.md Translate 2020-08-11 00:08:36 +08:00
router.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
rpc-multiplex.md Update doc 2022-02-16 02:13:55 +08:00
rpn.md Update doc 2022-02-16 02:13:55 +08:00
scout.md Update doc 2022-02-16 02:13:55 +08:00
service-register.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
session.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
snowflake.md Translation for snowflake 2020-10-25 10:04:13 +01:00
socketio-server.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
summary.md Update doc 2022-02-16 02:13:55 +08:00
swoole-tracker.md Upgrade the minimum php version to 8.0 for swoole_tracker (#4279) 2021-11-22 15:46:47 +08:00
testing.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
tracer.md Added document for using enable in @Crontab. (#3666) 2021-06-04 21:33:16 +08:00
utils.md Split hyperf/coordinator from hyperf/utils. (#4225) 2021-11-05 16:06:17 +08:00
validation.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
versions.md Update the english doc 2020-07-27 02:32:06 +08:00
view-engine.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
view.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
watcher.md Update watcher.md 2020-12-29 15:11:48 +08:00
websocket-client.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00
websocket-server.md Update English document about Annotation. 2022-01-13 12:09:04 +08:00

Introduction

Hyperf is an extremely performant and flexible PHP CLI framework, powered by a state-of-the-art coroutine server and a large number of battle-tested components. Aside from decisively beating PHP-FPM frameworks in benchmarks, Hyperf is unique in its focus on flexibility and composition. Hyperf ships with an AOP-enabling (aspect-oriented programming) dependency injector to ensure components and classes are pluggable and meta-programmable. All of Hyperf's core components strictly follow PSR standards and can be used in other frameworks.

Hyperf's architecture is built using a combination of Coroutines, Dependency injection, Events, Annotations, and AOP. In addition to providing MySQL, Redis and other common coroutine clients, Hyperf also provides coroutine compatible versions of WebSocket server / client, JSON RPC server / client, gRPC server / client, Zipkin/Jaeger (OpenTracing) client, Guzzle HTTP client, Elasticsearch client, Consul client, ETCD client, AMQP component, Apollo configuration center, Aliyun ACM, ETCD configuration center, Token bucket algorithm-based limiter, Universal connection pool, Circuit breaker, Swagger, Swoole Tracker, Snowflake, Simply Redis MQ, RabbitMQ, NSQ, Nats, Seconds level crontab, Custom Processes, etc. Therefore, developers can entirely avoid implementing coroutine compatible versions of these libraries.

Rest assured, Hyperf is still a PHP framework. Hyperf provides all the packages you expect: Middleware, Event Manager, Coroutine-optimized Eloquent ORM (and Model Cache!), Translation, Validation, View engine (Blade/Smarty/Twig/Plates/ThinkTemplate) and more.

Origin

Although there are many new PHP frameworks, we still haven't found a framework that matches an elegant design with ultra-high performance, nor have we found a framework that paves the way for PHP microservices. With this vision in mind, we will continue to invest in the future of this framework, and you are welcome to join us in contributing to the open-source development of Hyperf.

Design Goals

Hyperspeed + Flexibility = Hyperf. The equation hidden in our name exhibits Hyperf's founding ambition.

Hyperspeed: Leveraging Swoole and Swow coroutines, Hyperf is capable of handling massive amounts of traffic. The Hyperf team made many optimizations to the framework to eliminate every bottleneck between the end-user and our blazing engine.

Flexibility: We believe our Dependency Injection component is best in class. With the help of Hyperf DI, components and classes are all pluggable and meta-programmable. Inversely, all Hyperf components are meant to be shared with the world. Our commitment to PSR standards means that you can use Hyperf components in any compatible framework.

Via these traits, Hyperf has discovered the untapped potential in many fields: implementing Web servers, gateway servers, distributed middleware software, microservices architecture, game servers, and Internet-of-Things (IoT).

Production ready

Alongside our well-maintained, multilingual documentation, a large number of unit tests for each component ensure logical correctness. Before Hyperf was released to the public (2019-06-20), it was used privately for multiple services in series-C and series-B Internet companies, which have been running without incident for years in harsh production environments.