PHPackages                             pixelmairie/sulu-directorybundle - 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. [Admin Panels](/categories/admin)
4. /
5. pixelmairie/sulu-directorybundle

ActiveSulu-bundle[Admin Panels](/categories/admin)

pixelmairie/sulu-directorybundle
================================

Manage a directory for Sulu

2.6.0(1y ago)1149MITPHPPHP ^8.0

Since Jun 30Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Pixel-Mairie/sulu-directorybundle)[ Packagist](https://packagist.org/packages/pixelmairie/sulu-directorybundle)[ Docs](https://github.com/Pixel-Developpement/sulu-directory-bundle)[ RSS](/packages/pixelmairie-sulu-directorybundle/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (2)Dependencies (12)Versions (4)Used By (0)

Directory Bundle
================

[](#directory-bundle)

[![GitHub release (with filter)](https://camo.githubusercontent.com/dadc6babb57ed09ec210a2d1a855b47a86580c6d565232be5c3a95495351977f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506978656c2d4d61697269652f73756c752d6469726563746f727962756e646c653f7374796c653d666f722d7468652d6261646765)](https://camo.githubusercontent.com/dadc6babb57ed09ec210a2d1a855b47a86580c6d565232be5c3a95495351977f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506978656c2d4d61697269652f73756c752d6469726563746f727962756e646c653f7374796c653d666f722d7468652d6261646765)[![Dependency](https://camo.githubusercontent.com/a7164181066052cd108eee770b71f67bfd7cbe74cf87af56067534814e843f34/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73756c752d322e352d6363613030302e7376673f7374796c653d666f722d7468652d6261646765)](https://sulu.io/)

Presentation
------------

[](#presentation)

A Sulu bundle to manage a directory.

Features
--------

[](#features)

- Directory management
- List of cards (via smart content)
- Preview
- Translation
- Settings
- SEO
- Activity log
- Trash

Requirement
-----------

[](#requirement)

- PHP &gt;= 8.0
- Sulu &gt;= 2.4
- Symfony &gt;= 5.4
- Composer

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

[](#installation)

### Install the bundle

[](#install-the-bundle)

Execute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your project:

```
composer require pixelmairie/sulu-directorybundle
```

### Enable the bundle

[](#enable-the-bundle)

Enable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:

```
return [
    /* ... */
    Pixel\DirectoryBundle\DirectoryBundle::class => ['all' => true],
];
```

### Update schema

[](#update-schema)

```
bin/console do:sch:up --force
```

Bundle Config
-------------

[](#bundle-config)

Define the Admin Api Route in `routes_admin.yaml`

```
directory.directories_api:
  type: rest
  prefix: /admin/api
  resource: pixel_directory.directories_route_controller
  name_prefix: card.

directory.settings_api:
  type: rest
  prefix: /admin/api
  resource: pixel_directory.settings_route_controller
  name_prefix: directory.
```

Use
---

[](#use)

### Add/Edit a card

[](#addedit-a-card)

Go to the "Directory" section in the administration interface. Then, click on "Add". Fill the fields that are needed for your use.

Here is the list of the fields:

- Name (mandatory)
- Type of card (mandatory)
- URL (mandatory and filled automatically according to the title)
- Logo
- Category (mandatory)
- Images
- PDF
- Youtube video ID
- Website
- Email
- Phone number
- Facebook
- Instagram
- Twitter
- LinkedIn
- Description
- Location

Once you finished, click on "Save"

Your card is not visible on the website yet. In order to do that, click on "Activate?". It should be now visible for visitors.

To edit a card, simply click on the pencil at the left of the card you wish to edit.

### Categories

[](#categories)

As you may have seen in the previous section, a card needs a category and a type. These categories and types need to be created in a very specific way.

For the types:

- You **must** create a root category (which represents the different types) which **must** have its key named "types"
- Then, under this root category, you create all the types you need

For the categories:

- You **must** create a root category which **must** have its key named "categories"
- Then, under this root category, you create all the categories you need

### Remove/Restore a gallery

[](#removerestore-a-gallery)

There are two ways to remove a card:

- Check every card you want to remove and then click on "Delete"
- Go to the detail of a card (see the "Add/Edit a news" section) and click on "Delete".

In both cases, the card will be put in the trash.

To access the trash, go to the "Settings" and click on "Trash". To restore a card, click on the clock at the left. Confirm the restore. You will be redirected to the detail of the card you restored.

To remove permanently a card, check all the cards you want to remove and click on "Delete".

Settings
--------

[](#settings)

This bundle comes with settings. To access the bundle settings, go to "Settings &gt; Cards management".

Here is the list of the different settings:

- Map centering
- Default image

The map centering is very useful if you have a global map showing all the card you registered. With that, you can center your map in order to see all the card in a given area.

The default image is helpful when a card has no logo for example.

Twig extension
--------------

[](#twig-extension)

This bundle comes with only one twig function:

**directory\_settings()**: returns the settings of the bundle. No parameters are required.

Example of use:

```
{% set settings = directory_settings() %}
{% if settings.defaultImage is defined %}
    {% set defaultImage = sulu_resolve_media(settings.defaultImage.id, 'fr') %}
{% endif %}
```

Contributing
------------

[](#contributing)

You can contribute to this bundle. The only thing you must do is respect the coding standard we implements. You can find them in the `ecs.php` file.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance32

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

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

Total

2

Last Release

692d ago

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

sulu-bundledirectory newssulusulucms

###  Code Quality

Static AnalysisPHPStan

Code StyleECS

Type Coverage Yes

### Embed Badge

![Health badge](/badges/pixelmairie-sulu-directorybundle/health.svg)

```
[![Health](https://phpackages.com/badges/pixelmairie-sulu-directorybundle/health.svg)](https://phpackages.com/packages/pixelmairie-sulu-directorybundle)
```

###  Alternatives

[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k16.7M310](/packages/easycorp-easyadmin-bundle)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[sulu/article-bundle

Bundle for managing localized content-rich entities like blog-posts in the Sulu content management system

66409.6k2](/packages/sulu-article-bundle)[shopware/administration

Administration frontend for the Shopware Core

413.9M75](/packages/shopware-administration)[sulu/headless-bundle

Bundle that provides controllers and services for using Sulu as headless content management system

55133.7k2](/packages/sulu-headless-bundle)[sulu/skeleton

Project template for starting your new project based on the Sulu content management system

29733.3k](/packages/sulu-skeleton)

PHPackages © 2026

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