modules/Groups/Group.php

Check whether the user has access to a particular view for the current bean/module

Constructor

Constructor for the bean, it performs following tasks:

Handle the following when a SugarBean object is cloned

This function helps generate the name and full_name member field variables from the salutation, title, first_name and last_name fields.

Returns the number of rows that the given SQL query should produce

Combined the contents of street field 2 thru 4 into the main field

Add any required joins to the list count query. The joins are required if there is a field in the $where clause that needs to be joined.

Called during the import process after a bean save, to handle any needed post-save logic when importing a record

Authenicates the user; returns true if successful

Called during the import process before a bean save, to handle any needed pre-save logic when importing a record

Override this function to build a where clause based on the search criteria set into bean .

Constructs an comma separated list of ids from passed query results.

This function is used to execute the query and create an array template objects from the resulting ids from the query.

Optionally copies values from fetched row into the bean.

This function is used to execute the query and create an array template objects from the resulting ids from the query.

Trigger custom logic for this module that is defined for the provided hook The custom logic file is located under custom/modules/[CURRENT_MODULE]/logic_hooks.php.

Verify that the current password is correct and write the new password to the DB.

Check that password matches existing hash

Check that md5-encoded password matches existing hash

This function retrieves a record of the appropriate type from the DB.

Check new password against rules set by admin

Cleans char, varchar, text, etc. fields of XSS type materials

Converts the field value based on the provided fieldDef

Convert row data from DB format to internal format Mostly useful for dates/times

Populates the relationship meta for a module.

If auditing is enabled, create the audit table.

This is a helper function that is used to quickly created indexes when creating tables.

Changes the select expression of the given query to be 'count(*)' so you can get the number of items the query will return. This is used to populate the upper limit on ListViews.

Return the list query used by the list views and export button. Next generation of create_new_list_query function.

This function handles create the email notifications email.

Ensure that fields within order by clauses are properly qualified with their tablename. This qualification is a requirement for sql server support.

This method has been deprecated.

Creates tables for the module implementing the class.

Decode and decrypt a base 64 encoded string with field type 'encrypt' in this bean using Blowfish.

Iterates through all the relationships and deletes all records for reach relationship.

generates Javascript to display I-E mail counts, both personal and group

Delete the primary table for the module implementing the class.

Encrpyt and base64 encode an 'encrypt' field type in the bean using Blowfish. The default system key is stored in cache/Blowfish/{keytype}

This is designed to be overridden and add specific fields to each record.

This is designed to be overridden and add specific fields to each record.

This is desgined to be overridden or called from extending bean. This method will fill in any parent_name fields.

Populate email address fields here instead of retrieve() so that they are properly available for logic hooks

Find user with matching password

Function corrects any bad formatting done by 3rd party/custom code

This functions adds formatting to all number fields before presenting them to user interface.

Converts an array into an acl mapping name value pairs into files

Method for password generation

Returns the ACL category for this module; defaults to the SugarBean::$acl_category if defined otherwise it is SugarBean::$module_dir

List the modules a user has admin access to

getAllUsers

Returns a list of fields with their definitions that have the audited property set to true.

convenience function to get user's default signature

List the modules a user has developer access to

getETagSeed

returns User's email address based on descending order of preferences

returns opening Inherited from: \User::getEmailLink()

returns opening Inherited from: \User::getEmailLink2()

Returns field definition for the requested field name.

Returns field definitions for the implementing module.

Returns the value for the requested field.

Returns index definitions for the implementing module.

Get WHERE clause that fetches all users counted for licensing purposes

gets a human-readable explanation of the format macro

Returns the object name. If object_name is not set, table_name is returned.

Get owner field

Gets there where statement for checking if a user is an owner

Generate a new hash from plaintext password

Interface for the User object to calling the UserPreference::setPreference() method in modules/UserPreferences/UserPreference.php

Returnss definition for the id field name.

retrieves the signatures for a user

returns buttons and JS for signatures

retrieves any signatures that the User may have created as

Inherited from: \User::getSignatures()

Parameters

Name	Type	Description
$live
$defaultSig
$forSettings

getSignaturesArray( ) : void

inherited

