2017 © Pedro Peláez
 

symfony-bundle faq-bundle

Symfony FAQ bundle

image

genj/faq-bundle

Symfony FAQ bundle

  • Monday, August 21, 2017
  • by genj
  • Repository
  • 7 Watchers
  • 6 Stars
  • 4,446 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 7 Forks
  • 0 Open issues
  • 14 Versions
  • 3 % Grown

The README.md

GenjFaqBundle

The GenjFaqBundle allows you to display a FAQ on your website, with the questions being grouped in categories. Features:, (*1)

  • Questions are grouped into Categories
  • Categories can be deactivated
  • Questions can be drafted and scheduled for publishing
  • Can show all information at once, or collapse questions/categories for big FAQs. It's basically up to you - how you are handling this in the template
  • Collapsed mode generates SEO friendly URLs
  • Contains very simple mysql search - if you need it more advanced use elasticsearch

Requirements

see composer.json, (*2)

Installation

Add this to your composer.json:, (*3)

    ...
    "require": {
        ...
        "gedmo/doctrine-extensions": "~2.3,<3.0",
        "genj/faq-bundle": "dev-master"
        ...

Then run composer update. After that is done, enable the bundle in your AppKernel.php:, (*4)

# app/AppKernel.php
class AppKernel extends Kernel
{
    public function registerBundles() {
        $bundles = array(
            ...
            new Genj\FaqBundle\GenjFaqBundle()
            ...

Add the routing rules to your routing.yml:, (*5)

# app/config/routing.yml
genj_faq:
    resource: "@GenjFaqBundle/Resources/config/routing.yml"

Finally, update your database schema:, (*6)

php bin/console doctrine:schema:update --dump-sql

use the --force option to actually execute the DB update., (*7)

And you're done. You should now be able to reach the bundle under the http://yourproject.com/faq URL if you did add at least one category in your DB., (*8)

Optional: loading fixtures, (*9)

If you use the doctrine-fixtures bundle, you can load fixtures like this:, (*10)

php bin/console doctrine:fixtures:load --fixtures=vendor/genj/faq-bundle/src/Genj/FaqBundle/DataFixtures/

Configuration

You can optionally include the configuration below into your config.yml:, (*11)

genj_faq:
    select_first_category_by_default: false
    select_first_question_by_default: false

Both configuration will open the first category and/or question by default if the user has not chosen a category and/or question yet. The default for both values is 'false', so set them to 'true' if you want this behaviour., (*12)

Note that it is also required to have the Sluggable and Timestampable behaviours configured for gedmo/doctrine-extensions (see https://github.com/Atlantic18/DoctrineExtensions)., (*13)

Advanced

As soon you want more than the default category listing with all questions + answers you shouldn't import the bundle route, but copy only the part you are actualy using., (*14)

e.g. if you want single pages for each question use the genj_faq_question_show route., (*15)

For further examples see https://github.com/genj/faq-demo, (*16)

FAQ

  • How do I add this to SonataAdmin?

You can use the GenjFaqAdminBundle: https://github.com/genj/GenjFaqAdminBundle or just create your own admin class., (*17)

The Versions

21/08 2017

dev-master

9999999-dev http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

php bundle symfony faq symfony-bundle genj

10/06 2017

v2.0.0

2.0.0.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

php bundle symfony faq symfony-bundle genj

10/06 2017

v1.0.8

1.0.8.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

php bundle symfony faq symfony-bundle genj

03/05 2017

2.8.x-dev

2.8.9999999.9999999-dev http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

24/04 2017

3.2.x-dev

3.2.9999999.9999999-dev http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

php bundle symfony faq symfony-bundle genj

24/04 2017

v1.0.7

1.0.7.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

php bundle symfony faq symfony-bundle genj

10/12 2016

dev-redmine_13942

dev-redmine_13942 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

18/07 2016

v1.0.6

1.0.6.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

13/12 2015

v1.0.5

1.0.5.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

18/05 2015

v1.0.4

1.0.4.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

02/09 2014

v1.0.3

1.0.3.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

02/09 2014

v1.0.2

1.0.2.0 http://github.com/genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

06/08 2014

v1.0.1

1.0.1.0 http://github.com/Genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

  • genj/dev-tools 1.0.0

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj

27/07 2014

v1.0.0

1.0.0.0 http://github.com/Genj/GenjFaqBundle

Symfony FAQ bundle

  Sources   Download

MIT

The Requires

 

The Development Requires

  • genj/dev-tools 1.0.0

by Choong Wei Tjeng
by Nico Kaag
by Susan Lau

bundle symfony faq genj