Developing (v7+)

V8 ORM EntityManagerProvider

Permalink October 17, 2018 at 8:57 AM

Hello everyone

I've been struggeling to create a package with custom Entities in V8-style. I've created several packages in the legacy V7-style. This time I would want to add a custom attribute category as described inhttps://documentation.concrete5.org/developers/attributes/advanced-c...

I've followed the following tutorial for the ORM Entities and mapping the PHP namespaces:
https://documentation.concrete5.org/developers/packages/custom-datab...

I realized that apparently the entities are not being written to the DB. Therfore I created a test package (mypack) with just one entity in order to figure out the correct syntax:

File packages/mypack/controller.php:

<?php
namespace Concrete\Package\Mypack;
use Concrete\Core\Package\Package;
use Concrete\Core\Database\EntityManager\Provider\ProviderAggregateInterface;
use Concrete\Core\Database\EntityManager\Provider\StandardPackageProvider;
defined('C5_EXECUTE') or die(_("Access Denied."));
class Controller extends Package implements ProviderAggregateInterface
{
    protected $pkgHandle = 'mypack';
    protected $appVersionRequired = '8.0.0';
    //Increase this value if changes are made!
    protected $pkgVersion = '0.0.0';
    public function getPackageName()
    {
        return t("Test Package");

Viewing 15 lines of 42 lines. View entire code block.

 
<?php
 
namespace Concrete\Package\Mypack;
use Concrete\Core\Package\Package;
use Concrete\Core\Database\EntityManager\Provider\ProviderAggregateInterface;
use Concrete\Core\Database\EntityManager\Provider\StandardPackageProvider;
 
defined('C5_EXECUTE') or die(_("Access Denied."));
 
class Controller extends Package implements ProviderAggregateInterface
{
    protected $pkgHandle = 'mypack';
    protected $appVersionRequired = '8.0.0';
 
    //Increase this value if changes are made!
    protected $pkgVersion = '0.0.0';
 
    public function getPackageName()
    {
        return t("Test Package");
    }
 
    public function getPackageDescription()
    {
        return t("Test new v8 ORM.");
    }
 
    public function install()
    {
        $pkg = parent::install();
    }
 
    public function upgrade() {
        parent::upgrade();
    }
 
    public function uninstall(){
        $pkg = parent::uninstall();
    }
 
    public function getEntityManagerProvider()
    {
        $provider = new StandardPackageProvider($this->app, $this, [
            'src/Concrete/Entity' => 'Concrete\Package\MyPack\Entity',
        ]);
        return $provider;
    }
 
    public function on_start()
    {
        $al = \Concrete\Core\Asset\AssetList::getInstance();
    }
 
}

File packages/mypack/src/Concrete/Entity/Test.php

<?php
namespace Concrete\Package\Mypack\Entity;
use Core;
use \Doctrine\ORM\Mapping as ORM;
/**
 * Represents a message for the Debriefing package.
 *
 * @ORM\Entity
 * @ORM\Table(
 *     name="MypackTest",
 *     options={"comment": "Messages of the Debriefing package"}
 * )
 */
class Test
{

Viewing 15 lines of 26 lines. View entire code block.

 
<?php
 
namespace Concrete\Package\Mypack\Entity;
use Core;
use \Doctrine\ORM\Mapping as ORM;
 
/**
 * Represents a message for the Debriefing package.
 *
 * @ORM\Entity
 * @ORM\Table(
 *     name="MypackTest",
 *     options={"comment": "Messages of the Debriefing package"}
 * )
 */
class Test
{
    /**
     * @ORM\Column(type="integer", options={"unsigned": true})
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
 
    public function getId()
    {
        return $this->id;
    }
}

As soon as I put $appVersionRequired to '7.0.0' the table 'MypackTest' will be created on installation of the package but I can't get it to work for '8.0.0'!

Thank you in advance

Mario

linuxoid replied on Oct 17, 2018 at 9:50 pm Permalink Reply

You've already set your path to 'Concrete\Package\MyPack\Entity', so your namespace has to be simply 'Entity' in this case.

And you don't need to use ProviderAggregateInterface.

Please have a look at my package controller:

namespace Concrete\Package\AbSimpleComments;
use Package;
use Asset;
use AssetList;
use Concrete\Core\Database\EntityManager\Provider\StandardPackageProvider;
use SimpleComments\Install\Installer;
class Controller extends Package {
    protected $pkgHandle = 'ab_simple_comments';
    protected $appVersionRequired = '8.3.2';
    protected $pkgVersion = '0.9.11';
    protected $pkgAutoloaderMapCoreExtensions = true;
    protected $pkgAutoloaderRegistries = [
        'src/SimpleComments' => 'SimpleComments'
    ];
    public function getPackageDescription()

Viewing 15 lines of 30 lines. View entire code block.

 
namespace Concrete\Package\AbSimpleComments;
 
use Package;
use Asset;
use AssetList;
use Concrete\Core\Database\EntityManager\Provider\StandardPackageProvider;
 
use SimpleComments\Install\Installer;
 
class Controller extends Package {
 
    protected $pkgHandle = 'ab_simple_comments';
    protected $appVersionRequired = '8.3.2';
    protected $pkgVersion = '0.9.11';
    protected $pkgAutoloaderMapCoreExtensions = true;
    protected $pkgAutoloaderRegistries = [
        'src/SimpleComments' => 'SimpleComments'
    ];
 
    public function getPackageDescription() 
    {
        return t('Add Simple Comments package');
    }
 
    public function getPackageName() 
    {
        return t("Simple Comments");
    }
 
    public function getEntityManagerProvider()
    {
        $provider = new StandardPackageProvider($this->app, $this, [
            'src/SimpleComments' => 'SimpleComments'
        ]);
        return $provider;
    }
    ...

and the class:

namespace SimpleComments\Comment;
use Doctrine\ORM\Mapping as ORM;
/**
 * @ORM\Entity
 * @ORM\Table(name="AbSimpleComments")
 */
class Comment
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
    public function getID()

Viewing 15 lines of 23 lines. View entire code block.

 
namespace SimpleComments\Comment;
 
use Doctrine\ORM\Mapping as ORM;
 
/**
 * @ORM\Entity
 * @ORM\Table(name="AbSimpleComments")
 */
class Comment
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
 
    public function getID()
    {
        return $this->id;
    }
 
    public function setID($id)
    {
        $this->id = $id;
    }
    ...

Forums

Developing (v7+)

V8 ORM EntityManagerProvider

Code

Post Reply

Delete Post

Mark Post as Spam

Destroy Spammer

Sign In?