Inherited from: \User::getSignaturesArray()

getSystemDefaultNameAndEmail( ) : void

inherited

Inherited from: \User::getSystemDefaultNameAndEmail()

getSystemUser( ) : void

inherited

returns an admin user

Inherited from: \User::getSystemUser()

getTableName( ) : String

inherited

Returns the implementing class' table name.

Inherited from: \SugarBean::getTableName()\Basic::getTableName()\Person::getTableName()\User::getTableName()

All implementing classes set a value for the table_name variable. This value is returned as the table name. If not set, table name is extracted from the implementing module's vardef.

Returns

Type	Description
String	Table name. Internal function, do not override.

getUserDateTimePreferences( ) : array

inherited

Interface for the User object to calling the UserPreference::getUserDateTimePreferences() method in modules/UserPreferences/UserPreference.php

Inherited from: \User::getUserDateTimePreferences()

Returns

Type	Description
array	'date' - date format for user ; 'time' - time format for user

Details

See

\UserPreference::getUserDateTimePreferences()  

getUserPrivGuid( ) : void

inherited

Inherited from: \User::getUserPrivGuid()

getUsersNameAndEmail( ) : void

inherited

Inherited from: \User::getUsersNameAndEmail()

get_audit_table_name( ) : String

inherited

Returns the name of the audit table.

Inherited from: \SugarBean::get_audit_table_name()\Basic::get_audit_table_name()\Person::get_audit_table_name()\User::get_audit_table_name()

Audit table's name is based on implementing class' table name.

Returns

Type	Description
String	Audit table name. Internal function, do not override.

get_calls( ) : void

inherited

Inherited from: \User::get_calls()

get_custom_table_name( ) : String

inherited

Returns the name of the custom table.

Inherited from: \SugarBean::get_custom_table_name()\Basic::get_custom_table_name()\Person::get_custom_table_name()\User::get_custom_table_name()

Custom table's name is based on implementing class' table name.

Returns

Type	Description
String	Custom table name. Internal function, do not override.

get_first_day_of_week( ) : int

inherited

Get user first day of week.

Inherited from: \User::get_first_day_of_week()

Returns

Type	Description
int	: 0 = Sunday, 1 = Monday, etc...

get_full_list( string $order_by = "", string $where = "",  $check_dates = false, int $show_deleted = 0 ) : void

inherited

Returns a full (ie non-paged) list of the current object type.

Inherited from: \SugarBean::get_full_list()\Basic::get_full_list()\Person::get_full_list()\User::get_full_list()

Parameters

Name	Type	Description
$order_by	string	the order by SQL parameter. defaults to ""
$where	string	where clause. defaults to ""
$check_dates
$show_deleted	int	show deleted records. defaults to 0

get_import_required_fields( ) : array

inherited

Returns an array of fields that are required for import

Inherited from: \SugarBean::get_import_required_fields()\Basic::get_import_required_fields()\Person::get_import_required_fields()\User::get_import_required_fields()

Returns

Type	Description
array

get_importable_fields( ) : array

inherited

Returns an array of fields that are able to be Imported into i.e. 'importable' not set to 'false'

Inherited from: \SugarBean::get_importable_fields()\Basic::get_importable_fields()\Person::get_importable_fields()\User::get_importable_fields()

Returns

Type	Description
array	List of fields. Internal function, do not override.

get_linked_beans( string $field_name,  $bean_name, array $sort_array = array(), int $begin_index = 0, int $end_index = -1, int $deleted = 0,  $optional_where = "" ) : void

inherited

Returns an array of beans of related data.

Inherited from: \SugarBean::get_linked_beans()\Basic::get_linked_beans()\Person::get_linked_beans()\User::get_linked_beans()

For instance, if an account is related to 10 contacts , this function will return an array of contacts beans (10) with each bean representing a contact record. Method will load the relationship if not done so already.

Parameters

Name	Type	Description
$field_name	string	relationship to be loaded.
$bean_name
$sort_array	array	optional, unused
$begin_index	int	Optional, default 0, unused.
$end_index	int	Optional, default -1
$deleted	int	Optional, Default 0, 0 adds deleted=0 filter, 1 adds deleted=1 filter.
$optional_where

