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.

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

Document simplified filters context. #1295

Merged
merged 1 commit into from Jul 22, 2016
Merged

Document simplified filters context. #1295

merged 1 commit into from Jul 22, 2016

Conversation

ghost
Copy link

@ghost ghost commented Jul 16, 2016

**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

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

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.

@mariuswilms
Copy link
Member

The following code example block will also need a change:

// always use this
Filters::apply('lithium\storage\Session'

@mariuswilms
Copy link
Member

Great that you found out about using "::class" this is way shorter and sweeter.

@mariuswilms
Copy link
Member

Will merge this, okay?

@mariuswilms mariuswilms added this to the 1.1 milestone Jul 18, 2016
@mariuswilms mariuswilms self-assigned this Jul 18, 2016
@mariuswilms mariuswilms merged commit cf32a80 into UnionOfRAD:1.1 Jul 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant