Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

MINOR: add comments to FormField's RightTitle

  • Loading branch information...
commit 64c0d2fb0aad5d99bb0bfd6d82854fce0f1c03bc 1 parent 5462cda
@mateusz mateusz authored
Showing with 13 additions and 1 deletion.
  1. +13 −1 forms/FormField.php
View
14 forms/FormField.php
@@ -40,7 +40,8 @@ class FormField extends RequestHandler {
public $dontEscape;
/**
- * @var $rightTitle string Used in SmallFieldHolder() to force a right-aligned label.
+ * @var $rightTitle string Used in SmallFieldHolder to force a right-aligned label, or in FieldHolder
+ * to create contextual label.
*/
protected $rightTitle;
@@ -224,10 +225,21 @@ function setTitle($val) {
return $this;
}
+ /**
+ * Gets the contextual label than can be used for additional field description.
+ * Can be shown to the right or under the field in question.
+ *
+ * @return string Contextual label text.
+ */
function RightTitle() {
return $this->rightTitle;
}
+ /**
+ * Sets the contextual label.
+ *
+ * @param $val string Text to set on the label.
+ */
function setRightTitle($val) {
$this->rightTitle = $val;
return $this;
Please sign in to comment.
Something went wrong with that request. Please try again.