TextLookup Class Reference

Inherits DataItem.

Public Member Functions
	Translations ($constraint="")
	getTranslationOptions ()
	Given a text record, find the remaining languages for which this text has NOT yet been translated. More...

Static Public Member Functions
static	getText ($code, $obj=null, $blank=false)
	Retrieves text for display on a page, given the code. More...
static	getValue ($code, $obj=null, $blank=false)
static	getPlainText ($code, $obj=null, $blank=false)
	Retrieve the plain text value of the text field, with any HTML and leading or trailing whitespace removed. More...
static	setDefaultValue ($code, $value, $class_name="")
	Called from a component manager fired event setDefaults to set the default value for a text lookup code. More...
static	setValue ($code, $value, $class_name="")
	Set the string (or html) value of a lookup text code. More...

Public Attributes
	$primary_key = "text_id"
	$table = "text_lookup"
	$fields
	$versioned_fields = array("code", "text", "editable", "enabled")
	$relations

Detailed Description

Definition at line 41 of file text_lookup.inc.

Member Function Documentation

getPlainText()

static TextLookup::getPlainText (   $code,   $obj = null,   $blank = false  )

static

Retrieve the plain text value of the text field, with any HTML and leading or trailing whitespace removed.

Parameters

string	$code	the lookup code for the text item
DataItem	$obj	optional DataItem object to use as a merge code value source
boolean	$blank	true to return an empty string when blank, false to return the item's code

Definition at line 146 of file text_lookup.inc.

     {
          return trim(stripHTML(TextLookup::getText($code, $obj, $blank)));
     }    

getText()

static TextLookup::getText (   $code,   $obj = null,   $blank = false  )

static

Retrieves text for display on a page, given the code.

If an object is passed, then attempt to retrieve any merge codes values for codes used in the text that have been saved to merge_code table under the same class name as the $obj.

Parameters

string	$code	the value of the code field of the text object
DataItem	$obj	a data item instance that can retrieve values for merge codes used in the block of text (the text field value of table text_lookup.
	$blank	whether blank is ok; if ok, then return blank when no match found; if not, return the text string to signal to the developer the value is missing from the db.

Definition at line 85 of file text_lookup.inc.

     {
          $texts = Query::create(TextLookup, "WHERE code=:c AND enabled=1")
               ->bind(":c", $code)
               ->execute();
               
          if(count($texts) > 0)
          {
               $text = $texts[0];
               
               VersionedContentManager::selectDisplayVersion($text);
               
               $text = TextTranslation::getTranslation($text);
               if(isset($obj))
               {
                    $text = $obj->format($text->text);
                    $mgr = new MergeCodeManager($obj, $text);
                    $out = $mgr->searchAndReplace($text);
                    
               }
               else
               {
                    $out = $text->text;
               }
               
               if ($text->editable && Settings::getValue("settings", "enable_inline_editing") && Settings::checkPermission("settings", "editor_roles"))
               {
                    $versioningControls = ComponentManager::fireEvent("RenderVersioningControls", $text);
                    //$versioningEnabled = Settings::getValue("settings", "enable_content_versioning") ? "1" : "0";
                    
                    $out .= $text->format("<p id='inline_editing_{code}' class='inline_editor_toolbar'>".
                              "<a href='#' class='edit' onclick='TextLookupManager.editText({text_id}); return false;'>Edit</a>".
                              "{$versioningControls}</p>");
                    //AJG - must wrap text output if inline editing is enabled
                    $out = "<div>{$out}</div>";
               }
               
               return $out;
          }
          else if($blank = false) // return the code to signal that no value was found.
          {
               return $code;
          }
          else
          {
               return "";
          }
     }

getTranslationOptions()

TextLookup::getTranslationOptions

(

)

Given a text record, find the remaining languages for which this text has NOT yet been translated.

Definition at line 155 of file text_lookup.inc.

     {
          $translations = $this->Translations();
          if(count($translations) > 0)
               $indexed = regroupList($translations, "language");
          else
               $index = array();
               
          $options = array();
          foreach(TextTranslation::$languageOptions as $language)
          {
               if($language != "English" && !array_key_exists($language, $indexed))
                    $options[$language] = $language;
          }
               
          return $options;
     }

getValue()

static TextLookup::getValue (   $code,   $obj = null,   $blank = false  )

static

Definition at line 134 of file text_lookup.inc.

     {
          return TextLookup::getText($code, $obj, $blank);
     }

setDefaultValue()

static TextLookup::setDefaultValue (   $code,   $value,   $class_name = ""  )

static

Called from a component manager fired event setDefaults to set the default value for a text lookup code.

If the value has already been set, then return.

Parameters

string	$code
string	$value
string	$class_name

Definition at line 182 of file text_lookup.inc.

     {
          $texts = Query::create(TextLookup, "WHERE code=:c")
               ->bind(":c", $code)
               ->execute();
          
          if(count($texts)) return;
          
          TextLookup::setValue($code, $value, $class_name);
     }

setValue()

static TextLookup::setValue (   $code,   $value,   $class_name = ""  )

static

Set the string (or html) value of a lookup text code.

Parameters

string	$code
string	$value
string	$class_name

Definition at line 200 of file text_lookup.inc.

     {
          $text = new TextLookup();
          $text->code = $code;
          $text->text = $value;
          $text->class_name = $class_name;
          $text->save();
     }

Translations()

TextLookup::Translations

(

$constraint = ""

)

Definition at line 63 of file text_lookup.inc.

     {
          return $this->getRelatedList(TextTranslation, "", $constraint);
     }

Member Data Documentation

$fields

TextLookup::$fields

Initial value:

= array(
               "text_id" =>   Number,
               "code"         =>   String,
               "text"         =>   HTML, 
               "editable"     =>   Boolean,
               "category"     =>   String,
               "class_name"   =>   String,
               "enabled" =>   Boolean
     )

Definition at line 46 of file text_lookup.inc.

$primary_key

TextLookup::$primary_key = "text_id"

Definition at line 43 of file text_lookup.inc.

$relations

TextLookup::$relations

Initial value:

= array(
               "Translations" =>   TextTranslation     
     )

Definition at line 58 of file text_lookup.inc.

$table

TextLookup::$table = "text_lookup"

Definition at line 44 of file text_lookup.inc.

$versioned_fields

TextLookup::$versioned_fields = array("code", "text", "editable", "enabled")

Definition at line 56 of file text_lookup.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/text_lookup/datamodel/text_lookup.inc