Pimcore DevKit

Pimcore DevKit is a set of tools that helps developing Pimcore applications. It is intended to wrap Pimcore classess to enable easy use of them.

Table of Contents

• Pimcore DevKit
  • Compatibility
  • Installing/Getting started
  • Features
    • Commands
    • WYSIWYG with image metadata
  • Contributing
  • Licensing
  • Standards & Code Quality
  • About Authors

Compatibility

This module is compatible with Pimcore 5.3.0 and higher.

Installing/Getting started

composer require divanteltd/pimcoredevkit

Features

Commands

devkit:asset:synchronize

Synchronizes assets tree with filesystem changes

devkit:delete_by_id

Deletes object, document, asset from given tree

devkit:deletefolder

Deletes folder from given tree

devkit:classes:update

Updates class definition from json

devkit:bricks:update

Updates bricks definition from json

WYSIWYG with metadata

Standard Pimcore implementation does not use images metadata, when used in WYSIWYG. To enable this feature, you can use brick WYSIWYG with metadata which provides also simple view file. To use more sophisticated view (e. g. styled) you can create your own brick with a class derived from \PimcoreDevkitBundle\Document\Areabrick\WysiwygWithMetadata. Example implementation:

namespace AppBundle\Document\Areabrick;

use PimcoreDevkitBundle\Document\Areabrick\WysiwygWithMetadata;

class Wysiwyg extends \PimcoreDevkitBundle\Document\Areabrick\WysiwygWithMetadata
{
    public function getName()
    {
        return "WYSIWYG";
    }

    public function getIcon()
    {
        return '/bundles/pimcoreadmin/img/flat-color-icons/wysiwyg.svg';
    }

    public function getTemplateLocation()
    {
        return static::TEMPLATE_LOCATION_GLOBAL;
    }
}

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

Licensing

GPL-3.0-or-later

Standards & Code Quality

This module respects all Pimcore 5 code quality rules and our own PHPCS and PHPMD rulesets.

About Authors

We are a Software House from Europe, existing from 2008 and employing about 150 people. Our core competencies are built around Magento, Pimcore and bespoke software projects (we love Symfony3, Node.js, Angular, React, Vue.js). We specialize in sophisticated integration projects trying to connect hardcore IT with good product design and UX.

We work for Clients like INTERSPORT, ING, Odlo, Onderdelenwinkel and CDP, the company that produced The Witcher game. We develop two projects: Open Loyalty - an open source loyalty program and Vue.js Storefront.

We are part of the OEX Group which is listed on the Warsaw Stock Exchange. Our annual revenue has been growing at a minimum of about 30% year on year.

Visit our website Divante.co for more information.