Unverified Commit f1b1d3f8 authored by alexpott's avatar alexpott

Issue #2484693 by mjpa, dww, DuaelFr, vaplas, kyvour, benjy, JinX-Be, wengerk,...

Issue #2484693 by mjpa, dww, DuaelFr, vaplas, kyvour, benjy, JinX-Be, wengerk, thamas, FMB, ndf, jcnventura, catch: Telephone Link field formatter InvalidArgumentException with 5 digits or fewer in the number
parent b48e1e74
......@@ -67,6 +67,21 @@ public function viewElements(FieldItemListInterface $items, $langcode) {
$title_setting = $this->getSetting('title');
foreach ($items as $delta => $item) {
// If the telephone number is 5 or less digits, parse_url() will think
// it's a port number rather than a phone number which causes the link
// formatter to throw an InvalidArgumentException. Avoid this by inserting
// a dash (-) after the first digit - RFC 3966 defines the dash as a
// visual separator character and so will be removed before the phone
// number is used. See https://bugs.php.net/bug.php?id=70588 for more.
// While the bug states this only applies to numbers <= 65535, a 5 digit
// number greater than 65535 will cause parse_url() to return FALSE so
// we need the work around on any 5 digit (or less) number.
// First we strip whitespace so we're counting actual digits.
$phone_number = preg_replace('/\s+/', '', $item->value);
if (strlen($phone_number) <= 5) {
$phone_number = substr_replace($phone_number, '-', 1, 0);
}
// Render each element as link.
$element[$delta] = [
'#type' => 'link',
......@@ -74,7 +89,7 @@ public function viewElements(FieldItemListInterface $items, $langcode) {
// itself as title.
'#title' => $title_setting ?: $item->value,
// Prepend 'tel:' to the telephone number.
'#url' => Url::fromUri('tel:' . rawurlencode(preg_replace('/\s+/', '', $item->value))),
'#url' => Url::fromUri('tel:' . rawurlencode($phone_number)),
'#options' => ['external' => TRUE],
];
......
......@@ -31,20 +31,15 @@ class TelephoneFieldTest extends BrowserTestBase {
*/
protected $webUser;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->drupalCreateContentType(['type' => 'article']);
$this->webUser = $this->drupalCreateUser(['create article content', 'edit own article content']);
$this->drupalLogin($this->webUser);
}
// Test fields.
/**
* Helper function for testTelephoneField().
*/
public function testTelephoneField() {
// Add the telephone field to the article content type.
FieldStorageConfig::create([
......@@ -74,29 +69,54 @@ public function testTelephoneField() {
'weight' => 1,
])
->save();
}
// Display creation form.
/**
* Test to confirm the widget is setup.
*
* @covers \Drupal\telephone\Plugin\Field\FieldWidget\TelephoneDefaultWidget::formElement
*/
public function testTelephoneWidget() {
$this->drupalGet('node/add/article');
$this->assertFieldByName("field_telephone[0][value]", '', 'Widget found.');
$this->assertRaw('placeholder="123-456-7890"');
}
/**
* Test the telephone formatter.
*
* @covers \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter::viewElements
*
* @dataProvider providerPhoneNumbers
*/
public function testTelephoneFormatter($input, $expected) {
// Test basic entry of telephone field.
$edit = [
'title[0][value]' => $this->randomMachineName(),
'field_telephone[0][value]' => "123456789",
'field_telephone[0][value]' => $input,
];
$this->drupalPostForm(NULL, $edit, t('Save'));
$this->assertRaw('<a href="tel:123456789">', 'A telephone link is provided on the article node page.');
$this->drupalPostForm('node/add/article', $edit, t('Save'));
$this->assertRaw('<a href="tel:' . $expected . '">');
}
// Add number with a space in it. Need to ensure it is stripped on output.
$edit = [
'title[0][value]' => $this->randomMachineName(),
'field_telephone[0][value]' => "1234 56789",
/**
* Provides the phone numbers to check and expected results.
*/
public function providerPhoneNumbers() {
return [
'standard phone number' => ['123456789', '123456789'],
'whitespace is removed' => ['1234 56789', '123456789'],
'parse_url(0) return FALSE workaround' => ['0', '0-'],
'php bug 70588 workaround - lower edge check' => ['1', '1-'],
'php bug 70588 workaround' => ['123', '1-23'],
'php bug 70588 workaround - with whitespace removal' => ['1 2 3 4 5', '1-2345'],
'php bug 70588 workaround - upper edge check' => ['65534', '6-5534'],
'php bug 70588 workaround - edge check' => ['65535', '6-5535'],
'php bug 70588 workaround - invalid port number - lower edge check' => ['65536', '6-5536'],
'php bug 70588 workaround - invalid port number - upper edge check' => ['99999', '9-9999'],
'lowest number not affected by php bug 70588' => ['100000', '100000'],
];
$this->drupalPostForm('node/add/article', $edit, t('Save'));
$this->assertRaw('<a href="tel:123456789">', 'Telephone link is output with whitespace removed.');
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment