g-varlamov/stapler

适用于PHP的优雅且简单的基于ORM的文件上传包。

v1.0.0 2024-05-28 07:39 UTC

This package is auto-updated.

Last update: 2024-09-28 08:57:42 UTC


README

#Stapler Build Status Latest Stable Version Total Downloads Latest Unstable Version License

注意: 如果您之前已经使用过此包,那么您已经使用Laravel使用过它。此包不再直接与Laravel框架耦合。从1.0.0版开始,Stapler现在是框架无关的。为了利用先前Beta版本提供的Laravel特定功能(服务提供者、IOC容器、命令、迁移生成器等),我创建了一个专门的包,专门用于在Laravel中使用Stapler:Laravel-Stapler。如果您在Laravel应用程序中使用Stapler,我强烈建议您使用此包(它可以节省一些样板代码)。

Stapler是一个基于PHP的框架无关文件上传包,灵感来源于Ruby Paperclip宝石。它可用于将文件上传(作为附件对象)添加到ORM记录中。虽然不是完全相同,但如果您之前使用过Paperclip,那么您应该会非常舒适地使用这个包。

Stapler是由Travis Bennett创建的。

要求

Stapler目前需要php >= 5.4(Stapler通过使用特质来实现)。

安装

Stapler作为composer包分发,这是在您的应用程序中使用它的方式。

使用Composer安装包。编辑您的项目composer.json文件以要求codesleeve/stapler

  "require": {
    "codesleeve/stapler": "1.0.*"
  }

关于Stapler

Stapler通过将文件上传附加到数据库表记录来工作。这是通过在表对应的模型中定义附件,然后在保存之前将上传的文件(从您的表单中)作为属性(以附件命名)分配给模型来完成的。Stapler将监听模型的生存周期回调(保存后、删除前、删除后)并相应地处理文件。本质上,这允许上传的文件就像模型上的任何其他属性一样被对待;stapler将抽象出所有文件处理、存储等,这样您就可以专注于项目的其他部分,而无需担心文件在哪里或如何检索它们。

主要好处

  • 现代:Stapler运行在php >= 5.4之上,并利用了许多现代PHP提供的新功能(特质、可调用类型提示等)。
  • 简单:传统上,文件上传一直被认为是一项艰巨的任务;Stapler减少了在整个过程中所需的大部分冗余操作。说真的,Stapler使文件上传(任何类型)变得极其简单。
  • 灵活:Stapler提供极其灵活的级联配置;只需更改单个配置选项,即可配置文件本地存储或通过AWS S3存储。
  • 可扩展:将您的资产存储在中央位置(如S3)允许您的文件从单一位置被多个网络实例访问。
  • 强大:Stapler利用现代面向对象的编程模式,为文件上传提供坚实的架构。它基于特性的驱动系统提供了跨多种ORM(包括Active Record和数据映射实现)以及实现生命周期回调的潜力。

文档