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

v1.7.4 2023-09-07 19:46 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 jeroendesloovere/vcard

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

示例

use JeroenDesloovere\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@jeroendesloovere.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.jeroendesloovere.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 JeroenDesloovere\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.com上使用GitHub的更多信息。

鸣谢

许可证

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