BMLT Root Server
Public Member Functions | Private Attributes | List of all members
t_comdef_local_type Class Reference

Allows us to specify a language to the instance (example: English or French) More...

Public Member Functions

 SetLocalLang ($in_lang_enum=null)
 Sets the language. More...
 
 GetLocalLang ()
 Returns a reference to the local language setting. More...
 
 SetLocalName ($in_name_string)
 Accessor -Sets the _local_type_name_string data member. More...
 
 GetLocalName ()
 Accessor -Returns a reference to the _local_type_name_string data member. More...
 
 SetLocalDescription ($in_description_string)
 Accessor -Sets the _local_type_desc_string data member. More...
 
 GetLocalDescription ()
 Accessor -Returns a reference to the _local_type_desc_string data member. More...
 
- Public Member Functions inherited from t_local_id_class
 SetParentObj ($in_parent_obj)
 Sets the object's "parent" (Container) object, as a reference. More...
 
 GetParentObj ()
 Returns a reference to the object's container. More...
 

Private Attributes

 $_local_type_lang_enum = null
 
 $_local_type_name_string = null
 
 $_local_type_desc_string = null
 

Detailed Description

Allows us to specify a language to the instance (example: English or French)

This class also allows us to specify a name for the instance, as a string, as well as a description.

Definition at line 232 of file base_templates.inc.php.

Member Function Documentation

GetLocalDescription ( )

Accessor -Returns a reference to the _local_type_desc_string data member.

Returns
A reference to the _local_type_desc_string data member.

Definition at line 319 of file base_templates.inc.php.

320  {
321  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
323  }
GetLocalLang ( )

Returns a reference to the local language setting.

Returns
A reference to the _local_type_lang_enum data member

Definition at line 271 of file base_templates.inc.php.

272  {
273  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
275  }
GetLocalName ( )

Accessor -Returns a reference to the _local_type_name_string data member.

Returns
A reference to the _local_type_name_string data member.

Definition at line 295 of file base_templates.inc.php.

296  {
297  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
299  }
SetLocalDescription (   $in_description_string)

Accessor -Sets the _local_type_desc_string data member.

Parameters
$in_description_stringThe description as a string up to 4000 characters long.

Definition at line 305 of file base_templates.inc.php.

307  {
308  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
309  $this->_local_type_desc_string = null;
310  $this->_local_type_desc_string = $in_description_string;
311  }
SetLocalLang (   $in_lang_enum = null)

Sets the language.

This is the server language.

Should never be necessary.

Definition at line 245 of file base_templates.inc.php.

References $comdef_global_language.

247  {
248  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
250 
251  /// This is the server language.
252  if (null == $in_lang_enum) {
253  $in_lang_enum = $comdef_global_language;
254  }
255 
256  /// Should never be necessary.
257  if (null == $in_lang_enum) {
258  $in_lang_enum = "en";
259  }
260 
261  $this->_local_type_lang_enum = null;
262  $this->_local_type_lang_enum = $in_lang_enum;
263  }
global $comdef_global_language
The local server language enum (Will default to English)
SetLocalName (   $in_name_string)

Accessor -Sets the _local_type_name_string data member.

Parameters
$in_name_stringThe name of this object, as a string.

Definition at line 281 of file base_templates.inc.php.

Referenced by NAWSImport\createServiceBodiesAndUsers().

283  {
284  // phpcs:enable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
285  $this->_local_type_name_string = null;
286  $this->_local_type_name_string = $in_name_string;
287  }

Member Data Documentation

$_local_type_desc_string = null
private

Definition at line 239 of file base_templates.inc.php.

$_local_type_lang_enum = null
private

Definition at line 237 of file base_templates.inc.php.

$_local_type_name_string = null
private

Definition at line 238 of file base_templates.inc.php.


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