Toggle menu
876
3.8K
30.2K
279.1K
Catglobe Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

User new: Difference between revisions

From Catglobe Wiki
Cg_pham (talk | contribs)
No edit summary
Cg_pham (talk | contribs)
No edit summary
Line 1: Line 1:
[[Category:User_Functions]]
{{HelpFiles}}  
{{HelpFiles}}


====User_new====
==== User_new ====


Create a new user object
Create a new user object  


'''Syntax'''
'''Syntax'''  


User_new(''username, password, userTemplateResourceId'')
User_new(''username, password, userTemplateResourceId'')  


'''Arguments'''
'''Arguments'''  


* ''username'': is a ''string ''expression. It is the user's username, it must follow the common format of usernames
*''username'': is a ''string ''expression. It is the user's username, it must follow the common format of usernames  
* ''password'': is a ''string ''expression. It is the user's password, it must follow the common format for passwords
*''password'': is a ''string ''expression. It is the user's password, it must follow the common format for passwords  
* ''userTemplateResourceId'': is a ''number ''expression. It is the user template's resource id
*''userTemplateResourceId'': is a ''number ''expression. It is the user template's resource id


'''Return value'''
'''Return value'''  


An ''array'', it is a user object which contains the following items
An ''array'', it is a user object which contains the following items  
[USER_PHONE_NUMBER] = {{PhoneNumber_Type_Home1, "0703822745", 84}, {PhoneNumber_Type_Mobile1, "0903353758", 84}};</nowiki>''
<table width="875" cellspacing="0" cellpadding="2" border="1" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic">
<tbody><tr valign="top" align="left">
<td width="292" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Index</strong></p>
</td>
<td width="116" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Data type</strong></p>
</td>
<td width="467" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Value</strong></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_RESOURCE_ID</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Resource id</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_NAME</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Username</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_TEMPLATE_RESOURCE_ID</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">User template's resource id</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_PASSWORD</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Password</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_TIME_REGISTRATION</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">If time registration is allowed</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_MAN_HOURS</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Number of budget hours</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_CALCULATED_MAN_HOURS</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">If number of budget hours is calculated on Team tab's settings</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_PHONE_NUMBER</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">array</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Phone number list</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_ACCESS_EXPIRATION</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">aray</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Expiration date</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_PROTECTED_UNTIL</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">array</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Protection deadline</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_LANGUAGE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Language's ISO code</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_CULTURE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Culture's ISO code</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_EMAIL</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Email address</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_FIRST_NAME</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">First name</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_MIDDLE_NAME</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Middle name</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_LAST_NAME</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Last name</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_CURRENCY</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Currency</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_DISCOUNT</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Discount</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_POINT_BALANCE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Point balance (read-only)</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_TIMEZONE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Timezone</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_ADDRESS</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Address</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_CITY</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">City</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_ZIPCODE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Zip code</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_REGION</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Region</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_COUNTRY</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Country's ISO code</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_POSTBOX</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Postbox</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_WEBSITE</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">Website</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_DELETED</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">If the user is deleted</span></p>
</td>
</tr>
<tr valign="top" align="left">
<td width="292" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">USER_DISABLED</span></p>
</td>
<td width="116" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
</td>
<td width="467" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">If the user is disabled</span></p>
</td>
</tr>


''user[USER_LANGUAGE] = "en-GB";''
</tbody></table>


''user[USER_TIMEZONE] = Timezone_SE_Asia_Standard_Time;''


User_save(user);
'''Availability'''


'''Availability'''
Version 5.6 __NOTOC__ 


Version 5.6
[[Category:User_Functions]]
__NOTOC__
<!-- imported from file: 6294.htm-->

Revision as of 05:02, 19 December 2011



User_new

Create a new user object

Syntax

User_new(username, password, userTemplateResourceId)

Arguments

  • username: is a string expression. It is the user's username, it must follow the common format of usernames
  • password: is a string expression. It is the user's password, it must follow the common format for passwords
  • userTemplateResourceId: is a number expression. It is the user template's resource id

Return value

An array, it is a user object which contains the following items

<tbody> </tbody>

Index

Data type

Value

USER_RESOURCE_ID

number

Resource id

USER_NAME

string

Username

USER_TEMPLATE_RESOURCE_ID

number

User template's resource id

USER_PASSWORD

string

Password

USER_TIME_REGISTRATION

bool

If time registration is allowed

USER_MAN_HOURS

number

Number of budget hours

USER_CALCULATED_MAN_HOURS

bool

If number of budget hours is calculated on Team tab's settings

USER_PHONE_NUMBER

array

Phone number list

USER_ACCESS_EXPIRATION

aray

Expiration date

USER_PROTECTED_UNTIL

array

Protection deadline

USER_LANGUAGE

string

Language's ISO code

USER_CULTURE

string

Culture's ISO code

USER_EMAIL

string

Email address

USER_FIRST_NAME

string

First name

USER_MIDDLE_NAME

string

Middle name

USER_LAST_NAME

string

Last name

USER_CURRENCY

string

Currency

USER_DISCOUNT

string

Discount

USER_POINT_BALANCE

number

Point balance (read-only)

USER_TIMEZONE

number

Timezone

USER_ADDRESS

string

Address

USER_CITY

string

City

USER_ZIPCODE

string

Zip code

USER_REGION

string

Region

USER_COUNTRY

string

Country's ISO code

USER_POSTBOX

string

Postbox

USER_WEBSITE

string

Website

USER_DELETED

bool

If the user is deleted

USER_DISABLED

bool

If the user is disabled


Availability

Version 5.6