Returns the variable's name.
public getVariableName ( ) : string | ||
return | string |
/** * Creates a new Descriptor from the given Reflector. * * @param ParamTag $data * * @return ParamDescriptor */ public function create($data) { $descriptor = new ParamDescriptor($data->getName()); $descriptor->setDescription($data->getDescription()); $descriptor->setVariableName($data->getVariableName()); $descriptor->setTypes($data->getTypes()); return $descriptor; }
/** * Creates a new Descriptor from the given Reflector. * * @param ParamTag $data * * @return ParamDescriptor */ public function create($data) { $descriptor = new ParamDescriptor($data->getName()); $descriptor->setDescription($data->getDescription()); $descriptor->setVariableName($data->getVariableName()); /** @var Collection $types */ $types = $this->builder->buildDescriptor(new Collection($data->getTypes())); $descriptor->setTypes($types); return $descriptor; }
/** * Validates whether the name of the argument is the same as that of the * param tag. * * If the param tag does not contain a name then this method will set it * based on the argument. * * @param \phpDocumentor\Reflection\DocBlock\Tag\ParamTag $param param to * validate with. * @param \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $argument Argument * to validate against. * * @return bool whether an issue occurred */ protected function doesArgumentNameMatchParam(\phpDocumentor\Reflection\DocBlock\Tag\ParamTag $param, \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $argument) { $param_name = $param->getVariableName(); if ($param_name == $argument->getName()) { return true; } if ($param_name == '') { $param->setVariableName($argument->getName()); return false; } $this->logParserError('ERROR', 50014, $this->lineNumber, array($argument->getName(), $param_name, $this->entityName . '()')); return false; }
/** * Validates whether the name of the argument is the same as that of the * param tag. * * If the param tag does not contain a name then this method will set it * based on the argument. * * @param ParamTag $param param to validate with. * @param ArgumentReflector $argument Argument to validate against. * * @return Error|null whether an issue occurred */ protected function doesArgumentNameMatchParam(ParamTag $param, ArgumentReflector $argument, $element) { $param_name = $param->getVariableName(); if ($param_name == $argument->getName()) { return null; } if ($param_name == '') { $param->setVariableName($argument->getName()); return null; } return new Error(LogLevel::ERROR, 'PPC:ERR-50014', $argument->getLinenumber(), array($argument->getName(), $param_name, $element->getName())); }
protected function makePropertyNameFromTag(ParamTag $paramTag) { $name = $paramTag->getVariableName(); return ltrim($name, '$'); }