get_linked_fields( ) : array

inherited

Returns an array of fields that are of type link.

Inherited from: \SugarBean::get_linked_fields()\Basic::get_linked_fields()\Person::get_linked_fields()\User::get_linked_fields()

Returns

Type	Description
array	List of fields. Internal function, do not override.

get_list_view_array( ) : void

inherited

Assigns all of the values into the template for the list view

Inherited from: \SugarBean::get_list_view_array()\Basic::get_list_view_array()\Person::get_list_view_array()\User::get_list_view_array()

get_list_view_data( ) : void

inherited

Override this function to set values in the array used to render list view data.

Inherited from: \User::get_list_view_data()

get_meetings( ) : void

inherited

Returns a list of the associated users Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..

Inherited from: \User::get_meetings()

All Rights Reserved.. Contributor(s): ______________________________________..

get_notification_recipients( ) : void

inherited

Determines which users receive a notification

Inherited from: \SugarBean::get_notification_recipients()\Basic::get_notification_recipients()\Person::get_notification_recipients()\User::get_notification_recipients()

get_related_fields( ) : array

inherited

Returns an array of fields that are of type relate.

Inherited from: \SugarBean::get_related_fields()\Basic::get_related_fields()\Person::get_related_fields()\User::get_related_fields()

Returns

Type	Description
array	List of fields. Internal function, do not override.

get_related_list( object $child_seed, string $related_field_name, string $order_by = "", string $where = "",  $row_offset = 0,  $limit = -1,  $max = -1,  $show_deleted = 0 ) : array

inherited

Fetches data from all related tables.

Inherited from: \SugarBean::get_related_list()\Basic::get_related_list()\Person::get_related_list()\User::get_related_list()

Parameters

Name	Type	Description
$child_seed	object
$related_field_name	string	relation to fetch data for
$order_by	string	Optional, default empty
$where	string	Optional, additional where clause
$row_offset
$limit
$max
$show_deleted

Returns

Type	Description
array	Fetched data. Internal function, do not override.

get_summary_text( ) : string

inherited

Returns the summary text that should show up in the recent history list for this object.

Inherited from: \User::get_summary_text()

Returns

Type	Description
string

get_union_related_list( \SugarBean $parentbean, string $order_by = "", string $sort_order = '', string $where = "",  $row_offset = 0,  $limit = -1,  $max = -1,  $show_deleted = 0,  $subpanel_def ) : void

inherited

Constructs a query to fetch data for supanels and list views

Inherited from: \SugarBean::get_union_related_list()\Basic::get_union_related_list()\Person::get_union_related_list()\User::get_union_related_list()

It constructs union queries for activities subpanel.

Parameters

Name	Type	Description
$parentbean	\SugarBean	constructing queries for link attributes in this bean
$order_by	string	Optional, order by clause
$sort_order	string	Optional, sort order
$where	string	Optional, additional where clause Internal Function, do not overide.
$row_offset
$limit
$max
$show_deleted
$subpanel_def

get_where( array $fields_array, boolean $deleted = true ) : string

inherited

Construct where clause from a list of name-value pairs.

Inherited from: \SugarBean::get_where()\Basic::get_where()\Person::get_where()\User::get_where()

Parameters

Name	Type	Description
$fields_array	array	Name/value pairs for column checks
$deleted	boolean	Optional, default true, if set to false deleted filter will not be added.

Returns

Type	Description
string	The WHERE clause

hasCustomFields( ) : void

inherited

Inherited from: \SugarBean::hasCustomFields()\Basic::hasCustomFields()\Person::hasCustomFields()\User::hasCustomFields()

hasPersonalEmail( ) : bool

inherited

performs a rudimentary check to verify if a given user has setup personal InboundEmail

Inherited from: \User::hasPersonalEmail()

Returns

Type	Description
bool

has_been_modified_since( \date $date, string $modified_user_id ) : void

inherited

Performs a check if the record has been modified since the specified date

Inherited from: \SugarBean::has_been_modified_since()\Basic::has_been_modified_since()\Person::has_been_modified_since()\User::has_been_modified_since()

Parameters

