Skip to content

allow-in-methods-with-attributes.md

Latest commit

 

History

History
59 lines (45 loc) · 2.25 KB

allow-in-methods-with-attributes.md

File metadata and controls

59 lines (45 loc) · 2.25 KB
Raw

Allow in methods or functions with given attributes

Similar to allowing items in methods or functions by name, you can allow or disallow items like functions and method calls, attributes, namespace and classname usage etc. in methods and functions with given attributes.

You can use allowInMethodsWithAttributes (or the allowInFunctionsWithAttributes alias) for that:

parameters:
    disallowedMethodCalls:
        -
            method: 'PotentiallyDangerous\Logger::log()'
            allowInMethodsWithAttributes:
                - MyAttribute

And vice versa, if you need to disallow an item in a method or a function with given attribute, use allowExceptInMethodsWithAttributes (with aliases allowExceptInFunctionsWithAttributes, disallowInMethodsWithAttributes, disallowInFunctionsWithAttributes):

parameters:
    disallowedMethodCalls:
        -
            method: 'Controller::redirect()'
            disallowInFunctionsWithAttributes:
                - YourAttribute

The attribute names support fnmatch() patterns. If you specify multiple attributes, the method or the function in which the item should be allowed or disallowed, needs to have just one of them.

allowInMethodsWithAttributes and allowInFunctionsWithAttributes are aliases for one list - when one config entry sets both keys, only allowInFunctionsWithAttributes is used, so put all the attributes in a list under one of the keys. The same applies to allowExceptInMethodsWithAttributes and its aliases.

Attributes on methods

In case of disallowing attributes and then re-allowing them in methods with attributes, the disallowed attributes can be both inside the method, and on the method. This means that the following code with the following configuration is also valid, even though Attribute1 is technically not used inside the method.

class Foo
{

    #[Attribute1]
    #[Attribute2]
    public function bar()
    {
    }

}
parameters:
    disallowedAttributes:
        -
            attribute: Attribute1
            allowInMethodsWithAttributes:
                - Attribute2

No error would be reported for Attribute1 as it is used "in" a method with Attribute2.