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

Document simplified filters context. #1295

Merged
merged 1 commit into from Jul 22, 2016
Merged

Document simplified filters context. #1295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,16 @@
special methods or properties defined. This is possible by entirely relying on a central
filters manager and using `spl_object_hash()` internally.

**Simplified filters context.** By integrating PHP 5.5's new `::class` keyword with `use`,
references to the static context are now made with `Context::class`, removing the need
for a static `$self` and repeating the full class name across filters in the same file.

**Simplified filters signature.** By using PHP 5.4's new context binding feature for
closures, we were able to simplify the signature of filters - i.e. by dropping the
`$self`.

This - as a sideeffect - reduces the requirement of using `invokeMethod()` to access
protected members of the context. `$this` and `static` can be used to access
protected members of the context. `$this` and `Context::class` can be used to access
Copy link
Member

Choose a reason for hiding this comment

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

Lets keep mentioning static as both approaches work. Something along the lines of "... $this and static/Context::class can be used..."

Copy link
Author

@ghost ghost Jul 18, 2016 •
edited by ghost
Loading

Choose a reason for hiding this comment

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

static does not work out of the box, it isn't automagically bound to the context class, and defaults to lithium\core\Libraries so in 95% of cases it isn't usable: #1272

An exception is the last filter in the chain, which is inside the actual context class, but using static there and Context:class elsewhere can be confusing.

Context::class works consistently and it works everywhere; thoughts?

Copy link
Member

@mariuswilms mariuswilms Jul 18, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, static can only be used when the filter was created inside a static method, they cannot later be bound so they can use static:

class Bar {

    protected static $_foo = 'foo';

    public static function giveFilter() {
        return function() {
            var_dump(static::$_foo);
        };
    }
}

$this will only work if the filter was created inside a concrete method OR you later bound the closure to an object.

My point here is that filters should mostly not have the need to interact directly with methods inside the class. They should be self contained. Yes there are some exceptions for these, you're right, let's not recommend �static but Context::class�.

Thanks for bringing this up.

the filtered object. Also makes better stacktraces.

**Simplified chain advancing.**
Expand Down Expand Up @@ -266,7 +270,9 @@
]);

// always use this
Filters::apply('lithium\storage\Session', 'write', function($params, $next) {
use lithium\storage\Session;

Filters::apply(Session::class, 'write', function($params, $next) {
/* ... */
});
```
Expand Down
3 changes: 2 additions & 1 deletion aop/Filters.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@
* modified by any custom logic present before being returned from `run()`.
* ```
* use lithium\aop\Filters;
* use lithium\action\Dispatcher;
*
* Filters::apply('lithium\action\Dispatcher', 'run', function($params, $next) {
* Filters::apply(Dispatcher::class, 'run', function($params, $next) {
* // Custom pre-dispatch logic goes here.
* $response = $next($params);
*
Expand Down