PHPackages                             natanaelsimoes/zeus-framework - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. natanaelsimoes/zeus-framework

AbandonedArchivedLibrary[Framework](/categories/framework)

natanaelsimoes/zeus-framework
=============================

A lightweight framework with an annotation-based approach for routing

0.1.2(9y ago)3581MITPHPPHP >=5.4.0

Since Mar 14Pushed 8y ago1 watchersCompare

[ Source](https://github.com/natanaelsimoes/zeus-framework)[ Packagist](https://packagist.org/packages/natanaelsimoes/zeus-framework)[ Docs](https://github.com/natanaelsimoes/zeus-framework)[ RSS](/packages/natanaelsimoes-zeus-framework/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Zeus Framework
==============

[](#zeus-framework)

A lightweight framework with an annotation-based approach for routing.

Usage
-----

[](#usage)

Using annontation `@Route` you set a unique pattern. When Zeus detect this pattern in a request, redirects to properly class/method and execute it STATICALLY.

```

```

Installation
------------

[](#installation)

This library can be found on [Packagist](https://packagist.org/packages/natanaelsimoes/zeus-framework). We endorse that everything will work fine if you install this through [composer](http://getcomposer.org).

Add in your `composer.json`:

```
{
    "require": {
        "natanaelsimoes/zeus-framework": "0.1.0"
    }
}
```

or in your bash:

```
$ composer require natanaelsimoes/zeus-framework
```

You need to create 2 files on your project root folder: `zeus.json` containing Zeus configuration (see more at Configuration section below), and `index.php`just calling Zeus for the first time.

```

```

Configuration
-------------

[](#configuration)

To configure Zeus, a `zeus.json` file needs to be created at project root folder. Following is the configuration file with all possible parameters.

```
{
    "database": {
        "driver": "mysql",
        "host": "localhost",
        "port": "3306",
        "dbname": "information_schema",
        "username": "root",
        "password": ""
    },
    "routes": {
        "initialDirectory": "src/",
        "index": "post"
    },
    "development": true,
    "cache": "xcache"
}
```

### Database

[](#database)

Database connection is provided by [Doctrine](http://www.doctrine-project.org). Drivers supported are `pdo_mysql`, `pdo_sqlite`, `pdo_pgsql`, `pdo_oci`, `pdo_sqlsrv`, `oci8`.

If your project will not use any database, you can remove this parameter.

### Routes

[](#routes)

**! This parameter is MANDATORY !**

It tells the framework to look recursively inside `initialDirectory` for methods with `@Route` annotation. When no pattern is given by user (as for homepage), `index` informs what pattern to execute.

### Development

[](#development)

**! This parameter is MANDATORY !**

Sets the project to `development` mode (if true) or production mode (if false)

### Cache

[](#cache)

If you need to use a cache system, in `cache` parameter inform which of the following will be used by framework:

- apc (APC)
- couchbase (Couchbase)
- file (Filesystem, saved on /cache in root)
- mem (Memcached)
- mongodb (MongoDB, not implemented yet)
- phpfile (PhpFile, saved on /cache in root)
- redis (Redis)
- riak (Riak, not implemented yet)
- wincache (WinCache)
- xcache (Xcache)
- zend (ZendData)
- none (No cache is used)

Cache is made currently based on URL. Inside the class/method you want to cache, do as follow:

```
/** @Route("post/create") */
public static function create()
{
    Zeus\Cache::getInstance()->getCache();
    // code goes here
    Zeus\Cache::getInstance()->setCache();
}
```

Method `Zeus\Cache::getInstance()->getCache()` verifies if there is a valid cache version of what user requested. If exists, prints and performs `exit`. If not valid (expired ttl) or not exists, continues generating the page normaly, then creates the cached version at `Zeus\Cache::getInstance()->setCache()`.

If your project will not use cache, you can remove this parameter.

Testing
-------

[](#testing)

For testing you need to change parameter "url" in `test.json` providing HTTP path to test/ folder

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~90 days

Total

3

Last Release

3532d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c36bd61b716cbfeeede3348b244019a045b340412104be4c4e6c80e9b9146d0c?d=identicon)[natanaelsimoes](/maintainers/natanaelsimoes)

---

Top Contributors

[![natanaelsimoes](https://avatars.githubusercontent.com/u/1112479?v=4)](https://github.com/natanaelsimoes "natanaelsimoes (4 commits)")

---

Tags

phpframeworkannotation

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/natanaelsimoes-zeus-framework/health.svg)

```
[![Health](https://phpackages.com/badges/natanaelsimoes-zeus-framework/health.svg)](https://phpackages.com/packages/natanaelsimoes-zeus-framework)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)