Skip to content

[HtmlSanitizer] Add functions to handle operations on multiple attributes and/or elements #52909

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
Open
wants to merge 2 commits into
base: 7.4
Choose a base branch
from
Open

[HtmlSanitizer] Add functions to handle operations on multiple attributes and/or elements #52909

wants to merge 2 commits into from
+347 −26

Conversation

EdouardCourty
Copy link

Add functions to handle operations on multiple attributes or elements at the same time

Q A
Branch? 7.1
Bug fix? no
New feature? yes
Deprecations? no
Issues None
License MIT

This branch brings supports for array parameters to handle mass allow / block / drop of elements and/or attributes.

Here is a code screenshot that shows how these news methods work:

$config = new HtmlSanitizerConfig();

$attributes = ['height', 'width', 'src'];
$elements = ['img',' iframe'];

/* Current way */
        
foreach ($elements as $element) {
    $config = $config->allowElement($element, $attributes);
}

/* New way */

$config = $config->allowElements($elements, $attributes);

@carsonbot carsonbot added this to the 7.1 milestone Dec 6, 2023
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 7.1 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@EdouardCourty
Copy link
Author

By the way, why is the HtmlSanitizerConfig class using clone statements in all its methods?
image

@stof
Copy link
Member

stof commented Dec 6, 2023

@EdouardCourty being the Config object is immutable (which means that even if you keep a reference to the Config object, you cannot mutate the configuration of a Sanitizer that has been instantiated with it)

stof
stof reviewed Dec 6, 2023
View reviewed changes
@EdouardCourty
Copy link
Author

@EdouardCourty being the Config object is immutable (which means that even if you keep a reference to the Config object, you cannot mutate the configuration of a Sanitizer that has been instantiated with it)

Thanks for your reply, I'll fix the PR asap

@EdouardCourty
[HtmlSanitizer] Add functions to handle operations on multiple attrib…
eebd050 
…utes or elements at the same time

- Wrapped some logic in private functions to stay DRY
- Fixed PHPDoc comments
- Fixed typo
@EdouardCourty EdouardCourty requested a review from stof December 7, 2023 14:47
@xabbuh xabbuh modified the milestones: 7.1, 7.2 May 15, 2024
@fabpot fabpot modified the milestones: 7.2, 7.3 Nov 20, 2024
@fabpot fabpot modified the milestones: 7.3, 7.4 May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stof stof Awaiting requested review from stof

Assignees
No one assigned
Labels
Feature HtmlSanitizer Status: Needs Review
Projects
None yet
Milestone
7.4
Development

Successfully merging this pull request may close these issues.
5 participants
@EdouardCourty @carsonbot @stof @fabpot @xabbuh