Skip to content

feat(VCard): add getByTypes method (#717) #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(VCard): add getByTypes method (#717) #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions lib/Component/VCard.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,34 @@ public function getByType(string $propertyName, string $type)
return null;
}

/**
* Returns a property with a specific TYPE value (ADR, TEL, or EMAIL).
*
* This function will return null if the exact property list does not exist.
*
* For example to get the property of `TEL;TYPE=HOME,CELL`
* you would call `getByTypes('TEL', ['HOME', 'CELL'])`
*
* @param string[] $types
*
* @return \ArrayAccess|array|null
*/
public function getByTypes(string $propertyName, array $types)
{
$types = array_map('strtolower', $types);
foreach ($this->select($propertyName) as $field) {
if (isset($field['TYPE'])) {
$parts = array_map('strtolower', $field['TYPE']->getParts());

if (!array_diff($types, $parts) && !array_diff($parts, $types)) {
return $field;
}
}
}

return null;
}

/**
* This method should return a list of default property values.
*/
Expand Down
21 changes: 21 additions & 0 deletions tests/VObject/Component/VCardTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,27 @@ public function testGetByType(): void
self::assertNull($vcard->getByType('ADR', 'non-existent'));
}

public function testGetByTypes(): void
{
$vcard = <<<VCF
BEGIN:VCARD
VERSION:3.0
TEL;TYPE=HOME,CELL:112233445566
TEL;TYPE=WORK,cell:665544332211
TEL;TYPE=WORK:7778889994455
TEL;TYPE=EXTERNAL:555555555
END:VCARD
VCF;

$vcard = VObject\Reader::read($vcard);
self::assertEquals('112233445566', $vcard->getByTypes('TEL', ['home', 'cell'])->getValue());
self::assertEquals('665544332211', $vcard->getByTypes('TEL', ['work', 'cell'])->getValue());
self::assertEquals('7778889994455', $vcard->getByTypes('TEL', ['work'])->getValue());
self::assertEquals('555555555', $vcard->getByTypes('TEL', ['external'])->getValue());
self::assertNull($vcard->getByTypes('TEL', ['non-existent']));
self::assertNull($vcard->getByTypes('EMAIL', ['non-existent']));
}

public function testPreferredNoPref(): void
{
$vcard = <<<VCF
Expand Down