Skip to content

Commit

Permalink
bug #175 Fixes for PHP attribute parsing (wouterj)
Browse files Browse the repository at this point in the history 
This PR was squashed before being merged into the main branch.

Discussion
----------

Fixes for PHP attribute parsing

- No longer wrap the entire attribute in a span, but only wrap `#[Route` and `]` in spans (fixes #174)
- `@javiereguiluz` for consistency with the real PHP highlight.js file, I've renamed `php-attributes` to `meta`. Is it OK for you to update the CSS on symfony.com to style `.hljs-meta` instead of `.hljs-php-attributes`?
- Fixed not parsing attributes in parameters, see e.g. https://symfony.com/doc/current/controller.html#mapping-the-whole-query-string

Commits
-------

de706b5 Fixes for PHP attribute parsing
  • Loading branch information
@javiereguiluz
javiereguiluz committed May 27, 2024
2 parents 81e707a + de706b5 commit 533dd4d
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 36 deletions.
55 changes: 37 additions & 18 deletions src/Templates/highlight.php/php.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,30 @@
"keywords": "and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try match switch continue endfor endif declare unset true false goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",
"contains": [
{
"className": "php-attribute",
"begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+|\\\\?[A-Z]+(?=[A-Z][a-z0-9_\\x7f-\\xff])){1,}(?![A-Za-z0-9])(?![$])",
"className": "meta",
"begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+)+\\]"
},
{
"begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+)+(?![A-Za-z0-9])(?![$])",
"end": "]",
"returnBegin": true,
"contains": [
{
"className": "meta",
"begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+)+(?![A-Za-z0-9])(?![$])"
},
{
"begin": "\\(",
"end": "\\)",
"keywords": "true false null new array",
"contains": {
"$ref": "#contains.10.contains.1.contains"
"$ref": "#contains.11.contains.1.contains"
}
},
{
"className": "meta",
"begin": "]",
"endsParent": true
}
]
},
Expand Down Expand Up @@ -50,7 +63,7 @@
"begin": "<\\?(php)?|\\?>"
},
{
"$ref": "#contains.1.contains.0"
"$ref": "#contains.2.contains.0"
},
{
"className": "doctag",
Expand All @@ -69,7 +82,7 @@
"begin": "@[A-Za-z]+"
},
{
"$ref": "#contains.1.contains.0"
"$ref": "#contains.2.contains.0"
},
{
"className": "doctag",
Expand All @@ -84,7 +97,7 @@
"end": false,
"contains": [
{
"$ref": "#contains.1.contains.0"
"$ref": "#contains.2.contains.0"
},
{
"className": "doctag",
Expand Down Expand Up @@ -120,7 +133,7 @@
]
},
{
"$ref": "#contains.2.contains.0"
"$ref": "#contains.3.contains.0"
},
{
"className": "variable",
Expand Down Expand Up @@ -156,15 +169,15 @@
"contains": [
"self",
{
"$ref": "#contains.8"
"$ref": "#contains.9"
},
{
"className": "comment",
"begin": "/\\*",
"end": "\\*/",
"contains": [
{
"$ref": "#contains.1.contains.0"
"$ref": "#contains.2.contains.0"
},
{
"className": "doctag",
Expand All @@ -177,10 +190,10 @@
"className": "string",
"contains": [
{
"$ref": "#contains.5.contains.0"
"$ref": "#contains.6.contains.0"
},
{
"$ref": "#contains.2.contains.0"
"$ref": "#contains.3.contains.0"
}
],
"variants": [
Expand All @@ -199,7 +212,7 @@
"illegal": null,
"contains": [
{
"$ref": "#contains.5.contains.0"
"$ref": "#contains.6.contains.0"
}
]
},
Expand All @@ -210,7 +223,7 @@
"illegal": null,
"contains": [
{
"$ref": "#contains.5.contains.0"
"$ref": "#contains.6.contains.0"
},
{
"className": "subst",
Expand Down Expand Up @@ -239,6 +252,12 @@
"relevance": 0
}
]
},
{
"$ref": "#contains.0"
},
{
"$ref": "#contains.1"
}
]
}
Expand All @@ -255,7 +274,7 @@
"beginKeywords": "extends implements"
},
{
"$ref": "#contains.10.contains.0"
"$ref": "#contains.11.contains.0"
}
]
},
Expand All @@ -265,7 +284,7 @@
"illegal": "[\\.']",
"contains": [
{
"$ref": "#contains.10.contains.0"
"$ref": "#contains.11.contains.0"
}
]
},
Expand All @@ -274,18 +293,18 @@
"end": ";",
"contains": [
{
"$ref": "#contains.10.contains.0"
"$ref": "#contains.11.contains.0"
}
]
},
{
"begin": "=>"
},
{
"$ref": "#contains.10.contains.1.contains.3"
"$ref": "#contains.11.contains.1.contains.3"
},
{
"$ref": "#contains.10.contains.1.contains.4"
"$ref": "#contains.11.contains.1.contains.4"
}
]
}
57 changes: 39 additions & 18 deletions tests/fixtures/expected/blocks/code-blocks/php-attributes.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div translate="no" data-loc="54" class="notranslate codeblock codeblock-length-md codeblock-php-attributes codeblock-php">
<div translate="no" data-loc="65" class="notranslate codeblock codeblock-length-md codeblock-php-attributes codeblock-php">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1
2
Expand Down Expand Up @@ -53,7 +53,18 @@
51
52
53
54</pre>
54
55
56
57
58
59
60
61
62
63
64
65</pre>
<pre class="codeblock-code">
<code>
<span class="hljs-comment">// src/SomePath/SomeClass.php</span>
Expand All @@ -64,77 +75,87 @@
<span class="hljs-title">SomeClass</span>
</span>
{
<span class="hljs-php-attribute">#[AttributeName]</span>
<span class="hljs-meta">#[AttributeName]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property1</span>
;
<span class="hljs-php-attribute">#[AttributeName()]</span>
<span class="hljs-meta">#[AttributeName</span>()<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property2</span>
;
<span class="hljs-php-attribute">#[AttributeName(<span class="hljs-string">'value'</span>)]</span>
<span class="hljs-meta">#[AttributeName</span>(<span class="hljs-string">'value'</span>)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property3</span>
;
<span class="hljs-php-attribute">#[AttributeName(<span class="hljs-string">'value'</span>, option: <span class="hljs-string">'value'</span>)]</span>
<span class="hljs-meta">#[AttributeName</span>(<span class="hljs-string">'value'</span>, option: <span class="hljs-string">'value'</span>)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property4</span>
;
<span class="hljs-php-attribute">#[AttributeName([<span class="hljs-string">'value'</span> =&gt; <span class="hljs-string">'value'</span>])]</span>
<span class="hljs-meta">#[AttributeName</span>([<span class="hljs-string">'value'</span> =&gt; <span class="hljs-string">'value'</span>])<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property5</span>
;
<span class="hljs-php-attribute">#[AttributeName(
<span class="hljs-meta">#[AttributeName</span>(
<span class="hljs-string">'value'</span>,
option: <span class="hljs-string">'value'</span>
)]</span>
)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property6</span>
;
<span class="hljs-php-attribute">#[Assert\AttributeName(<span class="hljs-string">'value'</span>)]</span>
<span class="hljs-meta">#[Assert\AttributeName</span>(<span class="hljs-string">'value'</span>)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property7</span>
;
<span class="hljs-php-attribute">#[Assert\AttributeName(
<span class="hljs-meta">#[Assert\AttributeName</span>(
<span class="hljs-string">'value'</span>,
option: <span class="hljs-string">'value'</span>
)]</span>
)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property8</span>
;
<span class="hljs-php-attribute">#[Route(<span class="hljs-string">'/blog/{page&lt;\d+&gt;}'</span>, name: <span class="hljs-string">'blog_list'</span>)]</span>
<span class="hljs-meta">#[Route</span>(<span class="hljs-string">'/blog/{page&lt;\d+&gt;}'</span>, name: <span class="hljs-string">'blog_list'</span>)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property9</span>
;
<span class="hljs-php-attribute">#[Assert\GreaterThanOrEqual(
<span class="hljs-meta">#[Assert\GreaterThanOrEqual</span>(
value: <span class="hljs-number">18</span>,
)]</span>
)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property10</span>
;
<span class="hljs-php-attribute">#[ORM\CustomIdGenerator(class: <span class="hljs-string">'doctrine.uuid_generator'</span>)]</span>
<span class="hljs-meta">#[ORM\CustomIdGenerator</span>(class: <span class="hljs-string">'doctrine.uuid_generator'</span>)<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property11</span>
;
<span class="hljs-php-attribute">#[Assert\AtLeastOneOf([
<span class="hljs-meta">#[Assert\AtLeastOneOf</span>([
<span class="hljs-keyword">new</span> Assert\Regex(<span class="hljs-string">'/#/'</span>),
<span class="hljs-keyword">new</span> Assert\Length(min: <span class="hljs-number">10</span>),
])]</span>
])<span class="hljs-meta">]</span>
<span class="hljs-keyword">private</span>
<span class="hljs-variable">
<span class="hljs-variable-other-marker">$</span> property12</span>
;
<span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">__construct</span><span class="hljs-params">(
<span class="hljs-meta">#[TaggedIterator</span>(<span class="hljs-string">'app.handlers'</span>)<span class="hljs-meta">]</span>
iterable <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>handlers</span>,
)</span></span>{
}

<span class="hljs-meta">#[AsController]</span>
<span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-title">someAction</span><span class="hljs-params">(<span class="hljs-meta">#[CurrentUser]</span> User <span class="hljs-variable"><span class="hljs-variable-other-marker">$</span>user</span>)</span></span>
{
}
}</code></pre>
</div>
</div>
11 changes: 11 additions & 0 deletions tests/fixtures/source/blocks/code-blocks/php-attributes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,15 @@
new Assert\Length(min: 10),
])]
private $property12;
public function __construct(
#[TaggedIterator('app.handlers')]
iterable $handlers,
) {
}
#[AsController]
public function someAction(#[CurrentUser] User $user)
{
}
}

0 comments on commit 533dd4d

Please sign in to comment.