DBFieldTextHtml Class Reference

A DB Text field holding HTML that automatically gets converted on storage. More...

Inheritance diagram for DBFieldTextHtml:

List of all members.

Public Member Functions
	__construct ($name, $length=self::BLOB_LENGTH_SMALL, $default_value=null, $policy=self::NONE)
	Constructor.
	validate ($value)
	Returns true, if the value passed fits the fields restrictions.
Protected Member Functions
	convert_value ($value)
	Apply storage conversion.
	do_format_not_null ($value)
	Format values that are not NULL.

---

Detailed Description

A DB Text field holding HTML that automatically gets converted on storage.

Definition at line 5 of file dbfield.text.html.cls.php.

---

Constructor & Destructor Documentation

DBFieldTextHtml::__construct	(	$	name,
		$	length = self::BLOB_LENGTH_SMALL,
		$	default_value = null,
		$	policy = self::NONE
	)

Constructor.

Since TEXT is more likely than varchar, default length is TEXT

Reimplemented from DBFieldText.

Definition at line 11 of file dbfield.text.html.cls.php.

                                                                                                                       {
                parent::__construct($name, $length, $default_value, $policy);
        }

---

Member Function Documentation

DBFieldTextHtml::convert_value

(

$

value

)

[protected]

Apply storage conversion.

Definition at line 61 of file dbfield.text.html.cls.php.

                                                 {
                return HtmlText::apply_conversion(HtmlText::STORAGE, $value, $this->get_table()->get_table_name());
        }

DBFieldTextHtml::do_format_not_null

(

$

value

)

[protected]

Format values that are not NULL.

Parameters:

mixed

$value

Returns:

string

Reimplemented from DBField.

Definition at line 52 of file dbfield.text.html.cls.php.

                                                      {
                return parent::do_format_not_null(
                        $this->convert_value($value)
                );
        }

DBFieldTextHtml::validate

(

$

value

)

Returns true, if the value passed fits the fields restrictions.

Parameters:

string

$value

Returns:

Status

Reimplemented from DBFieldText.

Definition at line 21 of file dbfield.text.html.cls.php.

                                         {
                $ret = new Status();
                if (!$this->is_null($value)) {
                        $value = $this->convert_value($value);
                }
                if ($value !== '') {
                        // This test for empty HTML, like <p><span></span></p>, which will not be allowed
                        // @TODO what about <img />?
                        $test = String::preg_replace('|\W|ms', '', strip_tags($value)); 
                        if ($test === '' && !$this->get_null_allowed()) {
                                $ret->append(tr(
                                        '%field may not be empty', 
                                        'core', 
                                        array(
                                                '%field' => $this->get_field_name_translation(),
                                        )
                                ));
                        }
                }
                if($ret->is_ok()) {
                        $ret->merge(parent::validate($value));
                }
                return $ret;
        }

---

The documentation for this class was generated from the following file:

• contributions/text.html/model/base/fields/dbfield.text.html.cls.php