webburza/sylius-article-bundle

Article bundle for Sylius e-commerce platform.

Installs: 2 055

Dependents: 0

Suggesters: 0

Security: 0

Stars: 27

Watchers: 4

Forks: 12

Open Issues: 3

Type:symfony-bundle

v0.7.0 2017-01-16 14:16 UTC

README

This bundle extends the Sylius e-commerce platform with Article resource, which can be used to publish news, articles, or as a blog. It comes with full multilingual support, the ability to group articles into categories, and the ability to set related products for articles.

687474703a2f2f692e696d6775722e636f6d2f4f6470676a67362e706e67 687474703a2f2f692e696d6775722e636f6d2f61766c31706c732e706e67 687474703a2f2f692e696d6775722e636f6d2f426b544d61426e2e706e67

Installation

  1. require the bundle with Composer:
$ composer require webburza/sylius-article-bundle
  1. enable the bundle in app/AppKernel.php:
public function registerBundles()
{
  $bundles = array(
    // ...
    new \Webburza\Sylius\ArticleBundle\WebburzaSyliusArticleBundle(),
    // ...
  );
}
  1. add configuration to the top of app/config/config.yml:
imports:
    - { resource: "@WebburzaSyliusArticleBundle/Resources/config/config.yml" }
  1. register routes in app/config/routing.yml
webburza_article:
    resource: "@WebburzaSyliusArticleBundle/Resources/config/routing.yml"

webburza_article_front:
    resource: "@WebburzaSyliusArticleBundle/Resources/config/routingFront.yml"
    prefix:  /articles

As you can see, there are two groups of routes, the main resource (administration) routes, and the front-end routes. If you're using the bundle for a blog, or news, you can set the prefix for the routes here, changing it to /blog, or /news.

  1. The bundle should now be fully integrated, but it still requires database tables to be created. For this, we recommend using migrations.
$ bin/console doctrine:migrations:diff
$ bin/console doctrine:migrations:migrate

Or if you don't use migrations, you can update the database schema directly.

  $ bin/console doctrine:schema:update

Configuration

Translations and naming (blog, news, articles...)

The bundle has multilingual support, and language files can be overridden as with any other bundle, by creating translation files in the app/Resources/WebburzaSyliusArticleBundle/translations directory.

This also allows for different naming, so if you're using the bundle as a blog, or as a source of latest news, you can replace all mentions of articles with that of blog, news, or something else completely.

To get started, check the bundle's main language file in: Resources/translations/messages.en.yml

File repository integration in rich-text editors

The bundle uses rich-text editors (CKEditor) to work with content, which allows the user to work with images in the content as well.

By default, this is limited to specifying the URL to the image manually, but if your application integrates a file repository system for editors, such as CKFinder, or the free alternative KCFinder, you can easily add the functionality to allow the users to upload and work with image files directly trough the rich-text editor.

To accomplish this, simply fill in the bundle's configuration with your file browser URI's, as seen in the example bellow:

# ...

webburza_sylius_article:
    file_browser:
        browse_url: "/browser/browse.php"
        upload_url: "/uploader/upload.php"

This will add file upload and browse controls to your rich-text editors. For more information, see http://docs.ckeditor.com/#!/guide/dev_file_browse_upload

License

This bundle is available under the MIT license.

To-do

  • Automated tests