当前位置:首页 > PHP教程 > php上传下载 > 列表

Doctrine文件上传处理例子

发布:smiling 来源: PHP粉丝网  添加日期:2015-05-09 09:48:05 浏览: 评论:0 

Doctrine是基于数据库抽像层上的ORM,它可以通过PHP对象轻松访问所有的数据库,例如MYSQL,它支持的PHP最低版本为5.2.3,下面我们一起来看看Doctrine文件上传处理例子,希望文章对各位有帮助.

基本设置,创建一个简单的Doctrine实体类:

  1. // src/Acme/DemoBundle/Entity/Document.php 
  2. namespace Acme\DemoBundle\Entity; 
  3.    
  4. use Doctrine\ORM\Mapping as ORM; 
  5. use Symfony\Component\Validator\Constraints as Assert; 
  6.    
  7. /** 
  8.  * @ORM\Entity 
  9.  */ 
  10. class Document 
  11.     /** 
  12.      * @ORM\Id 
  13.      * @ORM\Column(type="integer") 
  14.      * @ORM\GeneratedValue(strategy="AUTO") 
  15.      */ 
  16.     public $id
  17.    
  18.     /** 
  19.      * @ORM\Column(type="string", length=255) 
  20.      * @Assert\NotBlank 
  21.      */ 
  22.     public $name
  23.    
  24.     /** 
  25.      * @ORM\Column(type="string", length=255, nullable=true) 
  26.      */ 
  27.     public $path
  28.    
  29.     public function getAbsolutePath() 
  30.     { 
  31.         return null === $this->path 
  32.             ? null 
  33.             : $this->getUploadRootDir().'/'.$this->path; 
  34.     } 
  35.    
  36.     public function getWebPath() 
  37.     { 
  38.         return null === $this->path 
  39.             ? null 
  40.             : $this->getUploadDir().'/'.$this->path; 
  41.     } 
  42.    
  43.     protected function getUploadRootDir() 
  44.     { 
  45.         // the absolute directory path where uploaded 
  46.         // documents should be saved 
  47.         return __DIR__.'/../../../../web/'.$this->getUploadDir(); 
  48.     } 
  49.    
  50.     protected function getUploadDir() 
  51.     { 
  52.         // get rid of the __DIR__ so it doesn't screw up 
  53.         // when displaying uploaded doc/image in the view. 
  54.         return 'uploads/documents'
  55.     } 

该document实体有一个名称与文件相关联,这个path属性存储一个文件的相对路径并且在数据库中存储,这个getAbsolutePath()会返回一个绝对路径,getWebPath()会返回一个web路径,用于模板加入上传文件链接.

如果你还没有这样做的话,你应该阅读http://symfony.com/doc/current/reference/forms/types/file.html首先了解基本的上传过程.

