/**
* Returns the wikitext for a table row describing a single parameter.
*
* @since 1.0
*
* @param Parameter $parameter
*
* @return string
*/
protected function getDescriptionRow(Parameter $parameter)
{
$description = $parameter->getMessage();
if ($description === false) {
$description = $parameter->getDescription();
if ($description === false) {
$description = '-';
}
} else {
$description = $this->msg($description);
}
$type = $parameter->getTypeMessage();
$default = $parameter->isRequired() ? "''" . $this->msg('validator-describe-required') . "''" : $parameter->getDefault();
if (is_array($default)) {
$default = implode(', ', $default);
} elseif (is_bool($default)) {
$default = $default ? 'yes' : 'no';
}
if ($default === '') {
$default = "''" . $this->msg('validator-describe-empty') . "''";
}
return <<<EOT
| {$parameter->getName()}
| {$type}
| {$default}
| {$description}
EOT;
}
/**
* @deprecated Compatibility helper, will be removed in 0.7.
* @since 0.5
*
* @param Parameter $parameter
*
* @return IParamDefinition
*/
public static function newFromParameter(Parameter $parameter)
{
$def = self::newFromType($parameter->getType(), $parameter->getName(), $parameter->getDefault(), $parameter->getMessage() === false ? 'validator-message-nodesc' : $parameter->getMessage(), $parameter->isList());
$def->addAliases($parameter->getAliases());
$def->addCriteria($parameter->getCriteria());
$def->addManipulations($parameter->getManipulations());
$def->addDependencies($parameter->getDependencies());
$def->setDoManipulationOfDefault($parameter->applyManipulationsToDefault);
if ($parameter->isList()) {
$def->setDelimiter($parameter->getDelimiter());
}
$def->trimValue = $parameter->trimValue;
return $def;
}
/**
* Returns the wikitext for a table row describing a single parameter.
*
* @since 1.6
*
* @param Parameter $parameter
* @param boolean $hasAliases
*
* @return string
*/
protected function getDescriptionRow(Parameter $parameter, $hasAliases)
{
if ($hasAliases) {
$aliases = $parameter->getAliases();
$aliases = count($aliases) > 0 ? implode(', ', $aliases) : '-';
}
$description = $parameter->getMessage();
if ($description === false) {
$description = $parameter->getDescription();
if ($description === false) {
$description = '-';
}
} else {
$description = $this->msg($description);
}
$type = $parameter->getTypeMessage();
$default = $parameter->isRequired() ? "''" . $this->msg('validator-describe-required') . "''" : $parameter->getDefault();
if (is_array($default)) {
$default = implode(', ', $default);
} elseif (is_bool($default)) {
$default = $default ? 'yes' : 'no';
}
if ($default === '') {
$default = "''" . $this->msg('validator-describe-empty') . "''";
}
return "| {$parameter->getName()}\n" . ($hasAliases ? '| ' . $aliases . "\n" : '') . <<<EOT
| {$type}
| {$default}
| {$description}
EOT;
}
/**
* Returns the wikitext for a table row describing a single parameter.
*
* @since 0.4.3
*
* @param Parameter $parameter
* @param array $defaults
*
* @return string
*/
protected function getDescriptionRow(Parameter $parameter, array $defaults)
{
$aliases = $parameter->getAliases();
$aliases = count($aliases) > 0 ? implode(', ', $aliases) : '-';
$description = $parameter->getMessage();
if ($description === false) {
$description = $parameter->getDescription();
if ($description === false) {
$description = '-';
}
} else {
$description = $this->msg($description);
}
$type = $parameter->getTypeMessage();
$number = 0;
$isDefault = false;
foreach ($defaults as $default) {
$number++;
if ($default == $parameter->getName()) {
$isDefault = true;
break;
}
}
$default = $parameter->isRequired() ? "''" . $this->msg('validator-describe-required') . "''" : $parameter->getDefault();
if (is_array($default)) {
$default = implode(', ', $default);
} elseif (is_bool($default)) {
$default = $default ? 'yes' : 'no';
}
if ($default === '') {
$default = "''" . $this->msg('validator-describe-empty') . "''";
}
if (!$isDefault) {
$number = '-';
}
return <<<EOT
| {$number}
| {$parameter->getName()}
| {$aliases}
| {$type}
| {$default}
| {$description}
EOT;
}
