tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Changed comments in forms\ToggleField.php

Browse Source
This commit is contained in:
assertchris 2016-04-20 14:49:09 +12:00
parent 30894eb4cf
commit ec247cefd8
1 changed files with 36 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
forms/ToggleField.php
View File

@ -1,36 +1,45 @@
<?php <?php
/** /**
* ReadonlyField with added toggle-capabilities - will preview the first sentence of the contained text-value, * ReadonlyField with added toggle-capabilities - will preview the first sentence of the contained
* and show the full content by a javascript-switch. * text-value, and show the full content by a javascript-switch.
*
* Caution: Strips HTML-encoding for the preview.
* *
* @deprecated 3.1 Use custom javascript with a ReadonlyField. * @deprecated 3.1 Use custom javascript with a ReadonlyField.
* *
* Caution: Strips HTML-encoding for the preview.
* @package forms * @package forms
* @subpackage fields-dataless * @subpackage fields-dataless
*/ */
class ToggleField extends ReadonlyField { class ToggleField extends ReadonlyField {
/** /**
* @var $labelMore string Text shown as a link to see the full content of the field * Text shown as a link to see the full content of the field.
*
* @var string
*/ */
public $labelMore; public $labelMore;
/** /**
* @var $labelLess string Text shown as a link to see the partial view of the field content * Text shown as a link to see the partial view of the field content.
*
* @var string
*/ */
public $labelLess; public $labelLess;
/** /**
* Method to use when truncating this field's value (FirstSentence|FirstParagraph).
*
* @see Text * @see Text
* @var $truncateMethod string (FirstSentence|FirstParagraph) *
* @var string
*/ */
public $truncateMethod = 'FirstSentence'; public $truncateMethod = 'FirstSentence';
/** /**
* @var $truncateChars int Number of chars to preview (optional). * Number of characters to truncate this field's value to.
* Truncating will be applied with $truncateMethod by default. *
* @var null|int
*/ */
public $truncateChars; public $truncateChars;
@ -45,9 +54,11 @@ class ToggleField extends ReadonlyField {
public $startClosed; public $startClosed;
/** /**
* @param name The field name * @inheritdoc
* @param title The field title *
* @param value The current value * @param string $name
* @param string $title
* @param string $value
*/ */
public function __construct($name, $title = '', $value = '') { public function __construct($name, $title = '', $value = '') {
Deprecation::notice('4.0', 'Use custom javascript with a ReadOnlyField'); Deprecation::notice('4.0', 'Use custom javascript with a ReadOnlyField');
@ -60,6 +71,13 @@ class ToggleField extends ReadonlyField {
parent::__construct($name, $title, $value); parent::__construct($name, $title, $value);
} }
/**
* @inheritdoc
*
* @param array $properties
*
* @return string|HTMLText
*/
public function Field($properties = array()) { public function Field($properties = array()) {
Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js'); Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
Requirements::javascript(FRAMEWORK_DIR . '/javascript/ToggleField.js'); Requirements::javascript(FRAMEWORK_DIR . '/javascript/ToggleField.js');
@ -107,7 +125,7 @@ HTML;
/** /**
* Determines if the field should render open or closed by default. * Determines if the field should render open or closed by default.
* *
* @param boolean * @param bool $bool
*/ */
public function startClosed($bool) { public function startClosed($bool) {
if($bool) { if($bool) {
@ -117,6 +135,11 @@ HTML;
} }
} }
/**
* @inheritdoc
*
* @return string
*/
public function Type() { public function Type() {
return "toggleField"; return "toggleField";
} }