jeroendesloovere/xmp-metadata-extractor

使用 PHP 从图像中提取 XMP 元数据。

v2.0.0 2017-12-13 16:04 UTC

This package is auto-updated.

Last update: 2024-09-17 03:01:00 UTC


README

Packagist License Build Status Scrutinizer Code Quality

使用 PHP 从图像/文件中提取 XMP 元数据。

用法

安装

当使用 composer 时,您可以在终端中执行以下操作

composer require jeroendesloovere/xmp-metadata-extractor

示例

use JeroenDesloovere\XmpMetadataExtractor;
$xmpDataExtractor = new XmpMetadataExtractor();

# Get XmpData from file
$xmpData = $xmpDataExtractor->extractFromFile('path/to/filename.jpg'):

# OR get XmpData by given the file content - file_get_contents(...);
$xmpData = $xmpDataExtractor->extractFromContent('... file content ...'):

$xmpData 将是一个包含所有 XMP 元数据的 数组

测试

XmpMetadataExtractor 类有测试用例。 查看所有测试用例

使用 vendor/bin/phpunit 来执行测试。

代码规范

我们使用 squizlabs/php_codesniffer 来维护代码规范。输入以下命令来执行它们

# To view the code errors
vendor/bin/phpcs --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

# OR to fix the code errors
vendor/bin/phpcbf --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

阅读有关代码规范的文档

文档

该类有很好的内部文档。如果您使用了一个不错的 IDE,您会看到每个方法都使用 PHPDoc 进行了文档说明。

贡献

贡献是 欢迎的,并且将得到充分 认可

拉取请求

添加或更新代码

  • 编码语法 - 请确保代码语法与包的其他部分保持一致。
  • 添加单元测试! - 如果您的补丁没有测试,则不会被接受。
  • 记录任何行为变化 - 确保 README 和任何其他相关文档保持最新。
  • 考虑我们的发布周期 - 我们尽量遵循 semver。随机破坏公共 API 不是选项。
  • 创建主题分支 - 不要要求我们从您的 master 分支中拉取。
  • 每个功能一个拉取请求 - 如果您想做更多的事情,请发送多个拉取请求。
  • 发送连贯的历史记录 - 确保您的拉取请求中的每个单独的提交都有意义。如果您在开发过程中不得不做出多个中间提交,请在提交之前将它们压缩。

问题

有关错误报告或代码讨论。

有关如何在 GitHub 上工作的更多信息,请参阅 help.github.com。

致谢

许可

该模块遵循 MIT 许可。简而言之,此许可证允许您做任何事,只要保留版权声明。