silverstripe-framework/src/ORM/FieldType/DBString.php

<?php

namespace SilverStripe\ORM\FieldType;

/**
 * An abstract base class for the string field types (i.e. Varchar and Text)
 */
abstract class DBString extends DBField {

	/**
	 * @var boolean
	 */
	protected $nullifyEmpty = true;

	/**
	 * @var array
	 */
	private static $casting = array(
		"LimitCharacters" => "Text",
		"LimitCharactersToClosestWord" => "Text",
		"LimitWordCount" => "Text",
		"LowerCase" => "Text",
		"UpperCase" => "Text",
		"Plain" => "Text",
	);

	/**
	 * Construct a string type field with a set of optional parameters.
	 *
	 * @param string $name string The name of the field
	 * @param array $options array An array of options e.g. array('nullifyEmpty'=>false).  See
	 *                       {@link StringField::setOptions()} for information on the available options
	 */
	public function __construct($name = null, $options = array()) {
		if($options) {
			if(!is_array($options)) {
				throw new \InvalidArgumentException("Invalid options $options");
			}
			$this->setOptions($options);
		}

		parent::__construct($name);
	}

	/**
	 * Update the optional parameters for this field.
	 *
	 * @param array $options Array of options
	 * The options allowed are:
	 *   <ul><li>"nullifyEmpty"
	 *       This is a boolean flag.
	 *       True (the default) means that empty strings are automatically converted to nulls to be stored in
	 *       the database. Set it to false to ensure that nulls and empty strings are kept intact in the database.
	 *   </li></ul>
	 * @return $this
	 */
	public function setOptions(array $options = array()) {
		if(array_key_exists("nullifyEmpty", $options)) {
			$this->nullifyEmpty = $options["nullifyEmpty"] ? true : false;
		}
		if(array_key_exists("default", $options)) {
			$this->setDefaultValue($options["default"]);
		}
		return $this;
	}

	/**
	 * Set whether this field stores empty strings rather than converting
	 * them to null.
	 *
	 * @param $value boolean True if empty strings are to be converted to null
	 */
	public function setNullifyEmpty($value) {
		$this->nullifyEmpty = ($value ? true : false);
	}

	/**
	 * Get whether this field stores empty strings rather than converting
	 * them to null
	 *
	 * @return boolean True if empty strings are to be converted to null
	 */
	public function getNullifyEmpty() {
		return $this->nullifyEmpty;
	}

	/**
	 * (non-PHPdoc)
	 * @see core/model/fieldtypes/DBField#exists()
	 */
	public function exists() {
		$value = $this->RAW();
		return $value // All truthy values exist
			|| (is_string($value) && strlen($value)) // non-empty strings exist ('0' but not (int)0)
			|| (!$this->getNullifyEmpty() && $value === ''); // Remove this stupid exemption in 4.0
	}

	public function prepValueForDB($value) {
		if(!$this->nullifyEmpty && $value === '') {
			return $value;
		} else {
			return parent::prepValueForDB($value);
		}
	}

	/**
	 * @return string
	 */
	public function forTemplate() {
		return nl2br(parent::forTemplate());
	}

	/**
	 * Limit this field's content by a number of characters.
	 * This makes use of strip_tags() to avoid malforming the
	 * HTML tags in the string of text.
	 *
	 * @param int $limit Number of characters to limit by
	 * @param string $add Ellipsis to add to the end of truncated string
	 * @return string
	 */
	public function LimitCharacters($limit = 20, $add = '...') {
		$value = $this->Plain();
		if(mb_strlen($value) <= $limit) {
			return $value;
		}
		return mb_substr($value, 0, $limit) . $add;
	}

	/**
	 * Limit this field's content by a number of characters and truncate
	 * the field to the closest complete word. All HTML tags are stripped
	 * from the field.
	 *
	 * @param int $limit Number of characters to limit by
	 * @param string $add Ellipsis to add to the end of truncated string
	 * @return string Plain text value with limited characters
	 */
	public function LimitCharactersToClosestWord($limit = 20, $add = '...') {
		// Safely convert to plain text
		$value = $this->Plain();

		// Determine if value exceeds limit before limiting characters
		if(mb_strlen($value) <= $limit) {
			return $value;
		}

		// Limit to character limit
		$value = mb_substr($value, 0, $limit);

		// If value exceeds limit, strip punctuation off the end to the last space and apply ellipsis
		$value = preg_replace(
			'/[^\w_]+$/',
			'',
			mb_substr($value, 0, mb_strrpos($value, " "))
		) . $add;
		return $value;
	}

	/**
	 * Limit this field's content by a number of words.
	 *
	 * @param int $numWords Number of words to limit by.
	 * @param string $add Ellipsis to add to the end of truncated string.
	 *
	 * @return string
	 */
	public function LimitWordCount($numWords = 26, $add = '...') {
		$value = $this->Plain();
		$words = explode(' ', $value);
		if(count($words) <= $numWords) {
			return $value;
		}

		// Limit
		$words = array_slice($words, 0, $numWords);
		return implode(' ', $words) . $add;
	}

	/**
	 * Converts the current value for this StringField to lowercase.
	 *
	 * @return string Text with lowercase (HTML for some subclasses)
	 */
	public function LowerCase() {
		return mb_strtolower($this->RAW());
	}

	/**
	 * Converts the current value for this StringField to uppercase.
	 *
	 * @return string Text with uppercase (HTML for some subclasses)
	 */
	public function UpperCase() {
		return mb_strtoupper($this->RAW());
	}

	/**
	 * Plain text version of this string
	 *
	 * @return string Plain text
	 */
	public function Plain() {
		return trim($this->RAW());
	}
}