Name	Type	Description
$date	\date	Datetime for verification
$modified_user_id	string	User modified by

incrementETag( string $tag ) : \nothing

inherited

incrementETag

Inherited from: \User::incrementETag()

This function increments any ETag seed needed for a particular user's UI. For example, if the user changes their theme, the ETag seed for the main menu needs to be updated, so you call this function with the seed name to do so:

UserPreference::incrementETag("mainMenuETag");

Parameters

Name	Type	Description
$tag	string	ETag seed name.

Returns

Type	Description
\nothing

isAdmin( ) : bool

inherited

Is this user a system wide admin

Inherited from: \User::isAdmin()

Returns

Type	Description
bool

isAdminForModule(  $module ) : bool

inherited

Is this user an admin for the specified module

Inherited from: \User::isAdminForModule()

Parameters

Name	Type	Description
$module

Returns

Type	Description
bool

isDeveloperForAnyModule( ) : bool

inherited

Is this user a developer for any module

Inherited from: \User::isDeveloperForAnyModule()

Returns

Type	Description
bool

isDeveloperForModule(  $module ) : bool

inherited

Is this user a developer for the specified module

Inherited from: \User::isDeveloperForModule()

Parameters

Name	Type	Description
$module

Returns

Type	Description
bool

isOwner( \GUID $user_id ) : boolean

inherited

Returns true of false if the user_id passed is the owner

Inherited from: \SugarBean::isOwner()\Basic::isOwner()\Person::isOwner()\User::isOwner()

Parameters

Name	Type	Description
$user_id	\GUID

Returns

Type	Description
boolean

is_AuditEnabled( ) : boolean

inherited

Return true if auditing is enabled for this object You would set the audit flag in the implemting module's vardef file.

Inherited from: \SugarBean::is_AuditEnabled()\Basic::is_AuditEnabled()\Person::is_AuditEnabled()\User::is_AuditEnabled()

Returns

Type	Description
boolean	Internal function, do not override.

is_authenticated( ) : void

inherited

Inherited from: \User::is_authenticated()

list_view_parse_additional_sections(  $list_form,  $xTemplateSection ) : void

inherited

Let implementing classes to fill in row specific columns of a list view form

Inherited from: \User::list_view_parse_additional_sections()

Parameters

Name	Type	Description
$list_form
$xTemplateSection

listviewACLHelper( ) : ARRAY

inherited

Used in order to manage ListView links and if they should links or not based on the ACL permissions of the user

Inherited from: \SugarBean::listviewACLHelper()\Basic::listviewACLHelper()\Person::listviewACLHelper()\User::listviewACLHelper()

Returns

Type	Description
ARRAY	of STRINGS

loadFromRow( array $arr ) : \nothing

inherited

Loads a row of data into instance of a bean. The data is passed as an array to this function

Inherited from: \SugarBean::loadFromRow()\Basic::loadFromRow()\Person::loadFromRow()\User::loadFromRow()

Parameters

Name	Type	Description
$arr	array	row of data fetched from the database.

Returns

Type	Description
\nothing	Internal function do not override.

loadLayoutDefs( ) : void

inherited

Inherited from: \SugarBean::loadLayoutDefs()\Basic::loadLayoutDefs()\Person::loadLayoutDefs()\User::loadLayoutDefs()

loadPreferences( string $category = 'global' ) : bool

inherited

Interface for the User object to calling the UserPreference::loadPreferences() method in modules/UserPreferences/UserPreference.php

Inherited from: \User::loadPreferences()

Parameters

Name	Type	Description
$category	string	name of the category to retreive, defaults to global scope

Returns

Type	Description
bool	successful?

Details

See

\UserPreference::loadPreferences()  

load_relationship( string $rel_name ) : \nothing.

inherited

Loads the request relationship. This method should be called before performing any operations on the related data.

Inherited from: \SugarBean::load_relationship()\Basic::load_relationship()\Person::load_relationship()\User::load_relationship()

This method searches the vardef array for the requested attribute's definition. If the attribute is of the type link then it creates a similary named variable and loads the relationship definition.

Parameters

Name	Type	Description
$rel_name	string	relationship/attribute name.

Returns

Type	Description
\nothing.

