Adds a rule to slug

[jhuet]

What?

Adds a rule to slug a field with its own value or from another field's.

Checklist

• Added unit test for added/fixed code
• Updated the documentation
• Scrutinizer code coverage is 100%
• Scrutinizer code quality is as high as possible

Linked issue

None.

[rick-nu]

Hey! Thank you very much for your contribution! I really like this addition, I will give it a closer look soon, but from what I've seen now it's looking really good. 👍

[rick-nu]

And I will also look into why Scrutinizer isn't building pull requests anymore :\

[jhuet]

Hi @RickvdStaaij, i actually have a little problem with its usage right now :)

I think most people will slug a field based on another one, say a title for example. Now, if for some reason, i don't provide title to the filter, i end up with an empty string slug because i used defaults('') on slug so it would still be filtered if not provided.

To avoid using defaults('') i found out about $allowNotSet = true property which is a better approach but it will always set slug to whatever value i return, even null.

What i think should be the desired result would be to actually have no slug key in the filtered result at all if its field provider is not being filtered either.

Here's an example for comprehension sake :)

Actual result with $allowNotSet = true:

$filter->value('slug')->slug('name');
$result = $filter->filter([
    'foo' => 'bar',
]);
// $result = array(2) { ["foo"]=> string(3) "bar" ["slug"]=> NULL } 

Now the expected result should be :

$filter->value('slug')->slug('name');
$result = $filter->filter([
    'foo' => 'bar',
]);
// $result = array(2) { ["foo"]=> string(3) "bar" } <- no slug because, no slug provider "name"

Any idea on how to acheive this ? Thanks !

[jhuet]

Hi @RickvdStaaij, any thought on the question in my last comment ? Thanks !

[localheinz]

@jhuet

Should this be string instead of type?

[rick-nu]

@jhuet Sorry, I haven't had the time yet to check this out, but it's on the top of my todo list now, so I hope to get back to you soon. One thing that comes to mind, have you checkend https://github.com/particle-php/Filter/blob/master/src/Chain.php#L42? If you state that a rule is not empty, it shouldn't be ignored and turn up with the given value.

[rick-nu]

Sorry it took me so long @jhuet, but I have (finally) looked into it in https://github.com/jhuet/Filter/pull/1. I introduced an isEmpty property on the Rule, which can be set to true. This way the value will be ignored when put out of the filter.

I hope this is what you were looking for. If not let me know :)

[jhuet]

No problem @RickvdStaaij, i'm glad to add new functionnalities to this library and see you're still around to help if needed :) Thanks !

[localheinz]

@jhuet

How about introducing an explaining variable here to improve clarity?

$data = [            
    'test' => 'test',
];

$this->assertSame($data, $this->filter->filter($data));

[jhuet]

Alright, you got it, i'm in a good mood today :)

[rick-nu]

Very nice @jhuet, thanks a lot! I'll merge and release a new version :) 👍

[rick-nu]

https://github.com/particle-php/Filter/releases/tag/v1.4.0