PHPackages                             as3/modlr-bundle - 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. as3/modlr-bundle

ActiveLibrary

as3/modlr-bundle
================

Symfony bundle for the Modlr REST ODM library.

217.1k1[1 issues](https://github.com/as3io/As3ModlrBundle/issues)2PHP

Since Oct 19Pushed 9y ago3 watchersCompare

[ Source](https://github.com/as3io/As3ModlrBundle)[ Packagist](https://packagist.org/packages/as3/modlr-bundle)[ RSS](/packages/as3-modlr-bundle/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (2)

As3ModlrBundle
==============

[](#as3modlrbundle)

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/98f44073b55423d65bd55ab024377dad32335787cbdcc736b92a039314bd7716/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f617333696f2f4173334d6f646c7242756e646c652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/as3io/As3ModlrBundle/?branch=master) [![Build Status](https://camo.githubusercontent.com/d13f19038a3e730e4c73a53d402b23032d628746fa92f06141adc6ba7cf63289/68747470733a2f2f7472617669732d63692e6f72672f617333696f2f4173334d6f646c7242756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/as3io/As3ModlrBundle) [![Packagist](https://camo.githubusercontent.com/97898ef896ddb68d07c4925e03014115e920b009a60ef4dccaeb1c4960dd0689/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6173332f6d6f646c722d62756e646c652e737667)](https://packagist.org/packages/as3/modlr-bundle) [![SensioLabsInsight](https://camo.githubusercontent.com/82a774c2248ca269382b43068034fe445024f6c7cc607e7ab17d3ad8ecd73670/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f36643764353330632d663430352d343831352d383437612d3466376666383239363063352f6d696e692e706e67)](https://insight.sensiolabs.com/projects/6d7d530c-f405-4815-847a-4f7ff82960c5)

Integrates the modlr REST libraries with Symfony.

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

[](#installation)

To utilize modlr, you **must** install a persister and an api specification.

To utilize search within modlr, you must install a search client.

Available modules can be found [here](http://github.com/as3io), or you can write your own!

### Install packages with Composer

[](#install-packages-with-composer)

To install this bundle with support for [MongoDB](http://mongodb.org), [elasticsearch](http://elasticsearch.org) and the [JSON Api Spec](http://jsonapi.org), add the following to your composer.json file:

```
{
    "require": {
        "as3/modlr-bundle": "dev-master",
        "as3/modlr-api-jsonapiorg": "dev-master",
        "as3/modlr-search-elastic": "dev-master",
        "as3/modlr-persister-mongodb": "dev-master"
    }
}

```

Then, tell Composer to update and install the requested packages:

```
composer update as3/modlr-bundle --with-dependencies

```

### Register the Bundle

[](#register-the-bundle)

Once installed, register the bundle in your `AppKernel.php`:

```
// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // ...
        new As3\Bundle\ModlrBundle\As3ModlrBundle(),
    );

    // ...
}

```

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

[](#configuration)

Modlr requires some configuration in order to work. You can use the default config below to get started:

```
# app/config/config.yml
as3_modlr:
    rest:
        root_endpoint: /api
        debug: "%kernel.debug%"
    adapter:
        type: jsonapiorg
    persisters:
        default:
            type: mongodb
            parameters:
                host: mongodb://localhost:27017
    search_clients:
        default:
            type: elastic

```

To utilize the external REST API, you must also include modlr's routing file. This will allow modlr to handle all requests to `as3_modlr.rest.root_endpoint`. To prevent any routing conflicts, you should add this before any other bundle or your application route definitions.

```
# app/config/routing.yml
as3_modlr_bundle:
    resource: "@As3ModlrBundle/Resources/config/routing.yml"

```

Next you must define your models! By default, modlr's metadata driver will look for YAML files in `app/Resources/As3ModlrBundle/models` and `app/Resources/As3ModlrBundle/mixins`.

You can customize where your definitions are stored by setting the `models_dir` parameter of your metadata driver. See the [bundle configuration](#) documentation for more information.

Usage
-----

[](#usage)

See [modlr documentation](#) for additional information.

This bundle provides commands to rebuild modlr's metadatacache:

```
app/console as3:modlr:metadata:cache:clear [model_type] [--no-warm]

```

Create collection schema:

```
app/console as3:modlr:schema:create [model_type]

```

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

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

![](https://www.gravatar.com/avatar/1edba31ec2714e8cfac7a4c1232c56cf40a26d154876c0d9b42d984944056758?d=identicon)[solocommand](/maintainers/solocommand)

---

Top Contributors

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

### Embed Badge

![Health badge](/badges/as3-modlr-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/as3-modlr-bundle/health.svg)](https://phpackages.com/packages/as3-modlr-bundle)
```

PHPackages © 2026

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