load_relationships( ) : \Nothing

inherited

Loads all attributes of type link.

Inherited from: \SugarBean::load_relationships()\Basic::load_relationships()\Person::load_relationships()\User::load_relationships()

DO NOT CALL THIS FUNCTION IF YOU CAN AVOID IT. Please use load_relationship directly instead.

Method searches the implmenting module's vardef file for attributes of type link, and for each attribute create a similary named variable and load the relationship definition.

Returns

Type	Description
\Nothing	Internal function, do not override.

load_user( string $user_password, bool $password_encoded = false ) : \--

inherited

Load a user based on the user_name in $this

Inherited from: \User::load_user()

Parameters

Name	Type	Description
$user_password	string	Password
$password_encoded	bool	Is password md5-encoded or plain text?

Returns

Type	Description
\--	this if load was successul and null if load failed.

mark_deleted(  $id ) : void

overrides SugarBean method

If it is not overridden, then marking this type of item is not allowed

Parameters

Name	Type	Description
$id

mark_relationships_deleted( int $id ) : void

inherited

This function deletes relationships to this object. It should be overridden to handle the relationships of the specific object.

Inherited from: \SugarBean::mark_relationships_deleted()\Basic::mark_relationships_deleted()\Person::mark_relationships_deleted()\User::mark_relationships_deleted()

This function is called when the item itself is being deleted.

Parameters

Name	Type	Description
$id	int	id of the relationship to delete

mark_undeleted(  $id ) : void

inherited

Restores data deleted by call to mark_deleted() function.

Inherited from: \SugarBean::mark_undeleted()\Basic::mark_undeleted()\Person::mark_undeleted()\User::mark_undeleted()

Internal function, do not override.

Parameters

Name	Type	Description
$id

parseDateDefault( string $value, bool $time = false ) : string

inherited

Create date string from default value like '+1 month'

Inherited from: \SugarBean::parseDateDefault()\Basic::parseDateDefault()\Person::parseDateDefault()\User::parseDateDefault()

Parameters

Name	Type	Description
$value	string
$time	bool	Should be expect time set too?

Returns

Type	Description
string

parse_additional_headers(  $list_form,  $xTemplateSection ) : void

inherited

Inherited from: \SugarBean::parse_additional_headers()\Basic::parse_additional_headers()\Person::parse_additional_headers()\User::parse_additional_headers()

Parameters

Name	Type	Description
$list_form
$xTemplateSection

populateDefaultValues(  $force = false ) : void

inherited

Inherited from: \SugarBean::populateDefaultValues()\Basic::populateDefaultValues()\Person::populateDefaultValues()\User::populateDefaultValues()

Parameters

Name	Type	Description
$force

populateRelatedBean( \SugarBean $newbean ) : void

inherited

Called from ImportFieldSanitize::relate(), when creating a new bean in a related module. Will copies fields over from the current bean into the related. Designed to be overriden in child classes.

Inherited from: \Person::populateRelatedBean()\User::populateRelatedBean()

Parameters

Name	Type	Description
$newbean	\SugarBean	newly created related bean

Details

See

\SugarBean::populateRelatedBean()  

preprocess_fields_on_save( ) : void

inherited

This function processes the fields before save.

Inherited from: \SugarBean::preprocess_fields_on_save()\Basic::preprocess_fields_on_save()\Person::preprocess_fields_on_save()\User::preprocess_fields_on_save()

Interal function, do not override.

process_detail_query( string $query, int $row_offset, int $limit = -1, int $max_per_page = -1, string $where = '', int $offset = 0 ) : array

inherited

Applies pagination window to select queries used by detail view, executes the query and returns fetched data.

Inherited from: \SugarBean::process_detail_query()\Basic::process_detail_query()\Person::process_detail_query()\User::process_detail_query()

Internal function, do not override.

Parameters

Name	Type	Description
$query	string	query to be processed.
$row_offset	int
$limit	int	optional, default -1
$max_per_page	int	Optional, default -1
$where	string	Custom where clause.
$offset	int	Optional, default 0

Returns

Type	Description
array	Fetched data.

process_full_list_query( string $query, boolean $check_date = false ) : array

