Skip to content

ecomyseo/prestashop_skills / prestashop-doctrine-entities

prestashop-doctrine-entities

Verified

Skill for using Doctrine ORM in PrestaShop modules for modern data persistence in PS 8 and 9.

PrestaShop Doctrine Entities Skill

This skill explains how to define, manage, and query data using Doctrine ORM within PrestaShop modules.

1. Technical Guide

Defining an Entity

Entities should be placed in src/Entity/. Use annotations (or attributes in PHP 8+) to map them.

namespace MyModule\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table()
 * @ORM\Entity(repositoryClass="MyModule\Repository\MyEntityRepository")
 */
class MyEntity
{
    /**
     * @ORM\Id
     * @ORM\Column(name="id_my_entity", type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\Column(name="name", type="string", length=255)
     */
    private $name;

    // Getters and Setters...
}

Accessing the Entity Manager

In a Symfony controller:

$entityManager = $this->get('doctrine.orm.entity_manager');
$myEntity = new MyEntity();
$myEntity->setName('Example');
$entityManager->persist($myEntity);
$entityManager->flush();

Translatable Entities

For multi-language support, create a secondary entity (e.g., MyEntityLang) and link them with OneToMany.

2. Professional Development Guide

Schema Management

Unlike ObjectModel, Doctrine entities require explicit schema management. You can use the SchemaTool in your module's install/uninstall methods.

private function installEntities()
{
    $entityManager = $this->container->get('doctrine.orm.entity_manager');
    $schemaTool = new \Doctrine\ORM\Tools\SchemaTool($entityManager);
    $schemaTool->createSchema([
        $entityManager->getClassMetadata(\MyModule\Entity\MyEntity::class),
        $entityManager->getClassMetadata(\MyModule\Entity\MyEntityLang::class),
    ]);
}

Repository Pattern

Always use repositories for custom queries to keep your entities clean.

namespace MyModule\Repository;

use Doctrine\ORM\EntityRepository;

class MyEntityRepository extends EntityRepository
{
    public function findAllByName(string $name)
    {
        return $this->findBy(['name' => $name]);
    }
}

3. User Guide

Advantages

  • Type Safety: Better IDE support and less runtime errors.
  • Complexity: Handles relationships (OneToMany, ManyToMany) much better than ObjectModel.
  • Portability: Standard Symfony practice.

Rules & Best Practices

  • Namespace: Ensure your namespace matches the module directory to avoid autoloading issues.
  • Prefixes: PrestaShop tables are prefixed automatically if using standard Doctrine configuration in PS.
  • Lifecycle Callbacks: Use @ORM\HasLifecycleCallbacks for things like date_add and date_upd.
reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.Stars: 322kUpdated Claude CodeCodexVerifiedInstall
dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependenciesStars: 322kUpdated Claude CodeCodexVerifiedInstall
executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is availableStars: 322kUpdated Claude CodeCodexVerifiedInstall