data/SugarBean.php

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

Constructor for the bean, it performs following tasks:

Handle the following when a SugarBean object is cloned

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

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.

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

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.

Returns the query used for the export functionality for a module. Override this method if you wish to have a custom query to pull this data together instead

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.

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.

Fill in fields where type = relate

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

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

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

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.

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

Returnss definition for the id field name.

Returns the implementing class' table name.

Returns the name of the audit table.

Returns the name of the custom table.

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

Returns an array of fields that are required for import

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

Returns an array of beans of related data.

Returns an array of fields that are of type link.

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

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

Determines which users receive a notification

Returns an array of fields that are of type relate.

Fetches data from all related tables.

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

Constructs a query to fetch data for supanels and list views

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

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

Returns true of false if the user_id passed is the owner

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

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

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

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

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

Loads all attributes of type link.

This function should be overridden in each module. It marks an item as deleted.

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

Restores data deleted by call to mark_deleted() function.

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.

This function processes the fields before save.

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

Processes fetched list view data

Processes the list query and return fetched row.

Prefixes column names with this bean's table name.

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'

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

Removes relationship metadata cache.

This method has been deprecated.

Function fetches a single row of data given the primary key value.

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

Returns parent record data for objects that store relationship information

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

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

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

Loads the definition of custom fields defined for the module.

returns this bean as an array

Tracks the viewing of a detail record.

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

Removes formatting from values posted from the user interface.