inherited

Processes fetched list view data

Inherited from: \SugarBean::process_full_list_query()\Basic::process_full_list_query()\Person::process_full_list_query()\User::process_full_list_query()

Internal function, do not override.

Parameters

Name	Type	Description
$query	string	query to be processed.
$check_date	boolean	Optional, default false. if set to true date time values are processed.

Returns

Type	Description
array	Fetched data.

process_list_query( string $query, int $row_offset, int $limit = -1, int $max_per_page = -1, string $where = '' ) : array

inherited

Processes the list query and return fetched row.

Inherited from: \SugarBean::process_list_query()\Basic::process_list_query()\Person::process_list_query()\User::process_list_query()

Internal function, do not override.

Parameters

Name	Type	Description
$query	string	select query to be processed.
$row_offset	int	starting position
$limit	int	Optioanl, default -1
$max_per_page	int	Optional, default -1
$where	string	Optional, additional filter criteria.

Returns

Type	Description
array	Fetched data

process_order_by( string $order_by, \SugarBean $submodule = null ) : string

inherited

Prefixes column names with this bean's table name.

Inherited from: \SugarBean::process_order_by()\Basic::process_order_by()\Person::process_order_by()\User::process_order_by()

Parameters

Name	Type	Description
$order_by	string	Order by clause to be processed
$submodule	\SugarBean	name of the module this order by clause is for

Returns

Type	Description
string	Processed order by clause Internal function, do not override.

process_special_fields( ) : void

inherited

This method is called during an import before inserting a bean Define an associative array called $special_fields the keys are user defined, and don't directly map to the bean's fields the value is the method name within that bean that will do extra processing for that field. example: 'full_name'=>'get_names_from_full_name'

Inherited from: \SugarBean::process_special_fields()\Basic::process_special_fields()\Person::process_special_fields()\User::process_special_fields()

process_union_list_query( object $parent_bean, string $query, int $row_offset, int $limit = -1, int $max_per_page = -1, string $where = '', array $subpanel_def, string $query_row_count = '',  $secondary_queries = array() ) : array

inherited

Applies pagination window to union queries used by list view and subpanels, executes the query and returns fetched data.

Inherited from: \SugarBean::process_union_list_query()\Basic::process_union_list_query()\Person::process_union_list_query()\User::process_union_list_query()

Internal function, do not override.

Parameters

Name	Type	Description
$parent_bean	object
$query	string	query to be processed.
$row_offset	int
$limit	int	optional, default -1
$max_per_page	int	Optional, default -1
$where	string	Custom where clause.
$subpanel_def	array	definition of sub-panel to be processed
$query_row_count	string
$secondary_queries

Returns

Type	Description
array	Fetched data.

reloadPreferences( string $category = 'global' ) : bool

inherited

Unconditionally reloads user preferences from the DB and updates the session

Inherited from: \User::reloadPreferences()

Parameters

Name	Type	Description
$category	string	name of the category to retreive, defaults to global scope

Returns

Type	Description
bool	successful?

removeRelationshipMeta( string $key, string $db, string $tablename, string $dictionary, string $module_dir ) : \Nothing

inherited

Removes relationship metadata cache.

Inherited from: \SugarBean::removeRelationshipMeta()\Basic::removeRelationshipMeta()\Person::removeRelationshipMeta()\User::removeRelationshipMeta()

Every module that has relationships defined with other modules, has this meta data cached. The cache is stores in 2 locations: relationships table and file system. This method clears the cache from both locations.

Parameters

Name	Type	Description
$key	string	module whose meta cache is to be cleared.
$db	string	database handle.
$tablename	string	table name
$dictionary	string	vardef for the module
$module_dir	string	name of subdirectory where module is installed.

Returns

Type	Description
\Nothing

Details

Static

Internal function, do not override.  

remove_relationship_meta(  $key,  $db,  $log,  $tablename,  $dictionary,  $module_dir ) : void

inherited

This method has been deprecated.

Inherited from: \SugarBean::remove_relationship_meta()\Basic::remove_relationship_meta()\Person::remove_relationship_meta()\User::remove_relationship_meta()

Parameters

