richwestcoast / vcard
v1.8
2022-01-28 14:01 UTC
Requires
- php: >=5.3.3
- behat/transliterator: ~1.0
Requires (Dev)
- phpunit/phpunit: 4.6.*
README
这个 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 字符串,如下所示
// 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分支中拉取。
- 每个功能一个拉取请求 - 如果你想要做更多的事情,请发送多个拉取请求。
- 发送连贯的历史记录 - 确保你的拉取请求中的每个单独的提交都有意义。如果在开发过程中必须进行多个中间提交,请在提交前将它们合并。
问题
用于错误报告或代码讨论。
有关在 help.github.com 上如何使用 GitHub 的更多信息。
致谢
许可证
该模块受 MIT 许可证的保护。简而言之,此许可证允许你做任何事,只要版权声明保持存在。