1. class
  2. Neos
  3. \
  4. Flow
  5. \
  6. ObjectManagement
  7. \
  8. Proxy
  9. \
  10. ProxyMethod

ProxyMethod

class ProxyMethod (View source)

Representation of a method within a proxy class

Constants

BEFORE_PARENT_CALL

AFTER_PARENT_CALL

Properties

protected string $fullOriginalClassName

Fully qualified class name of the original class
protected string $methodName

Name of the original method
protected string $visibility

Visibility of the method
protected string $addedPreParentCallCode
protected string $addedPostParentCallCode
protected string $methodParametersCode
string $methodBody
protected ReflectionService $reflectionService

Methods

__construct(string $fullOriginalClassName, string $methodName)

Constructor

void
injectReflectionService(ReflectionService $reflectionService)

Injects the Reflection Service

void
overrideMethodVisibility(string $visibility)

Overrides the method's visibility

bool
isPrivate()

Returns TRUE if this proxy belongs to a private method, otherwise FALSE

void
addPreParentCallCode(string $code)

Adds PHP code to the body of this method which will be executed before a possible parent call.

void
addPostParentCallCode(string $code)

Adds PHP code to the body of this method which will be executed after a possible parent call.

void
setMethodParametersCode(string $code)

Sets the (exact) code which use used in as the parameters signature for this method.

string
render()

Renders the PHP code for this Proxy Method

bool
willBeRendered()

Tells if enough code was provided (yet) so that this method would actually be rendered if render() is called.

string
buildMethodDocumentation(string $className, string $methodName)

Builds the method documentation block for the specified method keeping the vital annotations

string
buildMethodParametersCode(string $fullClassName, string $methodName, bool $addTypeAndDefaultValue = true)

Builds the PHP code for the parameters of the specified method to be used in a method interceptor in the proxy class

string
buildCallParentMethodCode(string $fullClassName, string $methodName)

Builds PHP code which calls the original (ie. parent) method after the added code has been executed.

string
buildArraySetupCode(array $array)

Builds a string containing PHP code to build the array given as input.

string
getMethodVisibilityString()

Returns the method's visibility string found by the reflection service Note: If the reflection service has no information about this method, 'public' is returned.

void
setMethodBody(string $methodBody)

Override the method body

Details

at line 79
__construct(string $fullOriginalClassName, string $methodName)

Constructor

Parameters

string $fullOriginalClassName

The fully qualified class name of the original class
string $methodName

Name of the proxy (and original) method

at line 91
void injectReflectionService(ReflectionService $reflectionService)

Injects the Reflection Service

Parameters

ReflectionService $reflectionService

Return Value

void

at line 102
void overrideMethodVisibility(string $visibility)

Overrides the method's visibility

Parameters

string $visibility

One of 'public', 'protected', 'private'

Return Value

void

at line 112
bool isPrivate()

Returns TRUE if this proxy belongs to a private method, otherwise FALSE

Return Value

bool

at line 123
void addPreParentCallCode(string $code)

Adds PHP code to the body of this method which will be executed before a possible parent call.

Parameters

string $code

Return Value

void

at line 134
void addPostParentCallCode(string $code)

Adds PHP code to the body of this method which will be executed after a possible parent call.

Parameters

string $code

Return Value

void

at line 145
void setMethodParametersCode(string $code)

Sets the (exact) code which use used in as the parameters signature for this method.

Parameters

string $code

Parameters code, for example: '$foo, array $bar, \Foo\Bar\Baz $baz'

Return Value

void

at line 155
string render()

Renders the PHP code for this Proxy Method

Return Value

string

PHP code

at line 207
bool willBeRendered()

Tells if enough code was provided (yet) so that this method would actually be rendered if render() is called.

Return Value

bool

true if there is any code to render, otherwise false

at line 219
protected string buildMethodDocumentation(string $className, string $methodName)

Builds the method documentation block for the specified method keeping the vital annotations

Parameters

string $className

Name of the class the method is declared in
string $methodName

Name of the method to create the parameters code for

Return Value

string

$methodDocumentation DocComment for the given method

at line 256
string buildMethodParametersCode(string $fullClassName, string $methodName, bool $addTypeAndDefaultValue = true)

Builds the PHP code for the parameters of the specified method to be used in a method interceptor in the proxy class

Parameters

string $fullClassName

Name of the class the method is declared in
string $methodName

Name of the method to create the parameters code for
bool $addTypeAndDefaultValue

If the type and default value for each parameters should be rendered

Return Value

string

A comma speparated list of parameters

at line 323
protected string buildCallParentMethodCode(string $fullClassName, string $methodName)

Builds PHP code which calls the original (ie. parent) method after the added code has been executed.

Parameters

string $fullClassName

Fully qualified name of the original class
string $methodName

Name of the original method

Return Value

string

PHP code

at line 337
protected string buildArraySetupCode(array $array)

Builds a string containing PHP code to build the array given as input.

Parameters

array $array

Return Value

string

e.g. 'array()' or 'array(1 => 'bar')

at line 364
protected string getMethodVisibilityString()

Returns the method's visibility string found by the reflection service Note: If the reflection service has no information about this method, 'public' is returned.

Return Value

string

One of 'public', 'protected' or 'private'

at line 383
void setMethodBody(string $methodBody)

Override the method body

Parameters

string $methodBody

Return Value

void