Name	Type	Description
$key
$db
$log
$tablename
$dictionary
$module_dir

Details

See

\removeRelationshipMeta()  

Static

 

resetPreferences( string $category = null ) : void

inherited

Interface for the User object to calling the UserPreference::resetPreferences() method in modules/UserPreferences/UserPreference.php

Inherited from: \User::resetPreferences()

Parameters

Name	Type	Description
$category	string	category to reset

Details

See

\UserPreference::resetPreferences()  

retrieve( string $id, bool $encode = true,  $deleted = true ) : objectnull

inherited

retrieves an User bean preformat name & full_name attribute with first/last loads User's preferences

Inherited from: \User::retrieve()

The fetched data is then set into the bean. The function also processes the fetched data by formattig date/time and numeric values.

Parameters

Name	Type	Description
$id	string	id ID of the User
$encode	bool	encode encode the result
$deleted

Returns

Type	Description
objectnull	User beannull if no User found

retrieve_by_email_address(  $email ) : void

inherited

Inherited from: \User::retrieve_by_email_address()

Parameters

Name	Type	Description
$email

retrieve_by_string_fields( array $fields_array, boolean $encode = true, boolean $deleted = true ) : object

inherited

Constructs a select query and fetch 1 row using this query, and then process the row

Inherited from: \SugarBean::retrieve_by_string_fields()\Basic::retrieve_by_string_fields()\Person::retrieve_by_string_fields()\User::retrieve_by_string_fields()

Internal function, do not override.

Parameters

Name	Type	Description
$fields_array	array	@fields_array array of name value pairs used to construct query.
$encode	boolean	Optional, default true, encode fetched data.
$deleted	boolean	Optional, default true, if set to false deleted filter will not be added.

Returns

Type	Description
object	Instance of this bean with fetched data.

retrieve_parent_fields( array $type_info ) : void

inherited

Returns parent record data for objects that store relationship information

Inherited from: \SugarBean::retrieve_parent_fields()\Basic::retrieve_parent_fields()\Person::retrieve_parent_fields()\User::retrieve_parent_fields()

Parameters

Name	Type	Description
$type_info	array	Interal function, do not override.

retrieve_relationships(  $table,  $values,  $select_id ) : void

inherited

Inherited from: \SugarBean::retrieve_relationships()\Basic::retrieve_relationships()\Person::retrieve_relationships()\User::retrieve_relationships()

Parameters

Name	Type	Description
$table
$values
$select_id

retrieve_user_id(  $user_name ) : void

inherited

Inherited from: \User::retrieve_user_id()

Parameters

Name	Type	Description
$user_name

save( boolean $check_notify = false ) : void

inherited

Implements a generic insert and update logic for any SugarBean This method only works for subclasses that implement the same variable names.

Inherited from: \User::save()

This method uses the presence of an id field that is not null to signify and update. The id field should not be set otherwise.

Parameters

Name	Type	Description
$check_notify	boolean	Optional, default false, if set to true assignee of the record is notified via email.

savePreferencesToDB( ) : void

inherited

Interface for the User object to calling the UserPreference::savePreferencesToDB() method in modules/UserPreferences/UserPreference.php

Inherited from: \User::savePreferencesToDB()

Details

See

\UserPreference::savePreferencesToDB()  

save_relationship_changes( \$is_update $is_update,  $exclude = array() ) : void

inherited

This function is a good location to save changes that have been made to a relationship.

Inherited from: \SugarBean::save_relationship_changes()\Basic::save_relationship_changes()\Person::save_relationship_changes()\User::save_relationship_changes()

This should be overriden in subclasses that have something to save.

Parameters

Name	Type	Description
$is_update	\$is_update	true if this save is an update.
$exclude

sendEmailForPassword( string $templateId, array $additionalData = array() ) : array

inherited

Send new password or link to user

Inherited from: \User::sendEmailForPassword()

Parameters

Name	Type	Description
$templateId	string	Id of email template
$additionalData	array	additional params: link, url, password

Returns

Type	Description
array	status: true|false, message: error message, if status = false and message = '' it means that send method has returned false

send_assignment_notifications( string $notify_user, string $admin ) : void

inherited

