Selectors

Selectors are the way to tell PHPat which classes are going to intervene in a rule.

You can always use a regular expression, setting the regex parameter to true, to select everything that matches that expression.

---

Selector::all()

Selects all classes being parsed.

Selector::classname()

Selects classes with the given fully qualified name or regex.

Selector::classname('App\User\Domain\UserEntity')
Selector::classname(UserEntity::class)
Selector::classname('/.+Handler/', true)

The first two selectors will select the App\User\Domain\UserEntity class.

The third one will select all classes whose name ends in Handler.

Selector::namespace()

Selects classes in the given namespace.

Selector::namespace('App\User\Domain')
Selector::namespace('/^App\\\\.+\\\\Domain/', true)

The first selector will select all classes in the App\User\Domain namespace.

The second one will select all classes in a namespace matching the regular expression.

Selector::implements()

Select classes that implement a given interface.

Selector::extends()

Select classes that extend a given class.

Selector::interface()

Select all interfaces.

Selector::enum()

Select all enums.

Selector::abstract()

Select all abstract classes.

Selector::final()

Select all final classes.

Selector::readonly()

Select all readonly classes.

Selector::attribute()

Select all attribute classes.

---

Selector::AND()

Selects classes that match all the inner Selectors.

Example:

Selector::AND(
    Selector::namespace('App\User'),
    Selector::abstract()
)

This will select all abstract classes in the App\User namespace.

Selector::NOT()

Selects classes that do not match the inner Selector.

Selector::NOT(
    Selector::namespace('App\User')
)

This will select all classes that are not in the App\User namespace.