arvindabu/vcard

这个 VCard PHP 类可以生成带有数据的 vCard。当使用 iOS 设备时,它将导出为 .ics 文件,因为 iOS 设备不支持默认的 .vcf 文件。

1.7.4 2023-08-22 17:54 UTC

This package is auto-updated.

Last update: 2024-09-22 20:43:19 UTC


README

Latest Stable Version License Build Status Scrutinizer Code Quality

这个 VCard PHP 库可以生成带有数据的 vCard。当使用 iOS 设备 < iOS 8 时,它将导出为 .ics 文件,因为 iOS 设备不支持默认的 .vcf 文件。

注意:我们正在开发一个全新的版本,用于与 vCard 版本 4.0 一起使用,具有极高的代码质量。查看新版本

使用方法

安装

composer require arvindabu/vcard

这将使用 Composer 安装 vcard 的最新版本。

示例

use arvindabu\VCard\VCard;

// define vcard
$vcard = new VCard();

// define variables
$lastname = 'Desloovere';
$firstname = 'Jeroen';
$additional = '';
$prefix = '';
$suffix = '';

// add personal data
$vcard->addName($lastname, $firstname, $additional, $prefix, $suffix);

// add work data
$vcard->addCompany('Siesqo');
$vcard->addJobtitle('Web Developer');
$vcard->addRole('Data Protection Officer');
$vcard->addEmail('info@arvindabu.be');
$vcard->addPhoneNumber(1234121212, 'PREF;WORK');
$vcard->addPhoneNumber(123456789, 'WORK');
$vcard->addAddress(null, null, 'street', 'worktown', null, 'workpostcode', 'Belgium');
$vcard->addLabel('street, worktown, workpostcode Belgium');
$vcard->addURL('http://www.arvindabu.be');

$vcard->addPhoto(__DIR__ . '/landscape.jpeg');

// return vcard as a string
//return $vcard->getOutput();

// return vcard as a download
return $vcard->download();

// save vcard on disk
//$vcard->setSavePath('/path/to/directory');
//$vcard->save();

查看所有示例 或检查 VCard 类

解析示例

解析器可以传递一个 VCard 字符串,如下所示

// load VCardParser classes
use arvindabu\VCard\VCardParser;

$parser = new VCardParser($vcardString);
echo $parser->getCardAtIndex(0)->fullname; // Prints the full name.

或者使用一个带文件名的工厂方法

$parser = VCardParser::parseFromFile('path/to/file.vcf');
echo $parser->getCardAtIndex(0)->fullname; // Prints the full name.

查看解析示例 或检查 VCardParser 类 类。

框架支持

我创建了一个 Symfony Bundle:VCard Bundle

例如在 Laravel 中的使用

return Response::make(
    $this->vcard->getOutput(),
    200,
    $this->vcard->getHeaders(true)
);

测试

vendor/bin/phpunit tests

文档

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

贡献

贡献是 欢迎 的,并将得到完全 认可

拉取请求

用于添加或更新代码

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

问题

用于错误报告或代码讨论。

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

致谢

许可证

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