Handles sending out email notifications when items are first assigned to users

Inherited from: \SugarBean::send_assignment_notifications()\Basic::send_assignment_notifications()\Person::send_assignment_notifications()\User::send_assignment_notifications()

Parameters

Name	Type	Description
$notify_user	string	user to notify
$admin	string	the admin user that sends out the notification

setDefaultsInConfig( ) : void

inherited

sets User email default in config.php if not already set by install - i.

Inherited from: \User::setDefaultsInConfig()

e., upgrades

setNewPassword( string $new_password,  $system_generated = '0' ) : void

inherited

Sets new password and resets password expiration timers

Inherited from: \User::setNewPassword()

Parameters

Name	Type	Description
$new_password	string
$system_generated

setPreference( string $name, string $value, null $nosession = 0, string $category = 'global' ) : void

inherited

Interface for the User object to calling the UserPreference::setPreference() method in modules/UserPreferences/UserPreference.php

Inherited from: \User::setPreference()

Parameters

Name	Type	Description
$name	string	Name of the preference to set
$value	string	Value to set preference to
$nosession	null	For BC, ignored
$category	string	Name of the category to retrieve

Details

See

\UserPreference::setPreference()  

setUserPrivGuid( ) : void

inherited

Inherited from: \User::setUserPrivGuid()

set_relationship(  $table,  $relate_values,  $check_duplicates = true,  $do_update = false,  $data_values = null ) : void

inherited

Inherited from: \SugarBean::set_relationship()\Basic::set_relationship()\Person::set_relationship()\User::set_relationship()

Parameters

Name	Type	Description
$table
$relate_values
$check_duplicates
$do_update
$data_values

setupCustomFields( string $module_name, boolean $clean_load = true ) : void

inherited

Loads the definition of custom fields defined for the module.

Inherited from: \SugarBean::setupCustomFields()\Basic::setupCustomFields()\Person::setupCustomFields()\User::setupCustomFields()

Local file system cache is created as needed.

Parameters

Name	Type	Description
$module_name	string	setting up custom fields for this module.
$clean_load	boolean	Optional, default true, rebuilds the cache if set to true.

showLastNameFirst( ) : bool

inherited

Whether or not based on the user's locale if we should show the last name first.

Inherited from: \User::showLastNameFirst()

Returns

Type	Description
bool

toArray(  $dbOnly = false,  $stringOnly = false,  $upperKeys = false ) : array

inherited

returns this bean as an array

Inherited from: \SugarBean::toArray()\Basic::toArray()\Person::toArray()\User::toArray()

Parameters

Name	Type	Description
$dbOnly
$stringOnly
$upperKeys

Returns

Type	Description
array	of fields with id, name, access and category

track_view( string $user_id, string $current_module, string $current_view = '' ) : void

inherited

Tracks the viewing of a detail record.

Inherited from: \SugarBean::track_view()\Basic::track_view()\Person::track_view()\User::track_view()

This leverages get_summary_text() which is object specific.

Internal function, do not override.

Parameters

Name	Type	Description
$user_id	string	String value of the user that is viewing the record.
$current_module	string	String value of the module being processed.
$current_view	string	String value of the current view

unPopulateDefaultValues( ) : void

inherited

Basically undoes the effects of SugarBean::populateDefaultValues(); this method is best called right after object initialization.

Inherited from: \SugarBean::unPopulateDefaultValues()\Basic::unPopulateDefaultValues()\Person::unPopulateDefaultValues()\User::unPopulateDefaultValues()

unformat_all_fields( ) : void

inherited

Removes formatting from values posted from the user interface.

Inherited from: \SugarBean::unformat_all_fields()\Basic::unformat_all_fields()\Person::unformat_all_fields()\User::unformat_all_fields()

It only unformats numbers. Function relies on user/system prefernce for format strings.

Internal Function, do not override.

verify_data(  $ieVerified = true ) : \--

inherited

Inherited from: \User::verify_data()

Parameters

Name	Type	Description
$ieVerified

Returns

Type	Description
\--	returns a list of all users in the system. Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.. All Rights Reserved.. Contributor(s): ______________________________________..

Documentation was generated by DocBlox 0.18.1.