Documentation

ClassNameInflectorInterface

Interface for a proxy- to user-class and user- to proxy-class name inflector

Table of Contents

Constants

PROXY_MARKER  = '__PM__'
Marker for proxy classes - classes containing this marker are considered proxies

Methods

getProxyClassName()  : string
Retrieve the class name of the proxy for the given user-defined class name
getUserClassName()  : string
Retrieve the class name of a user-defined class
isProxyClassName()  : bool
Retrieve whether the provided class name is a proxy

Constants

PROXY_MARKER

Marker for proxy classes - classes containing this marker are considered proxies

public mixed PROXY_MARKER = '__PM__'

Methods

getProxyClassName()

Retrieve the class name of the proxy for the given user-defined class name

public getProxyClassName(string $className[, array<string, mixed> $options = [] ]) : string
Parameters
$className : string
$options : array<string, mixed> = []

arbitrary options to be used for the generated class name

Tags
psalm-param

class-string<RealClassName>|class-string<ProxyInterface<RealClassName>> $className

psalm-return

class-string<RealClassName&ProxyInterface>

psalm-template

RealClassName of object

Return values
string

getUserClassName()

Retrieve the class name of a user-defined class

public getUserClassName(string $className) : string
Parameters
$className : string
Tags
psalm-param

class-string<RealClassName>|class-string<ProxyInterface<RealClassName>> $className

psalm-return

class-string<RealClassName>

psalm-template

RealClassName of object

Return values
string

isProxyClassName()

Retrieve whether the provided class name is a proxy

public isProxyClassName(string $className) : bool
Parameters
$className : string
Tags
psalm-param

class-string<RealClassName>|class-string<ProxyInterface<RealClassName>> $className

psalm-template

RealClassName of object

Return values
bool

        
On this page

Search results