NAME

RT::User

SYNOPSIS

DESCRIPTION

METHODS

Create PARAMHASH

Create takes a hash of values and creates a row in the database:

  varchar(200) 'Name'.
  varchar(40) 'Password'.
  blob 'Comments'.
  blob 'Signature'.
  varchar(120) 'EmailAddress'.
  blob 'FreeformContactInfo'.
  varchar(200) 'Organization'.
  varchar(120) 'RealName'.
  varchar(16) 'NickName'.
  varchar(16) 'Lang'.
  varchar(16) 'EmailEncoding'.
  varchar(16) 'WebEncoding'.
  varchar(100) 'ExternalContactInfoId'.
  varchar(30) 'ContactInfoSystem'.
  varchar(100) 'ExternalAuthId'.
  varchar(30) 'AuthSystem'.
  varchar(16) 'Gecos'.
  varchar(30) 'HomePhone'.
  varchar(30) 'WorkPhone'.
  varchar(30) 'MobilePhone'.
  varchar(30) 'PagerPhone'.
  varchar(200) 'Address1'.
  varchar(200) 'Address2'.
  varchar(100) 'City'.
  varchar(100) 'State'.
  varchar(16) 'Zip'.
  varchar(50) 'Country'.
  varchar(50) 'Timezone'.
  text 'PGPKey'.
id

Returns the current value of id. (In the database, id is stored as int(11).)

Name
Returns the current value of Name. (In the database, Name is stored as varchar(200).)
SetName VALUE

Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(200).)

Password
Returns the current value of Password. (In the database, Password is stored as varchar(40).)
SetPassword VALUE

Set Password to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Password will be stored as a varchar(40).)

Comments
Returns the current value of Comments. (In the database, Comments is stored as blob.)
SetComments VALUE

Set Comments to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Comments will be stored as a blob.)

Signature
Returns the current value of Signature. (In the database, Signature is stored as blob.)
SetSignature VALUE

Set Signature to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Signature will be stored as a blob.)

EmailAddress
Returns the current value of EmailAddress. (In the database, EmailAddress is stored as varchar(120).)
SetEmailAddress VALUE

Set EmailAddress to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, EmailAddress will be stored as a varchar(120).)

FreeformContactInfo
Returns the current value of FreeformContactInfo. (In the database, FreeformContactInfo is stored as blob.)
SetFreeformContactInfo VALUE

Set FreeformContactInfo to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, FreeformContactInfo will be stored as a blob.)

Organization
Returns the current value of Organization. (In the database, Organization is stored as varchar(200).)
SetOrganization VALUE

Set Organization to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Organization will be stored as a varchar(200).)

RealName
Returns the current value of RealName. (In the database, RealName is stored as varchar(120).)
SetRealName VALUE

Set RealName to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, RealName will be stored as a varchar(120).)

NickName
Returns the current value of NickName. (In the database, NickName is stored as varchar(16).)
SetNickName VALUE

Set NickName to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, NickName will be stored as a varchar(16).)

Lang
Returns the current value of Lang. (In the database, Lang is stored as varchar(16).)
SetLang VALUE

Set Lang to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Lang will be stored as a varchar(16).)

EmailEncoding
Returns the current value of EmailEncoding. (In the database, EmailEncoding is stored as varchar(16).)
SetEmailEncoding VALUE

Set EmailEncoding to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, EmailEncoding will be stored as a varchar(16).)

WebEncoding
Returns the current value of WebEncoding. (In the database, WebEncoding is stored as varchar(16).)
SetWebEncoding VALUE

Set WebEncoding to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, WebEncoding will be stored as a varchar(16).)

ExternalContactInfoId
Returns the current value of ExternalContactInfoId. (In the database, ExternalContactInfoId is stored as varchar(100).)
SetExternalContactInfoId VALUE

Set ExternalContactInfoId to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ExternalContactInfoId will be stored as a varchar(100).)

ContactInfoSystem
Returns the current value of ContactInfoSystem. (In the database, ContactInfoSystem is stored as varchar(30).)
SetContactInfoSystem VALUE

Set ContactInfoSystem to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ContactInfoSystem will be stored as a varchar(30).)

ExternalAuthId
Returns the current value of ExternalAuthId. (In the database, ExternalAuthId is stored as varchar(100).)
SetExternalAuthId VALUE

Set ExternalAuthId to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ExternalAuthId will be stored as a varchar(100).)

AuthSystem
Returns the current value of AuthSystem. (In the database, AuthSystem is stored as varchar(30).)
SetAuthSystem VALUE

Set AuthSystem to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, AuthSystem will be stored as a varchar(30).)

Gecos
Returns the current value of Gecos. (In the database, Gecos is stored as varchar(16).)
SetGecos VALUE

Set Gecos to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Gecos will be stored as a varchar(16).)

HomePhone
Returns the current value of HomePhone. (In the database, HomePhone is stored as varchar(30).)
SetHomePhone VALUE

Set HomePhone to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, HomePhone will be stored as a varchar(30).)

WorkPhone
Returns the current value of WorkPhone. (In the database, WorkPhone is stored as varchar(30).)
SetWorkPhone VALUE

Set WorkPhone to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, WorkPhone will be stored as a varchar(30).)

MobilePhone
Returns the current value of MobilePhone. (In the database, MobilePhone is stored as varchar(30).)
SetMobilePhone VALUE

Set MobilePhone to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, MobilePhone will be stored as a varchar(30).)

PagerPhone
Returns the current value of PagerPhone. (In the database, PagerPhone is stored as varchar(30).)
SetPagerPhone VALUE

Set PagerPhone to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, PagerPhone will be stored as a varchar(30).)

Address1
Returns the current value of Address1. (In the database, Address1 is stored as varchar(200).)
SetAddress1 VALUE

Set Address1 to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Address1 will be stored as a varchar(200).)

Address2
Returns the current value of Address2. (In the database, Address2 is stored as varchar(200).)
SetAddress2 VALUE

Set Address2 to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Address2 will be stored as a varchar(200).)

City
Returns the current value of City. (In the database, City is stored as varchar(100).)
SetCity VALUE

Set City to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, City will be stored as a varchar(100).)

State
Returns the current value of State. (In the database, State is stored as varchar(100).)
SetState VALUE

Set State to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, State will be stored as a varchar(100).)

Zip
Returns the current value of Zip. (In the database, Zip is stored as varchar(16).)
SetZip VALUE

Set Zip to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Zip will be stored as a varchar(16).)

Country
Returns the current value of Country. (In the database, Country is stored as varchar(50).)
SetCountry VALUE

Set Country to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Country will be stored as a varchar(50).)

Timezone
Returns the current value of Timezone. (In the database, Timezone is stored as varchar(50).)
SetTimezone VALUE

Set Timezone to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Timezone will be stored as a varchar(50).)

PGPKey
Returns the current value of PGPKey. (In the database, PGPKey is stored as text.)
SetPGPKey VALUE

Set PGPKey to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, PGPKey will be stored as a text.)

Creator

Returns the current value of Creator. (In the database, Creator is stored as int(11).)

Created

Returns the current value of Created. (In the database, Created is stored as datetime.)

LastUpdatedBy

Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).)

LastUpdated

Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.)

SEE ALSO

This class allows "overlay" methods to be placed into the following files _Overlay is for a System overlay by the original author, _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.

These overlay files can contain new subs or subs to replace existing subs in this module.

If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line

   no warnings qw(redefine);

so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.

RT::User_Overlay, RT::User_Vendor, RT::User_Local