NameFinder Class Reference

Public Member Functions
	getFieldNameFromGetterName ($getterName)
	getFieldDescriptionFromGetterDescription ($shortDescription)
	getGetterMethodName (ClassReflection $class, $camelCaseProperty)
	getSetterMethodName (ClassReflection $class, $camelCaseProperty)
	findAccessorMethodName (ClassReflection $class, $camelCaseProperty, $accessorName, $boolAccessorName)
	hasMethod (ClassReflection $class, $methodName)

Detailed Description

Definition at line 11 of file NameFinder.php.

Member Function Documentation

findAccessorMethodName()

findAccessorMethodName	(	ClassReflection	$class,
			$camelCaseProperty,
			$accessorName,
			$boolAccessorName
	)

Find the accessor method name for a property from the given class

Parameters

ClassReflection	$class
string	$camelCaseProperty
string	$accessorName
bool	$boolAccessorName

Returns

string processed method name

Exceptions

Definition at line 87 of file NameFinder.php.

      {
        if ($this->hasMethod($class, $accessorName)) {
            $methodName = $accessorName;
            return $methodName;
        } elseif ($this->hasMethod($class, $boolAccessorName)) {
            $methodName = $boolAccessorName;
            return $methodName;
        } else {
            throw new \LogicException(
                sprintf(
                    'Property "%s" does not have accessor method "%s" in class "%s".',
                    $camelCaseProperty,
                    $accessorName,
                    $class->getName()
                )
            );
        }
    }

getFieldDescriptionFromGetterDescription()

getFieldDescriptionFromGetterDescription

(

$shortDescription

)

Convert Data Object getter short description into field description.

Parameters

string

$shortDescription

Returns

string

Definition at line 42 of file NameFinder.php.

    {
        return ucfirst(substr(strstr($shortDescription, " "), 1));
    }

getFieldNameFromGetterName()

getFieldNameFromGetterName

(

$getterName

)

Convert Data Object getter name into field name.

Parameters

string

$getterName

Returns

string

Remove 'get' prefix and make the first letter lower case

Remove 'is' prefix and make the first letter lower case

Remove 'has' prefix and make the first letter lower case

Definition at line 19 of file NameFinder.php.

    {
        if ((strpos($getterName, 'get') === 0)) {
            $fieldName = substr($getterName, strlen('get'));
        } elseif ((strpos($getterName, 'is') === 0)) {
            $fieldName = substr($getterName, strlen('is'));
        } elseif ((strpos($getterName, 'has') === 0)) {
            $fieldName = substr($getterName, strlen('has'));
        } else {
            $fieldName = $getterName;
        }
        return lcfirst($fieldName);
    }

getGetterMethodName()

getGetterMethodName	(	ClassReflection	$class,
			$camelCaseProperty
	)

Find the getter method name for a property from the given class

Parameters

ClassReflection	$class
string	$camelCaseProperty

Returns

string processed method name

Exceptions

Definition at line 55 of file NameFinder.php.

    {
        $getterName = 'get' . $camelCaseProperty;
        $boolGetterName = 'is' . $camelCaseProperty;
        return $this->findAccessorMethodName($class, $camelCaseProperty, $getterName, $boolGetterName);
    }

getSetterMethodName()

getSetterMethodName	(	ClassReflection	$class,
			$camelCaseProperty
	)

Find the setter method name for a property from the given class

Parameters

ClassReflection	$class
string	$camelCaseProperty

Returns

string processed method name

Exceptions

Definition at line 70 of file NameFinder.php.

    {
        $setterName = 'set' . $camelCaseProperty;
        $boolSetterName = 'setIs' . $camelCaseProperty;
        return $this->findAccessorMethodName($class, $camelCaseProperty, $setterName, $boolSetterName);
    }

hasMethod()

hasMethod	(	ClassReflection	$class,
			$methodName
	)

Checks if method is defined

Case sensitivity of the method is taken into account.

Parameters

ClassReflection	$class
string	$methodName

Returns

bool

Definition at line 120 of file NameFinder.php.

    {
        return $class->hasMethod($methodName) && ($class->getMethod($methodName)->getName() == $methodName);
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Reflection/NameFinder.php