Skip to content
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

Jump to bottom

🎨 add type hints to assets method #208

Closed
wants to merge 2 commits into from
Closed

🎨 add type hints to assets method #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a25e5a5
🎨 add type hints to `assets` method
codepuncher Feb 28, 2024
9beee88
remove superfluous docblock hints from stubs
codepuncher Feb 28, 2024
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
7 changes: 2 additions & 5 deletions src/Block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ abstract class Block extends Composer implements BlockContract
*
* @return void
*
* @deprecated Use `assets($block)` instead.
* @deprecated Use `assets(array $block): void` instead.
*/
public function enqueue()
{
Expand All @@ -250,11 +250,8 @@ public function enqueue()

/**
* Assets enqueued when rendering the block.
*
* @param array $block
* @return void
*/
public function assets($block)
public function assets(array $block): void
{
//
}
Expand Down
7 changes: 4 additions & 3 deletions src/Console/UpgradeCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ public function handle()
$this->replacements = [
'use StoutLogic\\AcfBuilder\\FieldsBuilder;' => 'use Log1x\\AcfComposer\\Builder;',
'new FieldsBuilder(' => 'Builder::make(',
'public function enqueue($block)' => 'public function assets($block)',
'public function enqueue($block = [])' => 'public function assets($block)',
'public function enqueue()' => 'public function assets($block)',
'public function assets($block)' => 'public function assets(array $block)',
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sadly this wont work since PHP will throw an error when ACF Composer gets booted in CLI because the classes don't match the parent

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. How would you like to handle this then?
Add manual update notes like you did for the v3 release?
sed -i 's/public function assets($block)/public function assets(array $block)/g' app/Blocks/*.php?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. How would you like to handle this then? Add manual update notes like you did for the v3 release? sed -i 's/public function assets($block)/public function assets(array $block)/g' app/Blocks/*.php?

yeah sadly it would be another breaking change which i really didn't want to do. i actually intentionally renamed this from enqueue to assets just to avoid it - but its my bad for not adding the types. :/

i would probably just put it in the upgrade v3 upgrade guide and hope that there has been a lot of upgrades if i were to do this i guess.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also noticed that I missed off the :void return type from these upgrades anyway so the end result would be a fatal error.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pondering maybe removing assets() from the abstract class and doing a method_exists check or something instead. not sure, just a thought.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I guess method_exists makes some sense; not all blocks have assets to enqueue so the user would only add assets() when they need it.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the other upgrades from enqueue() are still missing :void

'public function enqueue($block)' => 'public function assets(array $block)',
'public function enqueue($block = [])' => 'public function assets(array $block)',
'public function enqueue()' => 'public function assets(array $block)',
'/->addFields\(\$this->get\((.*?)\)\)/' => fn ($match) => "->addPartial({$match[1]})",
];

Expand Down
5 changes: 1 addition & 4 deletions src/Console/stubs/block.construct.stub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,8 @@ class DummyClass extends Block

/**
* Assets enqueued when rendering the block.
*
* @param array $block
* @return void
*/
public function assets($block)
public function assets(array $block): void
{
//
}
Expand Down
5 changes: 1 addition & 4 deletions src/Console/stubs/block.stub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,8 @@ class DummyClass extends Block

/**
* Assets enqueued when rendering the block.
*
* @param array $block
* @return void
*/
public function assets($block)
public function assets(array $block): void
{
//
}
Expand Down