Get the dynamic field name in Attachment Table for Entity

I have noticed Attachment data is left out when deleting Entity record using Attachment feature.

So I started creating this helper function so that I can just call it from deleteAction() in REST API Controller Class:

/** * Delete Attachment attached to Entity by Entity Id * * @param string $entityName * @param string $entityId */ public function deleteAttachment($entityName, $entityId) { $doctrine = $this->getDoctrine(); $em = $doctrine->getManager(); /* Custom method to get single Entity record */ $entity = $this->getEntityBy($entityName, $entityId); // I am not sure if I need this to get the dynamic field name $entityClass = get_class($entity); $repository = $doctrine->getRepository('OroAttachmentBundle:Attachment'); /** * I am thinking there must be a function to get this dynamic field name * as this variable cannot be a literal value here */ $fieldName = 'acme_a1234567'; $attachments = $repository->findBy(array($fieldName => $entityId)); foreach ($attachments as $attachment) { $em->remove($attachment); } $em->flush(); }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

/** * Delete Attachment attached to Entity by Entity Id * * @param string $entityName * @param string $entityId */ public function deleteAttachment($entityName, $entityId) {       $doctrine = $this->getDoctrine();     $em = $doctrine->getManager();       /* Custom method to get single Entity record */     $entity = $this->getEntityBy($entityName, $entityId);       // I am not sure if I need this to get the dynamic field name     $entityClass = get_class($entity);       $repository = $doctrine->getRepository('OroAttachmentBundle:Attachment');       /**      * I am thinking there must be a function to get this dynamic field name      * as this variable cannot be a literal value here      */     $fieldName = 'acme_a1234567';       $attachments = $repository->findBy(array($fieldName => $entityId));       foreach ($attachments as $attachment) {         $em->remove($attachment);     }     $em->flush(); }

One thing I cannot figure is about how we can know the extended field name in code.

Please let me know if there is already the deletion method somewhere.

I have found deleteAction() in Oro\Bundle\AttachmentBundle\Controller\Api\Rest, but the parameter is the Id for the attachment, not Entity Id so.

Topic

[HiroParticipant]

I figured I can get the field name by:

$fieldName = ExtendHelper::buildAssociationName($entityClass);

1	$fieldName = ExtendHelper::buildAssociationName($entityClass);

and refer “ExtendHelper” for the method as:

use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper;

1	use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper;

[AlexanderModerator]

Hi Hiro,

Actually you are right, you should use ExtendHelper::buildAssociationName to get field name for fields of “attachment” type.
And as an example you can look into src/Oro/Bundle/AttachmentBundle/Migration/Extension/AttachmentExtension.php, method addAttachmentAssociation. Here is realization of adding attachment field via migration, and ExtendHelper used to build association name.

[HiroParticipant]

Thank you for the follow up!

[HiroParticipant]

The function ended up like this:

use Gaufrette\Filesystem; use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper; /** * Delete Attachment attached to Entity by Entity Id * * @param string $entityName * @param string $entityId */ public function deleteAttachment($entityName, $entityId) { // Custom method to get Doctrine $doctrine = $this->getDoctrine(); $em = $doctrine->getManager(); // Custom method to get single Entity record $entity = $this->getEntityBy($entityName, $entityId); // To enable to delete actual file $fileSystem = $this->get('knp_gaufrette.filesystem_map')->get('attachments'); $entityClass = get_class($entity); $fieldName = ExtendHelper::buildAssociationName($entityClass); $repository = $doctrine->getRepository('OroAttachmentBundle:Attachment'); $attachments = $repository->findBy(array($fieldName => $entityId)); foreach ($attachments as $attachment) { // Delete actual file $file = $attachment->getFile(); if ($fileSystem->has($file->getFilename())) { $fileSystem->delete($file->getFilename()); } // Delete Attachment Entity and File Entity from Database $em->remove($file); $em->remove($attachment); } $em->flush(); }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

use Gaufrette\Filesystem; use Oro\Bundle\EntityExtendBundle\Tools\ExtendHelper;   /** * Delete Attachment attached to Entity by Entity Id * * @param string $entityName * @param string $entityId */ public function deleteAttachment($entityName, $entityId) {       // Custom method to get Doctrine     $doctrine = $this->getDoctrine();     $em = $doctrine->getManager();       // Custom method to get single Entity record     $entity = $this->getEntityBy($entityName, $entityId);       // To enable to delete actual file     $fileSystem = $this->get('knp_gaufrette.filesystem_map')->get('attachments');       $entityClass = get_class($entity);     $fieldName = ExtendHelper::buildAssociationName($entityClass);       $repository = $doctrine->getRepository('OroAttachmentBundle:Attachment');     $attachments = $repository->findBy(array($fieldName => $entityId));       foreach ($attachments as $attachment) {         // Delete actual file         $file = $attachment->getFile();         if ($fileSystem->has($file->getFilename())) {             $fileSystem->delete($file->getFilename());         }         // Delete Attachment Entity and File Entity from Database         $em->remove($file);         $em->remove($attachment);     }     $em->flush(); }

[Author]

Replies