PHPackages                             arvici/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. arvici/framework

ActiveLibrary[Framework](/categories/framework)

arvici/framework
================

Arvici Framework

1.2.1(8y ago)31371MITPHPPHP >=5.6.0CI failing

Since Apr 9Pushed 6y ago1 watchersCompare

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

READMEChangelog (10)Dependencies (18)Versions (23)Used By (1)

Arvici Framework - Framework Core Package
=========================================

[](#arvici-framework---framework-core-package)

[![Build Status](https://camo.githubusercontent.com/8bae879b09f068148f7ba2af4c9d6e8795e22f2918c9692c5699273c69c12a17/68747470733a2f2f7472617669732d63692e6f72672f6172766963692f6672616d65776f726b2e737667)](https://travis-ci.org/arvici/framework)[![License](https://camo.githubusercontent.com/9ca825ccea33cb29aade6c7c52e9d7912663f7de86d0417147ed5ce8f207acdc/68747470733a2f2f706f7365722e707567782e6f72672f6172766963692f6672616d65776f726b2f6c6963656e7365)](https://packagist.org/packages/arvici/framework)[![Coverage Status](https://camo.githubusercontent.com/93810c44b8d99337c995048060c85f7d1c2796fc5e806ef3ff3130e7b71205eb/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6172766963692f6672616d65776f726b2f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)](https://coveralls.io/github/arvici/framework?branch=master)[![Codacy Badge](https://camo.githubusercontent.com/68922e9532afdf0d22f67a24800cf573ca714ee8794143ceba0815eef56eedb0/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f636f7665726167652f3231643135333266326533333462616362303836373131646532656231373938)](https://www.codacy.com/app/tomvalk/arvici-framework)[![Codacy Badge](https://camo.githubusercontent.com/db4cd504c20870853b67b3ae85b0dcdd68c446dcac466819cf2dbc1ccb5d633d/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f67726164652f3231643135333266326533333462616362303836373131646532656231373938)](https://www.codacy.com/app/tomvalk/arvici-framework)

[![Latest Stable Version](https://camo.githubusercontent.com/7192f4d6a97694d14aaed3931ad6f670d5353b9a3cad3002ad783eef76fece0b/68747470733a2f2f706f7365722e707567782e6f72672f6172766963692f6672616d65776f726b2f762f737461626c65)](https://packagist.org/packages/arvici/framework)[![Latest Unstable Version](https://camo.githubusercontent.com/3f8182fa81db1c0c5b2b70e76dc04bc52e7e0339b62a30ab82c9a79b2c865b8c/68747470733a2f2f706f7365722e707567782e6f72672f6172766963692f6672616d65776f726b2f762f756e737461626c65)](https://packagist.org/packages/arvici/framework)[![Dependency Status](https://camo.githubusercontent.com/761370566ab789f573984daf2a7b151dbdfde0db6f7e73118a17d0eecc32cd86/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3536393865346633616637383962303032373030316565322f62616467652e7376673f7374796c653d666c6174)](https://www.versioneye.com/user/projects/5698e4f3af789b0027001ee2)

Arvici Framework

Introduction
============

[](#introduction)

This package contains the core functionality of the Arvici Framework. Currently being in development!

Getting started
===============

[](#getting-started)

Using this package is for experts only, please follow the link bellow to get instructions on how to get started with the framework. [Getting started, use composer create-project](https://github.com/arvici/arvici#arvici-framework---start-project)

Components
==========

[](#components)

Router
------

[](#router)

You can define your routes in the Router.php configuration. Define your routes with the Router::define method.

Example:

```
Router::define(function(Router $router) {
    $router->get('/',           '\App\Controller\Welcome::index');
    $router->get('/session',    '\App\Controller\Welcome::session');
    $router->get('/json',       '\App\Controller\Welcome::json');
    $router->get('/exception',  '\App\Controller\Welcome::exception');
});
```

Database
--------

[](#database)

Configuration of your database is located in the Database.php.

Example:

```
Configuration::define('database', function() {
    return [
        /**
         * The default fetch type to use.
         */
        'fetchType' => \Arvici\Heart\Database\Database::FETCH_ASSOC,

        /**
         * Database Connection names and configuration values.
         *
         * 'default' is used when no connection name is provided, or using SweetORM.
         */
        'connections' => [
            'default' => [
                'driver'        => 'MySQL',
                'host'          => 'localhost',
                'username'      => 'root',
                'password'      => '',
                'port'          => 3306,
                'database'      => 'arvici_test'
            ],
        ]
    ];
});
```

Models/ORM
----------

[](#modelsorm)

When using the ORM, check the separate documentation:

Caching
-------

[](#caching)

To use the Caching system, you have to define the Caching configuration or use the FileSystem by default.

Configuration file `Cache.php`:

```
Configure::define('cache', function () {
    return [

        /**
         * Enable cache.
         */
        'enabled' => true,

        /**
         * Set to true to enable cache even in non-production mode.
         */
        'forceEnabled' => true,

        /**
         * Cache Pool Configuration.
         */
        'pools' => [
            'default' => [
                'driver' => '\Stash\Driver\FileSystem',
                'options' => [
                    'path' => BASEPATH . 'cache' . DS,
                ]
            ],
        ],

    ];
});
```

### Using the cache pools

[](#using-the-cache-pools)

To retrieve a pool (where you can save and get items) you have to use the Manager:

```
$manager = \Arvici\Component\Cache::getInstance();
```

In the next step you need to get the Pool. The pool is configured in your configuration file.

```
$pool = $manager->getPool(); // pool name = 'default'
// or with a pool name:
$pool = $manager->getPool('redis-cache'); // pool name = 'redis-cache'
```

To retrieve, save or use an item you first have to get the context. With the instance of Item you can read and manipulate the content.

Examples of usage:

```
$item = $pool->get('test/cachingkey');
$item->set($data);

$expiration = new DateTime('2020-01-21');
$item->expiresAfter($expiration);

$item->save();

$data = $item->get();

$item->isMiss(); // bool
```

### More information

[](#more-information)

The caching library that is used is Stash. For more information on using the pools see:

License
=======

[](#license)

MIT License, see LICENSE file.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity68

Established project with proven stability

 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 ~39 days

Recently: every ~95 days

Total

19

Last Release

2971d ago

Major Versions

0.6.0 → 1.0.02016-10-19

1.2.0 → 2.0.0-rc.12017-07-03

PHP version history (2 changes)0.1.0PHP >=5.6.0

2.0.0-rc.1PHP >=7.0.0

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

arvici-frameworkphpphp-frameworkrouterframeworkSimplesmartarvici

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)[elgg/elgg

Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications.

1.7k15.7k5](/packages/elgg-elgg)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

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