如果您使用注释来验证规则(如本例所示),请确保你启用了注释验证(见http://symfony.com/doc/current/book/validation.html#book-validation-configuration).

在处理一个实际的文件上传时,使用一个“虚拟”的file字段,例如,如果你在controller中直接构建一个form,他可能是这样的.

  1. public function uploadAction() 
  2.     // ... 
  3.    
  4.     $form = $this->createFormBuilder($document
  5.         ->add('name'
  6.         ->add('file'
  7.         ->getForm(); 
  8.    
  9.     // ... 

下一步,创建file这个属性到你的Document类中并且添加一些验证规则:

  1. use Symfony\Component\HttpFoundation\File\UploadedFile; 
  2.    
  3. // ... 
  4. class Document 
  5.     /** 
  6.      * @Assert\File(maxSize="6000000") 
  7.      */ 
  8.     private $file
  9.    
  10.     /** 
  11.      * Sets file. 
  12.      * 
  13.      * @param UploadedFile $file 
  14.      */ 
  15.     public function setFile(UploadedFile $file = null) 
  16.     { 
  17.         $this->file = $file
  18.     } 
  19.    
  20.     /** 
  21.      * Get file. 
  22.      * 
  23.      * @return UploadedFile 
  24.      */ 
  25.     public function getFile() 
  26.     { 
  27.         return $this->file; 
  28.     } 
  29. annotations 
  30. Annotations 
  31. // src/Acme/DemoBundle/Entity/Document.php 
  32. namespace Acme\DemoBundle\Entity; 
  33.    
  34. // ... 
  35. use Symfony\Component\Validator\Constraints as Assert; 
  36.    
  37. class Document 
  38.     /** 
  39.      * @Assert\File(maxSize="6000000") 
  40.      */ 
  41.     private $file
  42.    
  43.     // ... 

当你使用File约束,symfony会自动猜测表单字段输入的是一个文件上传,这就是当你创建表单(->add(‘file’))时,为什么没有在表单明确设置为文件上传的原因.

下面的控制器,告诉您如何处理全部过程:

  1. // ... 
  2. use Acme\DemoBundle\Entity\Document; 
  3. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template; 
  4. use Symfony\Component\HttpFoundation\Request; 
  5. // ... 
  6.    
  7. /** 
  8.  * @Template() 
  9.  */ 
  10. public function uploadAction(Request $request
  11.     $document = new Document(); 
  12.     $form = $this->createFormBuilder($document
  13.         ->add('name'
  14.         ->add('file'
  15.         ->getForm(); 
  16.    
  17.     $form->handleRequest($request); 
  18.    
  19.     if ($form->isValid()) { 
  20.         $em = $this->getDoctrine()->getManager(); 
  21.    
  22.         $em->persist($document); 
  23.         $em->flush(); 
  24.    
  25.         return $this->redirect($this->generateUrl(...)); 
  26.     } 
  27.    
  28.     return array('form' => $form->createView()); 

以前的controller当提交name自动的存储Document实体,但是他不会做任何关于文件的事情并且path属性也将是空白.

处理文件上传一个简单的方法就是在entity持久化之前设置相应的path属性,在某一时刻处理文件上传时,要调用Document实体类一个upload()方法给path赋值.

  1. if ($form->isValid()) { 
  2.     $em = $this->getDoctrine()->getManager(); 
  3.    
  4.     $document->upload(); 
  5.    
  6.     $em->persist($document); 
  7.     $em->flush(); 
  8.    
  9.     return $this->redirect(...); 

这个upload()方法利用UploadedFile对象,是它提交后返回file字段:

  1. public function upload() 
  2.     // the file property can be empty if the field is not required 
  3.     // 该file属性为空这个属性就不需要了 
  4.     if (null === $this->getFile()) { 
  5.         return
  6.     } 
  7.    
  8.     // use the original file name here but you should 
  9.     // sanitize it at least to avoid any security issues 
  10.     //  这里你应该使用原文件名但是应该至少审核它避免一些安全问题 
  11.     // move takes the target directory and then the 
  12.     // target filename to move to 
  13.     // 将目标文件移动到目标目录 
  14.     $this->getFile()->move( 
  15.         $this->getUploadRootDir(), 
  16.         $this->getFile()->getClientOriginalName() 
  17.     ); 
  18.    
  19.     // set the path property to the filename where you've saved the file 
  20.     // 设置path属性为你保存文件的文件名 
  21.     $this->path = $this->getFile()->getClientOriginalName(); 
  22.    
  23.     // clean up the file property as you won't need it anymore 
  24.     // 清理你不需要的file属性 
  25.     $this->file = null; 

使用生命周期回调:

生命周期回调是一种有限的技术,他有一些缺点,如果你想移除Document::getUploadRootDir()方法里的写死的编码__DIR__,最好的方法是开始使用Doctrine listeners,在哪里你将能够注入内核参数,如kernel.root_dir来建立绝对路径.

这种原理工作,他有一个缺陷:也就是说当entity持久化时会有什么问题呢?答:该文件已经转移到了它的最终位置,实体类下的path属性不能够正确的实体化.

如果entity有持久化问题或者文件不能够移动,什么事情也没有发生,为了避免这些问题,你应该改变这种实现方式以便数据库操作和自动删除文件:

  1. /** 
  2.  * @ORM\Entity 
  3.  * @ORM\HasLifecycleCallbacks 
  4.  */ 
  5. class Document 

接下来,利用这些回调函数重构Document类:

  1. use Symfony\Component\HttpFoundation\File\UploadedFile; 
  2.    
  3. /** 
  4.  * @ORM\Entity 
  5.  * @ORM\HasLifecycleCallbacks 
  6.  */ 
  7. class Document 
  8.     private $temp
  9.    
  10.     /** 
  11.      * Sets file. 
  12.      * 
  13.      * @param UploadedFile $file 
  14.      */ 
  15.     public function setFile(UploadedFile $file = null) 
  16.     { 
  17.         $this->file = $file
  18.         // check if we have an old image path 
  19.         // 检查如果我们有一个旧的图片路径 
  20.         if (isset($this->path)) { 
  21.             // store the old name to delete after the update 
  22.             $this->temp = $this->path; 
  23.             $this->path = null; 
  24.         } else { 
  25.             $this->path = 'initial'
  26.         } 
  27.     } 
  28.    
  29.     /** 
  30.      * @ORM\PrePersist() 
  31.      * @ORM\PreUpdate() 
  32.      */ 
  33.     public function preUpload() 
  34.     { 
  35.         if (null !== $this->getFile()) { 
  36.             // do whatever you want to generate a unique name 
  37.             // 去生成一个唯一的名称 
  38.             $filename = sha1(uniqid(mt_rand(), true)); 
  39.             $this->path = $filename.'.'.$this->getFile()->guessExtension(); 
  40.         } 
  41.     } 
  42.    
  43.     /** 
  44.      * @ORM\PostPersist() 
  45.      * @ORM\PostUpdate() 
  46.      */ 
  47.     public function upload() 
  48.     { 
  49.         if (null === $this->getFile()) { 
  50.             return
  51.         } 
  52.    
  53.         // if there is an error when moving the file, an exception will 
  54.         // be automatically thrown by move(). This will properly prevent 
  55.         // the entity from being persisted to the database on error 
  56.         //当移动文件发生错误,一个异常move()会自动抛出异常。 
  57.         //这将阻止实体持久化数据库发生错误。 
  58.         $this->getFile()->move($this->getUploadRootDir(), $this->path); 
  59.    
  60.         // check if we have an old image 
  61.         if (isset($this->temp)) { 
  62.             // delete the old image 
  63.             unlink($this->getUploadRootDir().'/'.$this->temp); 
  64.             // clear the temp image path 
  65.             $this->temp = null; 
  66.         } 
  67.         $this->file = null; 
  68.     } 
  69.    
  70.     /** 
  71.      * @ORM\PostRemove() 
  72.      */ 
  73.     public function removeUpload() 
  74.     { 
  75.         $file = $this->getAbsolutePath(); 
  76.         if ($file) { 
  77.             unlink($file); 
  78.         } 
  79.     } 

如果更改你的entity是由Doctrine event listener 或event subscriber处理,这个 preUpdate()回调函数必须通知Doctrine关于正在做的改变,有关preUpdate事件限制的完整参考请查看 http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#preupdate

现在这个类做了你需要的一切:他会在entity持久化之前生成一个唯一的文件名,持久化之后,移动文件,删除文件.

现在移动文件是entity自动完成,这个$document->upload()就应该从controller中移除了:

  1. if ($form->isValid()) { 
  2.     $em = $this->getDoctrine()->getManager(); 
  3.    
  4.     $em->persist($document); 
  5.     $em->flush(); 
  6.    
  7.     return $this->redirect(...); 

这个@ORM\PrePersist()和@ORM\PostPersist()事件回调:一个是在entity持久化到数据库之前触发,一个是在entity持久化到数据库之后触发。另一方面, @ORM\PreUpdate() 和 @ORM\PostUpdate()事件回调时当实体更新时触发。

当改变entity字段后进行持久化操作时,PreUpdate和PostUpdate回调才会被触发。这意味着,默认情况下,你只改变了$file属性,这些事件不会被触发,因为这个属性它自己不会持久化到Doctrine。有一个解决方法,就是创建一个updated字段把它持久化到Doctrine,并当文件改变时手动调整它。

使用ID作为文件名

如果要使用ID作为文件名,实现略有不同,您需要保存path属性为文件扩展名,而不是实际的文件名:

  1. use Symfony\Component\HttpFoundation\File\UploadedFile; 
  2.    
  3. /** 
  4.  * @ORM\Entity 
  5.  * @ORM\HasLifecycleCallbacks 
  6.  */ 
  7. class Document 
  8.     private $temp
  9.    
  10.     /** 
  11.      * Sets file. 
  12.      * 
  13.      * @param UploadedFile $file 
  14.      */ 
  15.     public function setFile(UploadedFile $file = null) 
  16.     { 
  17.         $this->file = $file
  18.         // check if we have an old image path 
  19.         if (is_file($this->getAbsolutePath())) { 
  20.             // store the old name to delete after the update 
  21.             $this->temp = $this->getAbsolutePath(); 
  22.         } else { 
  23.             $this->path = 'initial'
  24.         } 
  25.     } 
  26.    
  27.     /** 
  28.      * @ORM\PrePersist() 
  29.      * @ORM\PreUpdate() 
  30.      */ 
  31.     public function preUpload() 
  32.     { 
  33.         if (null !== $this->getFile()) { 
  34.             $this->path = $this->getFile()->guessExtension(); 
  35.         } 
  36.     } 
  37.    
  38.     /** 
  39.      * @ORM\PostPersist() 
  40.      * @ORM\PostUpdate() 
  41.      */ 
  42.     public function upload() 
  43.     { 
  44.         if (null === $this->getFile()) { 
  45.             return
  46.         } 
  47.    
  48.         // check if we have an old image 
  49.         if (isset($this->temp)) { 
  50.             // delete the old image 
  51.             unlink($this->temp); 
  52.             // clear the temp image path 
  53.             $this->temp = null; 
  54.         } 
  55.    
  56.         // you must throw an exception here if the file cannot be moved 
  57.         // so that the entity is not persisted to the database 
  58.         // which the UploadedFile move() method does 
  59.         $this->getFile()->move( 
  60.             $this->getUploadRootDir(), 
  61.             $this->id.'.'.$this->getFile()->guessExtension() 
  62.         ); 
  63.    
  64.         $this->setFile(null); 
  65.     } 
  66.    
  67.     /** 
  68.      * @ORM\PreRemove() 
  69.      */ 
  70.     public function storeFilenameForRemove() 
  71.     { 
  72.         $this->temp = $this->getAbsolutePath(); 
  73.     } 
  74.    
  75.     /** 
  76.      * @ORM\PostRemove() 
  77.      */ 
  78.     public function removeUpload() 
  79.     {  //phpfensi.com 
  80.         if (isset($this->temp)) { 
  81.             unlink($this->temp); 
  82.         } 
  83.     } 
  84.    
  85.     public function getAbsolutePath() 
  86.     { 
  87.         return null === $this->path 
  88.             ? null 
  89.             : $this->getUploadRootDir().'/'.$this->id.'.'.$this->path; 
  90.     } 

你会注意到,在这种情况下,你需要做一点工作,以删除该文件,在数据删除之前,你必须保存文件路径(因为它依赖于ID),然后,一旦对象已经完全从数据库中删除,你就可以安全的删除文件(在数据删除之后).

Tags: Doctrine文件上传 Doctrine上传

分享到: