Skip to content

Commit c98e749

Browse files
dshanskeZegnat
dshanske
and
Zegnat
authored
Parse an image for src and alt (#218)
* Parse an image for src and alt * Requested fixes * Update tests to pass with alt text on images * Add breaking test: return alt on implied photo from root element * Fix breaking test: check for alt when implying photo prop * Update test to be in line with latest fixes * Rewrite broken test to correctly test 3 different cases Co-authored-by: Martijn van der Ven <[email protected]>
1 parent ba101c6 commit c98e749

6 files changed

+117
-16
lines changed

‎Mf2/Parser.php

+29-4
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,22 @@ private function elementToString(DOMElement $input, $implied=false)
505505
return $output;
506506
}
507507

508+
/**
509+
* Given an img property, parse its value and/or alt text
510+
* @param DOMElement $el
511+
* @access public
512+
* @return string|array
513+
*/
514+
public function parseImg(DOMElement $el)
515+
{
516+
if ($el->hasAttribute('alt')) {
517+
return [
518+
'value' => $this->resolveUrl( $el->getAttribute('src') ),
519+
'alt' => $el->getAttribute('alt')
520+
];
521+
}
522+
return $el->getAttribute('src');
523+
}
508524
/**
509525
* This method parses the language of an element
510526
* @param DOMElement $el
@@ -536,6 +552,10 @@ public function language(DOMElement $el)
536552

537553
// TODO: figure out if this has problems with sms: and geo: URLs
538554
public function resolveUrl($url) {
555+
// If not a string then return.
556+
if (!is_string($url)){
557+
return $url;
558+
}
539559
// If the URL is seriously malformed it’s probably beyond the scope of this
540560
// parser to try to do anything with it.
541561
if (parse_url($url) === false) {
@@ -634,7 +654,9 @@ public function parseP(\DOMElement $p) {
634654
public function parseU(\DOMElement $u) {
635655
if (($u->tagName == 'a' or $u->tagName == 'area' or $u->tagName == 'link') and $u->hasAttribute('href')) {
636656
$uValue = $u->getAttribute('href');
637-
} elseif (in_array($u->tagName, array('img', 'audio', 'video', 'source')) and $u->hasAttribute('src')) {
657+
} elseif ( $u->tagName == 'img' and $u->hasAttribute('src') ) {
658+
$uValue = $this->parseImg($u);
659+
} elseif (in_array($u->tagName, array('audio', 'video', 'source')) and $u->hasAttribute('src')) {
638660
$uValue = $u->getAttribute('src');
639661
} elseif ($u->tagName == 'video' and !$u->hasAttribute('src') and $u->hasAttribute('poster')) {
640662
$uValue = $u->getAttribute('poster');
@@ -649,7 +671,8 @@ public function parseU(\DOMElement $u) {
649671
} else {
650672
$uValue = $this->textContent($u);
651673
}
652-
return $this->resolveUrl($uValue);
674+
675+
return $this->resolveUrl($uValue);
653676
}
654677

655678
/**
@@ -1172,7 +1195,7 @@ public function parseImpliedPhoto(\DOMElement $e) {
11721195

11731196
// img.h-x[src]
11741197
if ($e->tagName == 'img') {
1175-
return $this->resolveUrl($e->getAttribute('src'));
1198+
return $this->resolveUrl($this->parseImg($e));
11761199
}
11771200

11781201
// object.h-x[data]
@@ -1197,7 +1220,8 @@ public function parseImpliedPhoto(\DOMElement $e) {
11971220
if ($els !== false && $els->length === 1) {
11981221
$el = $els->item(0);
11991222
if ($el->tagName == 'img') {
1200-
return $this->resolveUrl($el->getAttribute('src'));
1223+
$return = $this->parseImg($el);
1224+
return $this->resolveUrl($return);
12011225
} else if ($el->tagName == 'object') {
12021226
return $this->resolveUrl($el->getAttribute('data'));
12031227
}
@@ -1428,6 +1452,7 @@ public function parse_recursive(DOMElement $context = null, $depth = 0) {
14281452
$parsed_property = $this->parseDT($node);
14291453
$prefixSpecificResult['value'] = ($parsed_property) ? $parsed_property : '';
14301454
}
1455+
$prefixSpecificResult['value'] = is_array($prefixSpecificResult['value']) ? $prefixSpecificResult['value']['value'] : $prefixSpecificResult['value'];
14311456

14321457
$mfs['properties'][$property][] = $prefixSpecificResult;
14331458
}

‎tests/Mf2/CombinedMicroformatsTest.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,7 @@ public function testMicroformatsNestedUnderEPropertyClassnamesRetainHtmlKey() {
246246
public function testMicroformatsNestedUnderUPropertyClassnamesDeriveValueCorrectly() {
247247
$input = '<div class="h-entry"><img class="u-url h-card" alt="This should not be the value" src="This should be the value" /></div>';
248248
$mf = Mf2\parse($input);
249-
250-
$this->assertEquals($mf['items'][0]['properties']['url'][0]['value'], 'This should be the value');
249+
$this->assertEquals($mf['items'][0]['properties']['url'][0]['value'], 'This should be the value', json_encode($mf['items'][0]['properties']['url'][0]));
251250
}
252251

253252
public function testMicroformatsNestedUnderUPropertyClassnamesDeriveValueFromURL() {

‎tests/Mf2/MicroformatsWikiExamplesTest.php

+14-3
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,10 @@ public function testSimplePersonImage() {
110110
"type": ["h-card"],
111111
"properties": {
112112
"name": ["Chris Messina"],
113-
"photo": ["http://example.org/pic.jpg"]
113+
"photo": [{
114+
"value": "http://example.org/pic.jpg",
115+
"alt": "Chris Messina"
116+
}]
114117
}
115118
}]}';
116119
$parser = new Parser($input, '', true);
@@ -136,7 +139,10 @@ public function testHyperlinkedImageNameAndPhotoProperties() {
136139
"properties": {
137140
"name": ["Rohit Khare"],
138141
"url": ["http://rohit.khare.org/"],
139-
"photo": ["https://s3.amazonaws.com/twitter_production/profile_images/53307499/180px-Rohit-sq_bigger.jpg"]
142+
"photo": [{
143+
"value": "https://s3.amazonaws.com/twitter_production/profile_images/53307499/180px-Rohit-sq_bigger.jpg",
144+
"alt": "Rohit Khare"
145+
}]
140146
}
141147
}]}';
142148
$parser = new Parser($input, '', true);
@@ -172,7 +178,12 @@ public function testMoreDetailedPerson() {
172178
"items": [{
173179
"type": ["h-card"],
174180
"properties": {
175-
"photo": ["https://webfwd.org/content/about-experts/300.mitchellbaker/mentor_mbaker.jpg"],
181+
"photo": [
182+
{
183+
"value": "https://webfwd.org/content/about-experts/300.mitchellbaker/mentor_mbaker.jpg",
184+
"alt": "photo of Mitchell"
185+
}
186+
],
176187
"name": ["Mitchell Baker"],
177188
"url": [
178189
"http://blog.lizardwrangler.com/",

‎tests/Mf2/ParseImpliedTest.php

+40-6
Original file line numberDiff line numberDiff line change
@@ -54,22 +54,46 @@ public function testParsesImpliedPNameFromDoublyNestedImgAlt() {
5454
$this->assertEquals('The Name', $output['items'][0]['properties']['name'][0]);
5555
}
5656

57-
public function testParsesImpliedUPhotoFromImgSrc() {
58-
$input = '<img class="h-card" src="http://example.com/img.png" alt="" />';
57+
public function testParsesImpliedUPhotoFromImgSrcWithoutAlt() {
58+
$input = '<img class="h-card" src="http://example.com/img.png" />';
5959
$parser = new Parser($input);
6060
$output = $parser->parse();
6161

6262
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
6363
$this->assertEquals('http://example.com/img.png', $output['items'][0]['properties']['photo'][0]);
6464
}
6565

66+
public function testParsesImpliedUPhotoFromImgSrcWithEmptyAlt() {
67+
$input = '<img class="h-card" src="http://example.com/img.png" alt="" />';
68+
$parser = new Parser($input);
69+
$output = $parser->parse();
70+
71+
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
72+
$this->assertEquals('http://example.com/img.png', $output['items'][0]['properties']['photo'][0]['value']);
73+
$this->assertEquals('', $output['items'][0]['properties']['photo'][0]['alt']);
74+
}
75+
76+
public function testParsesImpliedUPhotoFromImgSrcWithAlt() {
77+
$input = '<img class="h-card" src="http://example.com/img.png" alt="Example" />';
78+
$parser = new Parser($input);
79+
$output = $parser->parse();
80+
81+
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
82+
$this->assertEquals('http://example.com/img.png', $output['items'][0]['properties']['photo'][0]['value']);
83+
$this->assertEquals('Example', $output['items'][0]['properties']['photo'][0]['alt']);
84+
}
85+
6686
public function testParsesImpliedUPhotoFromNestedImgSrc() {
6787
$input = '<div class="h-card"><img src="http://example.com/img.png" alt="" /></div>';
6888
$parser = new Parser($input);
6989
$output = $parser->parse();
7090

7191
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
72-
$this->assertEquals('http://example.com/img.png', $output['items'][0]['properties']['photo'][0]);
92+
$return = [
93+
'value' => 'http://example.com/img.png',
94+
'alt'=> ''
95+
];
96+
$this->assertEquals( $return, $output['items'][0]['properties']['photo'][0]);
7397
}
7498

7599
public function testParsesImpliedUPhotoFromDoublyNestedImgSrc() {
@@ -78,7 +102,11 @@ public function testParsesImpliedUPhotoFromDoublyNestedImgSrc() {
78102
$output = $parser->parse();
79103

80104
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
81-
$this->assertEquals('http://example.com/img.png', $output['items'][0]['properties']['photo'][0]);
105+
$result = [
106+
'alt' => '',
107+
'value' => 'http://example.com/img.png'
108+
];
109+
$this->assertEquals($result, $output['items'][0]['properties']['photo'][0]);
82110
}
83111

84112
/*
@@ -169,15 +197,21 @@ public function testMultipleImpliedHCards() {
169197
"type": ["h-card"],
170198
"properties": {
171199
"name": ["Sally Ride"],
172-
"photo": ["http://upload.wikimedia.org/wikipedia/commons/a/a4/Ride-s.jpg"]
200+
"photo": [{
201+
"value": "http://upload.wikimedia.org/wikipedia/commons/a/a4/Ride-s.jpg",
202+
"alt": "Sally Ride"
203+
}]
173204
}
174205
},
175206
{
176207
"type": ["h-card"],
177208
"properties": {
178209
"name": ["Tantek Çelik"],
179210
"url": ["http://tantek.com"],
180-
"photo": ["http://ttk.me/logo.jpg"]
211+
"photo": [{
212+
"value": "http://ttk.me/logo.jpg",
213+
"alt": "Tantek Çelik"
214+
}]
181215
}
182216
}]
183217
}';

‎tests/Mf2/ParseUTest.php

+28
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,34 @@ public function testParseUHandlesImg() {
6262
$this->assertEquals('http://example.com/someimage.png', $output['items'][0]['properties']['photo'][0]);
6363
}
6464

65+
/**
66+
* @group parseU
67+
*/
68+
public function testParseUHandlesImgwithAlt() {
69+
$input = '<div class="h-card"><img class="u-photo" src="http://example.com/someimage.png" alt="Test Alt"></div>';
70+
$parser = new Parser($input);
71+
$output = $parser->parse();
72+
73+
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
74+
$result = array(
75+
'value' => 'http://example.com/someimage.png',
76+
'alt' => 'Test Alt'
77+
);
78+
$this->assertEquals( $result, $output['items'][0]['properties']['photo'][0]);
79+
}
80+
81+
/**
82+
* @group parseU
83+
*/
84+
public function testParseUHandlesImgwithoutAlt() {
85+
$input = '<div class="h-card"><img class="u-photo" src="http://example.com/someimage.png"></div>';
86+
$parser = new Parser($input);
87+
$output = $parser->parse();
88+
89+
$this->assertArrayHasKey('photo', $output['items'][0]['properties']);
90+
$this->assertEquals( 'http://example.com/someimage.png', $output['items'][0]['properties']['photo'][0]);
91+
}
92+
6593
/**
6694
* @group parseU
6795
*/

‎tests/Mf2/ParserTest.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,11 @@ public function testHtmlEncodesImpliedProperties() {
173173

174174
$this->assertEquals('<name>', $output['items'][0]['properties']['name'][0]);
175175
$this->assertEquals('<url>', $output['items'][0]['properties']['url'][0]);
176-
$this->assertEquals('<img>', $output['items'][0]['properties']['photo'][0]);
176+
$result = [
177+
'value' => '<img>',
178+
'alt' => ''
179+
];
180+
$this->assertEquals($result, $output['items'][0]['properties']['photo'][0]);
177181
}
178182

179183
public function testParsesRelValues() {

0 commit comments

Comments
 (0)