Documentation

CrmManager extends CrmLibrary
in package

Admin Class CRM

Tags
category

CrmManager

subpackage

module_crm

author

SoftSolutions4U Development Team info@softsolutions4u.com

copyright

2012 and CLOUDREXX CMS - CLOUDREXX AG

license

trial license

link
www.cloudrexx.com

Table of Contents

Constants

SOCIAL_NETWORK_BLOGGER  = 8
SOCIAL_NETWORK_FACEBOOK  = 4
SOCIAL_NETWORK_GMAIL  = 7
SOCIAL_NETWORK_ICQ  = 11
SOCIAL_NETWORK_LINKEDIN  = 3
SOCIAL_NETWORK_LIVEJOURNAL  = 5
SOCIAL_NETWORK_MYSPACE  = 6
SOCIAL_NETWORK_NONE  = 0
SOCIAL_NETWORK_SKYPE  = 1
SOCIAL_NETWORK_TWITTER  = 2
SOCIAL_NETWORK_XING  = 15

Properties

$_arrLanguages  : array<string|int, mixed>
All Languages take it as array
$_arrSettings  : array<string|int, mixed>
Settings value stored in array
$_csvSeparator  : string
Csv seperator
$_memberShips  : array<string|int, mixed>
All Memberships take it as array
$_objTpl  : string
Template object
$_pageTitle  : string
Page title
$_statusMessage  : string
Status message
$_strErrMessage  : string
Status Error message
$_strOkMessage  : string
Status Ok message
$_strWarMessage  : string
Status Warning message
$act  : string
Function Action Name
$addressTypes  : array<string|int, mixed>
Address Types
$addressValues  : array<string|int, mixed>
Address Values
$adminAccessId  : int
Admin Access Id
$countries  : array<string|int, mixed>
All Countries name take it as array
$customerAccessId  : int
Customer Access Id
$customerTypes  : array<string|int, mixed>
All customer types take it as array
$emailOptions  : array<string|int, mixed>
Email Options
$moduleName  : string
Module Name
$moduleNameLC  : string
Module Name in lower case
$objJs  : js
class Javascript;
$phoneOptions  : array<string|int, mixed>
Phone Options
$supportCaseStatus  : array<string|int, mixed>
Support Case Status
$websiteOptions  : array<string|int, mixed>
Website Options
$websiteProfileOptions  : array<string|int, mixed>
Website Profile Options
$_mediaPath  : mixed
$contact  : mixed
$instance  : object
Class Object
$load  : object
object for loading class
$model_industry_types  : mixed
$settingsController  : mixed
$socialProfileOptions  : array<string|int, mixed>
Social Profile Options

Methods

__construct()  : mixed
PHP5 constructor
_escapeCsvValue()  : string
Escape a value that it could be inserted into a csv file.
_getDomainNameId()  : int
Get Domain name Id
_getResourceDropDown()  : null
Populates the Cloudrexx user Filter Drop Down
_initCrmModule()  : mixed
Registers all css and js to be loaded for crm module
_modifyContact()  : true
add or edit contact
_modifyDeal()  : true
add /edit of deals
_modifyIndustry()  : true
add/ edit industry
_modifyMembership()  : true
add/ edit membership
_modifyNotes()  : true
add/edit of notes page
_usortByMultipleKeys()  : int
Usort for multiple key values
activateCompanySize()  : null
Activate / Deactivate company size status
addContact()  : true
add new contact
addCrmContact()  : null
Adding Crm Contact
addCrmContactFromAccessUser()  : int
Create a CRM contact based on an object of \User
addUser()  : bool
Add User in the time of adding a customer based on the account settings
autoSuggest()  : json
Default Customer Suggetion box functionality
changeActive()  : true
change the status
changeCustomerContactStatus()  : true
change the customer contact status
changeCustomerStatus()  : true
change the customer status
checkAccountId()  : json
check the account id
checkCustomerIdentity()  : true
check the customer identity
countEntries()  : int
Counts all existing entries in the database.
countEntriesOfJoin()  : int
Counts all existing entries in the database.
countRecordEntries()  : int
get the count of entries
createLanguageArray()  : array<string|int, mixed>
Creates an array containing all frontend-languages. Example: $arrValue[$langId]['short'] or $arrValue[$langId]['long']
createThumbnailOfImage()  : string
Create thumbnail of image
currencyChangeStatus()  : true
change the currency status
customersChangeStatus()  : true
change the customer status
customerTooltipDetail()  : true
customer tool tip
customerTypeChangeStatus()  : true
change the customer type status
dealsOverview()  : true
Overview of opportunity
deleteCompanySize()  : null
Delete company size
deleteContactDocument()  : true
Delete the requested document
deleteCurrency()  : true
delete currency entry
deleteCustomerComment()  : true
Delete the Comment single
deleteCustomers()  : mixed
delete customer related details
deleteCustomerTypes()  : true
delete customer types
deleteDeal()  : null
Delete Deal record
deleteDeals()  : null
Delete Multiple Deals
deleteIndustryType()  : null
Delete Industry type
deleteMembership()  : null
delete Membership
deleteStage()  : null
Delete stage record
docUploadFinished()  : array<string|int, mixed>
the upload is finished rewrite the names write the uploaded files to the database
download()  : null
To download a file
editnotes()  : true
edit notes page
exportVcf()  : true
export the customer vcf
formattedWebsite()  : string
Formatting the website
getActiveEmailTemLangId()  : array<string|int, mixed>
get the available email template lang ids
getCompanySizeDropDown()  : null
Get Company Size Dropdown From DB
getCompanySizeNameById()  : string
Get company size name by id
getContactAddressCountry()  : mixed
Get the contact Address Country value From DB
getContactAddrTypeCountry()  : null
Get Contact Address Type Country value
getContactDeals()  : true
get contact deals
getContactDocuments()  : true
get contact documents
getContactFileNameById()  : file
return name of the file name
getContactsQuery()  : mixed
getContactTasks()  : true
get the task of a contact
getCountry()  : array<string|int, mixed>
Get Country value from DB
getCrmDatasource()  : string
Get Crm data Source
getCurrencyIdByContactId()  : int
Get ID of the currency assigned to a contact
getCustomerContacts()  : true
get the contacts of the given customer
getCustomerCurrencyDropDown()  : null
Get Customer's Currency Dropdown From DB
getCustomerDomains()  : json
get customers domain result
getCustomerId()  : true
get the logged customer id
getCustomers()  : json
get customer search results as json result
getCustomerSearch()  : json
get customer search result
getCustomerTypeDropDown()  : null
Get Customertype Dropdown From DB
getCustomerTypeNameById()  : string
Get customer type name by id
getCustomerTypes()  : int
Get Customer Types From DB
getDatasourceDropDown()  : null
Get Data source Dropdown
getDealsStages()  : null
Get Deals Stages
getDefaultCurrencyId()  : int
Get default currencyId
getEmail()  : string
Get username
getEmailTempLang()  : int
get the email template lang id for sending mail
getExistCrmDetail()  : array<string|int, mixed>
get exist crm account detail
getImportFilename()  : null
get the imported file name
getIndustryTypeDropDown()  : null
Get Industry Type Dropdown From DB
getIndustryTypeNameById()  : string
Get industry type name by id
getLinkContacts()  : true
get contacts to link the customer
getMembershipDropdown()  : null
Get Membership dropdown
getMemberships()  : array<string|int, mixed>
Get Membership details From DB
getModifyTaskTypes()  : null
Get Modify Task type values From DB
getOverviewMembershipDropdown()  : null
Get membership dropdown for overview page
getPage()  : null
Set the backend page
getPagingLimit()  : int
Returns the allowed maximum element per page. Can be used for paging.
getResources()  : bool
Get Resource data's
getSettings()  : array<string|int, mixed>
Get the Settings value from the DB
getUserIdByCrmUserId()  : int|null
Checks whether the crm customer is connected with a user account
getUserName()  : string
Get username
init()  : object
Initialize a class
initUploader()  : null
Inits the uploader when displaying a contact form.
listIndustryTypes()  : string
List the industry types
makeLinksInTheContent()  : string
Make the url string's into clickable link's.
notesChangeStatus()  : true
change the notes status
notesDetail()  : true
returns the notes details of the customer
notesOverview()  : true
notes overview page
notesUploadFinished()  : array<string|int, mixed>
the upload is finished rewrite the names write the uploaded files to the database
notifyStaffOnContactAccModification()  : null
notify the staffs regarding the account modification of a contact
parseContacts()  : array<string|int, mixed>
Parse the contacts
parseLetterIndexList()  : mixed
proPhotoUploadFinished()  : array<string|int, mixed>
the upload is finished rewrite the names write the uploaded files to the database
saveSortingCompanySize()  : null
Save the sorting
saveSortingIndustryType()  : null
Industry type sorting function
saveSortingMembership()  : null
Membership Sorting functionality
saveStage()  : true
save opportunity stages
saveStageSorting()  : null
save sorting stage
saveTaskTypes()  : null
Save Task Type values to DB
setContactPersonProfile()  : mixed
Adding Crm Contact and link it with crm company if possible
settingsSubmenu()  : mixed
get settings submenu
showCustomerDetail()  : true
Shows the Customer details page
showCustomers()  : true
Shows the Customer overview page
showIndustry()  : true
show settings industry
showInterface()  : true
show the interface
showMembership()  : true
show membership menu
showOpportunityStages()  : true
show opportunity stages
showTasks()  : true
get task overview page
showTaskTypes()  : null
Show all the Task Types
stripOnlyTags()  : string
strips only the given tags
submenu()  : true
get task submenu
taskTypeDropDown()  : null
Get Tasktype Dropdown
taskUploadFinished()  : array<string|int, mixed>
the upload is finished rewrite the names write the uploaded files to the database
toggleIndustryType()  : void
Industry type Change Status
toggleMembership()  : void
Change Membership Status
toggleStage()  : void
change stage status
unlinkContact()  : null
Unlink the contact
updateCustomerContacts()  : null
Update Customer Contacts
updateCustomerMemberships()  : null
Update Customer Memberships
uploadFinished()  : array<string|int, mixed>
the upload is finished rewrite the names write the uploaded files to the database
validateCustomer()  : bool
Validate the Customer
validation()  : true
validation for the notes
createThumbnailOfPicture()  : string
Create thumbnail of image
getTaskPermission()  : bool
Returns true or false for task edit and delete permission
getTemporaryUploadPath()  : array<string|int, mixed>
Gets the temporary upload location for files.
moveUploadedImageInToPlace()  : string
Move uploaded image into respective folder

Constants

Properties

$_arrLanguages

All Languages take it as array

public array<string|int, mixed> $_arrLanguages = array()
Tags
access

public

$_arrSettings

Settings value stored in array

public array<string|int, mixed> $_arrSettings = array()
Tags
access

public

$_csvSeparator

Csv seperator

public string $_csvSeparator = ';'
Tags
access

private

$_memberShips

All Memberships take it as array

public array<string|int, mixed> $_memberShips = array()
Tags
access

public

$_statusMessage

Status message

public string $_statusMessage = ''
Tags
access

private

$_strErrMessage

Status Error message

public string $_strErrMessage = ''
Tags
access

private

$_strOkMessage

Status Ok message

public string $_strOkMessage = ''
Tags
access

private

$_strWarMessage

Status Warning message

public string $_strWarMessage = ''
Tags
access

private

$addressTypes

Address Types

public array<string|int, mixed> $addressTypes = array("TXT_CRM_HOME", "TXT_CRM_DELIVERY", "TXT_CRM_OFFICE", "TXT_CRM_BILLING", "TXT_CRM_OTHERS", "TXT_CRM_WORK")
Tags
access

public

$addressValues

Address Values

public array<string|int, mixed> $addressValues = array("", array('label' => 'address', 'lang_variable' => "TXT_CRM_ADDRESS"), array('label' => 'city', 'lang_variable' => "TXT_CRM_CITY"), array('label' => 'state', 'lang_variable' => "TXT_CRM_STATE"), array('label' => 'zip', 'lang_variable' => "TXT_CRM_ZIP"), array('label' => 'country', 'lang_variable' => "TXT_CRM_COUNTRY"), "type")
Tags
access

public

$adminAccessId

Admin Access Id

public int $adminAccessId = 195
Tags
access

public

$countries

All Countries name take it as array

public array<string|int, mixed> $countries = array()
Tags
access

public

$customerAccessId

Customer Access Id

public int $customerAccessId = 194
Tags
access

public

$customerTypes

All customer types take it as array

public array<string|int, mixed> $customerTypes = array()
Tags
access

public

$emailOptions

Email Options

public array<string|int, mixed> $emailOptions = array("TXT_CRM_HOME", "TXT_CRM_WORK", "TXT_CRM_OTHERS")
Tags
access

public

$moduleName

Module Name

public string $moduleName = ''
Tags
access

private

$moduleNameLC

Module Name in lower case

public string $moduleNameLC = ''
Tags
access

private

$phoneOptions

Phone Options

public array<string|int, mixed> $phoneOptions = array("TXT_CRM_HOME", "TXT_CRM_WORK", "TXT_CRM_MOBILE", "TXT_CRM_FAX", "TXT_CRM_DIRECT", "TXT_CRM_OTHERS")
Tags
access

public

$supportCaseStatus

Support Case Status

public array<string|int, mixed> $supportCaseStatus = array(0 => 'Open', 1 => 'Pending', 2 => 'Closed')
Tags
access

private

$websiteOptions

Website Options

public array<string|int, mixed> $websiteOptions = array("TXT_CRM_HOME", "TXT_CRM_WORK", "TXT_CRM_BUSINESS1", "TXT_CRM_BUSINESS2", "TXT_CRM_BUSINESS3", "TXT_CRM_PRIVATE", "TXT_CRM_OTHERS")
Tags
access

public

$websiteProfileOptions

Website Profile Options

public array<string|int, mixed> $websiteProfileOptions = array("TXT_CRM_HOME", "TXT_CRM_WORK", "TXT_CRM_OTHERS", "TXT_CRM_BUSINESS1", "TXT_CRM_BUSINESS2", "TXT_CRM_BUSINESS3")
Tags
access

public

$instance

Class Object

protected static object $instance
Tags
access

protected

$load

object for loading class

protected object $load
Tags
access

protected

$socialProfileOptions

Social Profile Options

protected array<string|int, mixed> $socialProfileOptions = array(self::SOCIAL_NETWORK_NONE => '', self::SOCIAL_NETWORK_SKYPE => 'TXT_CRM_SKYPE', self::SOCIAL_NETWORK_TWITTER => 'TXT_CRM_TWITTER', self::SOCIAL_NETWORK_LINKEDIN => 'TXT_CRM_LINKEDIN', self::SOCIAL_NETWORK_FACEBOOK => 'TXT_CRM_FACEBOOK', self::SOCIAL_NETWORK_LIVEJOURNAL => 'TXT_CRM_LIVEJOURNAL', self::SOCIAL_NETWORK_MYSPACE => 'TXT_CRM_MYSPACE', self::SOCIAL_NETWORK_GMAIL => 'TXT_CRM_GMAIL', self::SOCIAL_NETWORK_BLOGGER => 'TXT_CRM_BLOGGER', self::SOCIAL_NETWORK_ICQ => 'TXT_CRM_ICQ', self::SOCIAL_NETWORK_XING => 'TXT_CRM_XING')

Methods

__construct()

PHP5 constructor

public __construct(mixed $name) : mixed
Parameters
$name : mixed
Tags
global

object $objTemplate

global

array $_ARRAYLANG

_escapeCsvValue()

Escape a value that it could be inserted into a csv file.

public _escapeCsvValue(string $value) : string
Parameters
$value : string
Return values
string

_getDomainNameId()

Get Domain name Id

public _getDomainNameId(int $websiteId, int $cusId, string $domainName) : int
Parameters
$websiteId : int

website id

$cusId : int

customer id

$domainName : string

domain name

Tags
global

ADO Connection $objDatabase

Return values
int

_getResourceDropDown()

Populates the Cloudrexx user Filter Drop Down

public _getResourceDropDown([string $block = 'members' ][, int $selectedId = 0 ][, int $groupId = 0 ]) : null
Parameters
$block : string = 'members'

The name of the template block to parse

$selectedId : int = 0

The ID of the selected user

$groupId : int = 0

Resource froup id

Return values
null

_initCrmModule()

Registers all css and js to be loaded for crm module

public _initCrmModule() : mixed

_modifyContact()

add or edit contact

public _modifyContact() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

_modifyDeal()

add /edit of deals

public _modifyDeal() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

_modifyIndustry()

add/ edit industry

public _modifyIndustry() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

_modifyMembership()

add/ edit membership

public _modifyMembership() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

_modifyNotes()

add/edit of notes page

public _modifyNotes() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

_usortByMultipleKeys()

Usort for multiple key values

public _usortByMultipleKeys(int $key[, string $direction = SORT_ASC ]) : int
Parameters
$key : int

key values

$direction : string = SORT_ASC

sorting order

Return values
int

activateCompanySize()

Activate / Deactivate company size status

public activateCompanySize(mixed $entries[, bool $deactivate = false ]) : null
Parameters
$entries : mixed

company size id

$deactivate : bool = false
Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

addContact()

add new contact

public addContact() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

addCrmContact()

Adding Crm Contact

public addCrmContact([array<string|int, mixed> $arrFormData = array() ]) : null
Parameters
$arrFormData : array<string|int, mixed> = array()

form data's

Return values
null

addCrmContactFromAccessUser()

Create a CRM contact based on an object of \User

public static addCrmContactFromAccessUser(User $user) : int
Parameters
$user : User
Return values
int

The ID of the newly created CRM contact

addUser()

Add User in the time of adding a customer based on the account settings

public addUser(string $email, string $password[, bool $sendLoginDetails = false ][, mixed $result = array() ][, mixed $id = null ]) : bool
Parameters
$email : string

user email id

$password : string

user password

$sendLoginDetails : bool = false

status

$result : mixed = array()
$id : mixed = null
Return values
bool

autoSuggest()

Default Customer Suggetion box functionality

public autoSuggest() : json
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
json

result

changeActive()

change the status

public changeActive(int $id, int $value) : true
Parameters
$id : int

record id

$value : int

record value

Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

changeCustomerContactStatus()

change the customer contact status

public changeCustomerContactStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

changeCustomerStatus()

change the customer status

public changeCustomerStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

checkAccountId()

check the account id

public checkAccountId() : json
Return values
json

checkCustomerIdentity()

check the customer identity

public checkCustomerIdentity([bool $return = false ]) : true
Parameters
$return : bool = false

boolean

Tags
global

array $_ARRAYLANG

Return values
true

countEntries()

Counts all existing entries in the database.

public countEntries(string $table[, string $where = null ]) : int
Parameters
$table : string

table name

$where : string = null

condition

Tags
global

ADONewConnection

Return values
int

number of entries in the database

countEntriesOfJoin()

Counts all existing entries in the database.

public countEntriesOfJoin(string $table) : int
Parameters
$table : string

table name

Tags
global

ADONewConnection

Return values
int

number of entries in the database

countRecordEntries()

get the count of entries

public countRecordEntries(string $query) : int
Parameters
$query : string
Return values
int

createLanguageArray()

Creates an array containing all frontend-languages. Example: $arrValue[$langId]['short'] or $arrValue[$langId]['long']

public createLanguageArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

$arrReturn

createThumbnailOfImage()

Create thumbnail of image

public static createThumbnailOfImage(string $imageName[, bool $profilePic = false ]) : string
Parameters
$imageName : string
$profilePic : bool = false
Return values
string

currencyChangeStatus()

change the currency status

public currencyChangeStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

customersChangeStatus()

change the customer status

public customersChangeStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

customerTooltipDetail()

customer tool tip

public customerTooltipDetail() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

customerTypeChangeStatus()

change the customer type status

public customerTypeChangeStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

dealsOverview()

Overview of opportunity

public dealsOverview() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

deleteCompanySize()

Delete company size

public deleteCompanySize(mixed $companySizeId) : null
Parameters
$companySizeId : mixed

companySizeId is either integer or array.

Tags
global

ADO Connection $objDatabase

Return values
null

deleteContactDocument()

Delete the requested document

public deleteContactDocument() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

deleteCurrency()

delete currency entry

public deleteCurrency() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

deleteCustomerComment()

Delete the Comment single

public deleteCustomerComment() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

deleteCustomers()

delete customer related details

public deleteCustomers() : mixed
Tags
global

array $_ARRAYLANG

deleteCustomerTypes()

delete customer types

public deleteCustomerTypes() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

deleteDeal()

Delete Deal record

public deleteDeal() : null
Tags
global

ADO Connection $objDatabase

Return values
null

deleteDeals()

Delete Multiple Deals

public deleteDeals(array<string|int, mixed> $dealsEntries) : null
Parameters
$dealsEntries : array<string|int, mixed>

entry ids

Tags
global

ADO Connection $objDatabase

Return values
null

deleteIndustryType()

Delete Industry type

public deleteIndustryType() : null
Tags
global

ADO Connection $objDatabase

Return values
null

deleteMembership()

delete Membership

public deleteMembership() : null
Tags
global

ADO Connection $objDatabase

Return values
null

deleteStage()

Delete stage record

public deleteStage() : null
Tags
global

ADO Connection $objDatabase

Return values
null

docUploadFinished()

the upload is finished rewrite the names write the uploaded files to the database

public static docUploadFinished(string $tempPath, string $tempWebPath, array<string|int, mixed> $data, int $uploadId, array<string|int, mixed> $fileInfos, mixed $response) : array<string|int, mixed>
Parameters
$tempPath : string

the temporary file path

$tempWebPath : string

the temporary file path which is accessable by web browser

$data : array<string|int, mixed>

the data which are attached by uploader init method

$uploadId : int

the upload id

$fileInfos : array<string|int, mixed>

the file infos

$response : mixed
Return values
array<string|int, mixed>

the target paths

download()

To download a file

public download(string $file) : null
Parameters
$file : string
Return values
null

editnotes()

edit notes page

public editnotes() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

exportVcf()

export the customer vcf

public exportVcf() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

formattedWebsite()

Formatting the website

public formattedWebsite([string $url = '' ][, int $urlProfile = 0 ]) : string
Parameters
$url : string = ''
$urlProfile : int = 0
Return values
string

getActiveEmailTemLangId()

get the available email template lang ids

public getActiveEmailTemLangId([string $section = 'Crm' ][, string $key = '' ]) : array<string|int, mixed>
Parameters
$section : string = 'Crm'

mail template section name

$key : string = ''

mail template key value

Return values
array<string|int, mixed>

getCompanySizeDropDown()

Get Company Size Dropdown From DB

public getCompanySizeDropDown(mixed $objTpl[, int $selectedId = 0 ][, string $block = 'companySize' ]) : null
Parameters
$objTpl : mixed
$selectedId : int = 0
$block : string = 'companySize'
Tags
global

ADO Connection $objDatabase

Return values
null

getCompanySizeNameById()

Get company size name by id

public getCompanySizeNameById(int $companySizeId) : string
Parameters
$companySizeId : int
Return values
string

name of the company size

getContactAddressCountry()

Get the contact Address Country value From DB

public getContactAddressCountry(mixed $objTpl, int $selectedCountry[, string $block = "crmCountry" ]) : mixed
Parameters
$objTpl : mixed
$selectedCountry : int
$block : string = "crmCountry"
Tags
todo

$selectedCountry must be converted into an integer. See CLX-3968

getContactAddrTypeCountry()

Get Contact Address Type Country value

public getContactAddrTypeCountry(mixed $objTpl, int $selectedType[, string $block = "addressType" ]) : null
Parameters
$objTpl : mixed
$selectedType : int
$block : string = "addressType"
Tags
global

Array $_ARRAYLANG

Return values
null

getContactDeals()

get contact deals

public getContactDeals() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getContactDocuments()

get contact documents

public getContactDocuments() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getContactFileNameById()

return name of the file name

public getContactFileNameById([int $fileId = 0 ][, int $customerId = 0 ]) : file
Parameters
$fileId : int = 0

file id

$customerId : int = 0

customer id

Tags
global

object $objDatabase

Return values
file

name

getContactsQuery()

public getContactsQuery([mixed $filter = array() ][, mixed $sortField = 'c.id' ][, mixed $sortOrder = 0 ]) : mixed
Parameters
$filter : mixed = array()
$sortField : mixed = 'c.id'
$sortOrder : mixed = 0

getContactTasks()

get the task of a contact

public getContactTasks() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getCountry()

Get Country value from DB

public getCountry() : array<string|int, mixed>
Tags
global

ADO Connection $objDatabase

Return values
array<string|int, mixed>

getCrmDatasource()

Get Crm data Source

public getCrmDatasource() : string
Tags
global

ADO Connection $objDatabase

Return values
string

getCurrencyIdByContactId()

Get ID of the currency assigned to a contact

public static getCurrencyIdByContactId(int $contactId[, bool $companyFallback = true ]) : int

Fetches the ID of the Currency assigned to CrmContact identified by $contactId. If selected CrmContact is of type CrmContact::TYPE_PERSON and has a company assigned (through CrmContact::$contact_customer), then that Currency (its ID) will be returned instead.

Parameters
$contactId : int

ID of CrmContact

$companyFallback : bool = true

Set this to false to not lookup the Currency of an assinged company (through CrmContact::$contact_customer) in case CrmContact is of type CrmContact::TYPE_PERSON.

Return values
int

Id of assigned Currency or 0 if $crmId is not a valid ID of a company or person.

getCustomerContacts()

get the contacts of the given customer

public getCustomerContacts(int $customerId) : true
Parameters
$customerId : int

customer id

Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getCustomerCurrencyDropDown()

Get Customer's Currency Dropdown From DB

public getCustomerCurrencyDropDown(mixed $objTpl[, int $selectedId = 0 ][, string $block = "currency" ]) : null
Parameters
$objTpl : mixed
$selectedId : int = 0
$block : string = "currency"
Tags
global

Array $_ARRAYLANG

global

ADO Connection $objDatabase

Return values
null

getCustomerDomains()

get customers domain result

public getCustomerDomains() : json
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
json

result

getCustomerId()

get the logged customer id

public getCustomerId() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getCustomers()

get customer search results as json result

public getCustomers() : json
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
json

result

getCustomerSearch()

get customer search result

public getCustomerSearch() : json
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
json

result

getCustomerTypeDropDown()

Get Customertype Dropdown From DB

public getCustomerTypeDropDown(object $objTpl[, int $selectedId = 0 ][, string $block = "customerTypes" ][, array<string|int, mixed> $options = array() ]) : null
Parameters
$objTpl : object
$selectedId : int = 0
$block : string = "customerTypes"
$options : array<string|int, mixed> = array()
Tags
global

Array $_ARRAYLANG

Return values
null

getCustomerTypeNameById()

Get customer type name by id

public getCustomerTypeNameById(int $customerTypeId) : string
Parameters
$customerTypeId : int

customer type id

Return values
string

name of the customer type

getCustomerTypes()

Get Customer Types From DB

public getCustomerTypes() : int
Tags
global

ADO Connection $objDatabase

Return values
int

getDatasourceDropDown()

Get Data source Dropdown

public getDatasourceDropDown(mixed $objTpl[, string $block = 'datasource' ][, int $selectedId = 0 ]) : null
Parameters
$objTpl : mixed
$block : string = 'datasource'

block name

$selectedId : int = 0

Default value id

Return values
null

getDealsStages()

Get Deals Stages

public getDealsStages([int $selectedStage = 0 ][, string $block = "dealsStages" ]) : null
Parameters
$selectedStage : int = 0
$block : string = "dealsStages"
Tags
global

ADO Connection $objDatabase

Return values
null

getDefaultCurrencyId()

Get default currencyId

public static getDefaultCurrencyId() : int
Return values
int

defaultCurrencyId

getEmail()

Get username

public getEmail(int $userId) : string
Parameters
$userId : int
Return values
string

getEmailTempLang()

get the email template lang id for sending mail

public getEmailTempLang([array<string|int, mixed> $availableEmailTemp = array() ][, string $email = '' ]) : int
Parameters
$availableEmailTemp : array<string|int, mixed> = array()

available email template ids

$email : string = ''

recipient email id

Return values
int

getExistCrmDetail()

get exist crm account detail

public getExistCrmDetail(int $id) : array<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed>

getImportFilename()

get the imported file name

public getImportFilename() : null
Tags
global

ADOConnection $objDatabase

Return values
null

getIndustryTypeDropDown()

Get Industry Type Dropdown From DB

public getIndustryTypeDropDown(object $objTpl[, int $selectedId = 0 ][, string $block = "industryType" ]) : null
Parameters
$objTpl : object
$selectedId : int = 0
$block : string = "industryType"
Tags
global

Array $_ARRAYLANG

global

ADO Connection $objDatabase

global

Array $_LANGID

Return values
null

getIndustryTypeNameById()

Get industry type name by id

public getIndustryTypeNameById(int $industryId) : string
Parameters
$industryId : int

industry type id

Return values
string

name of the industry type

getLinkContacts()

get contacts to link the customer

public getLinkContacts() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

getMembershipDropdown()

Get Membership dropdown

public getMembershipDropdown(mixed $objTpl, array<string|int, mixed> $memberShips[, string $block = "assignedGroup" ][, array<string|int, mixed> $selected = array() ]) : null
Parameters
$objTpl : mixed
$memberShips : array<string|int, mixed>

membership ids

$block : string = "assignedGroup"

Block name

$selected : array<string|int, mixed> = array()

Default membership ids

Return values
null

getMemberships()

Get Membership details From DB

public getMemberships([bool $active = true ]) : array<string|int, mixed>
Parameters
$active : bool = true

membership status

Tags
global

ADO Connection $objDatabase

global

Array $_LANGID

Return values
array<string|int, mixed>

getModifyTaskTypes()

Get Modify Task type values From DB

public getModifyTaskTypes([int $id = 0 ]) : null
Parameters
$id : int = 0

Task type id

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

getOverviewMembershipDropdown()

Get membership dropdown for overview page

public getOverviewMembershipDropdown(mixed $objTpl, object $modelMembership[, int $selected = array() ][, string $block = "memberships" ][, array<string|int, mixed> $options = array() ]) : null
Parameters
$objTpl : mixed
$modelMembership : object
$selected : int = array()
$block : string = "memberships"
$options : array<string|int, mixed> = array()
Return values
null

getPage()

Set the backend page

public getPage() : null
Tags
access

public

global

object $objTemplate

global

array $_ARRAYLANG

Return values
null

getPagingLimit()

Returns the allowed maximum element per page. Can be used for paging.

public getPagingLimit() : int
Tags
global

array

Return values
int

allowed maximum of elements per page.

getResources()

Get Resource data's

public getResources(int $groupId) : bool
Parameters
$groupId : int

resource group id

Tags
global

ADO Connection $objDatabase

Return values
bool

getSettings()

Get the Settings value from the DB

public getSettings() : array<string|int, mixed>
Tags
global

ADO Connection $objDatabase

Return values
array<string|int, mixed>

Setting values

getUserIdByCrmUserId()

Checks whether the crm customer is connected with a user account

public static getUserIdByCrmUserId(mixed $crmId) : int|null
Parameters
$crmId : mixed
Return values
int|null

user_account of crm user

getUserName()

Get username

public getUserName(int $userId) : string
Parameters
$userId : int
Return values
string

init()

Initialize a class

public static init() : object
Return values
object

initUploader()

Inits the uploader when displaying a contact form.

public initUploader(string $callBackFun, string $callBackJs, array<string|int, mixed> $data, string $buttonText[, array<string|int, mixed> $options = array() ]) : null
Parameters
$callBackFun : string
$callBackJs : string
$data : array<string|int, mixed>
$buttonText : string
$options : array<string|int, mixed> = array()
Return values
null

listIndustryTypes()

List the industry types

public listIndustryTypes(mixed $objTpl, int $intView[, int $intIndustryId = null ][, array<string|int, mixed> $arrParentIds = null ]) : string
Parameters
$objTpl : mixed
$intView : int
$intIndustryId : int = null

industry id

$arrParentIds : array<string|int, mixed> = null

parent ids

Tags
global

Array $_ARRAYLANG

global

ADO Connection $objDatabase

Return values
string

makeLinksInTheContent()

Make the url string's into clickable link's.

public makeLinksInTheContent(string $html) : string

Example:

http://www.cloudrexx.com

will be

http://www.cloudrexx.com

Parameters
$html : string
Return values
string

$html

notesChangeStatus()

change the notes status

public notesChangeStatus() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

notesDetail()

returns the notes details of the customer

public notesDetail() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

notesOverview()

notes overview page

public notesOverview() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

notesUploadFinished()

the upload is finished rewrite the names write the uploaded files to the database

public static notesUploadFinished(string $tempPath, string $tempWebPath, array<string|int, mixed> $data, int $uploadId, array<string|int, mixed> $fileInfos, string $response) : array<string|int, mixed>
Parameters
$tempPath : string

the temporary file path

$tempWebPath : string

the temporary file path which is accessable by web browser

$data : array<string|int, mixed>

the data which are attached by uploader init method

$uploadId : int

the upload id

$fileInfos : array<string|int, mixed>

the file infos

$response : string

the respose

Return values
array<string|int, mixed>

the target paths

notifyStaffOnContactAccModification()

notify the staffs regarding the account modification of a contact

public notifyStaffOnContactAccModification([int $customerId = 0 ][, string $first_name = '' ][, string $last_name = '' ][, mixed $gender = 0 ]) : null
Parameters
$customerId : int = 0

customer id

$first_name : string = ''

customer first name

$last_name : string = ''

customer last name

$gender : mixed = 0
Tags
access

public

global

object $objTemplate

global

array $_ARRAYLANG

Return values
null

parseContacts()

Parse the contacts

public parseContacts(array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
$input : array<string|int, mixed>

input value

Return values
array<string|int, mixed>

parseLetterIndexList()

public parseLetterIndexList(string $URI, string $paramName, string $selectedLetter) : mixed
Parameters
$URI : string

url

$paramName : string

parameter name

$selectedLetter : string

Selected letter

Tags
global

array $_CORELANG

proPhotoUploadFinished()

the upload is finished rewrite the names write the uploaded files to the database

public static proPhotoUploadFinished(string $tempPath, string $tempWebPath, array<string|int, mixed> $data, int $uploadId, array<string|int, mixed> $fileInfos, string $response) : array<string|int, mixed>
Parameters
$tempPath : string

the temporary file path

$tempWebPath : string

the temporary file path which is accessable by web browser

$data : array<string|int, mixed>

the data which are attached by uploader init method

$uploadId : int

the upload id

$fileInfos : array<string|int, mixed>

the file infos

$response : string

the respose

Return values
array<string|int, mixed>

the target paths

saveSortingCompanySize()

Save the sorting

public saveSortingCompanySize(array<string|int, mixed> $entriesSorting) : null
Parameters
$entriesSorting : array<string|int, mixed>

sorting values.

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

saveSortingIndustryType()

Industry type sorting function

public saveSortingIndustryType(array<string|int, mixed> $industryEntrySorting) : null
Parameters
$industryEntrySorting : array<string|int, mixed>

entries id

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

saveSortingMembership()

Membership Sorting functionality

public saveSortingMembership(array<string|int, mixed> $entriesSorting) : null
Parameters
$entriesSorting : array<string|int, mixed>

entries ids

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

saveStage()

save opportunity stages

public saveStage() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

saveStageSorting()

save sorting stage

public saveStageSorting(array<string|int, mixed> $successEntrySorting) : null
Parameters
$successEntrySorting : array<string|int, mixed>

entry ids

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

saveTaskTypes()

Save Task Type values to DB

public saveTaskTypes([int $id = 0 ]) : null
Parameters
$id : int = 0

task type id

Tags
global

ADO Connection $objDatabase

Return values
null

setContactPersonProfile()

Adding Crm Contact and link it with crm company if possible

public setContactPersonProfile([array<string|int, mixed> $arrFormData = array() ][, int $userAccountId = 0 ][, int $frontendLanguage = null ]) : mixed
Parameters
$arrFormData : array<string|int, mixed> = array()

form data's

$userAccountId : int = 0
$frontendLanguage : int = null
Tags
global

$objDatabase

global

int $_LANGID

settingsSubmenu()

get settings submenu

public settingsSubmenu() : mixed
Tags
global

array $_ARRAYLANG

showCustomerDetail()

Shows the Customer details page

public showCustomerDetail() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showCustomers()

Shows the Customer overview page

public showCustomers() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showIndustry()

show settings industry

public showIndustry() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showInterface()

show the interface

public showInterface() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showMembership()

show membership menu

public showMembership() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showOpportunityStages()

show opportunity stages

public showOpportunityStages() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showTasks()

get task overview page

public showTasks() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

showTaskTypes()

Show all the Task Types

public showTaskTypes() : null
Tags
global

Array $_ARRAYLANG

global

ADO Connection $objDatabase

Return values
null

stripOnlyTags()

strips only the given tags

public stripOnlyTags(string $str, tags $tags[, bool $stripContent = false ]) : string
Parameters
$str : string

name

$tags : tags

which needs to be strip

$stripContent : bool = false

stripContent

Return values
string

submenu()

get task submenu

public submenu() : true
Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

taskTypeDropDown()

Get Tasktype Dropdown

public taskTypeDropDown(object $objTpl[, int $selectedType = 0 ]) : null
Parameters
$objTpl : object
$selectedType : int = 0
Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

Return values
null

taskUploadFinished()

the upload is finished rewrite the names write the uploaded files to the database

public static taskUploadFinished(string $tempPath, string $tempWebPath, array<string|int, mixed> $data, int $uploadId, array<string|int, mixed> $fileInfos, string $response) : array<string|int, mixed>
Parameters
$tempPath : string

the temporary file path

$tempWebPath : string

the temporary file path which is accessable by web browser

$data : array<string|int, mixed>

the data which are attached by uploader init method

$uploadId : int

the upload id

$fileInfos : array<string|int, mixed>

the file infos

$response : string

the respose

Return values
array<string|int, mixed>

the target paths

toggleIndustryType()

Industry type Change Status

public toggleIndustryType(int $industryEntry) : void
Parameters
$industryEntry : int

entry id

Tags
global

ADO Connection $objDatabase

toggleMembership()

Change Membership Status

public toggleMembership(int $entryId) : void
Parameters
$entryId : int

entry id

Tags
global

ADO Connection $objDatabase

toggleStage()

change stage status

public toggleStage(int $successEntry) : void
Parameters
$successEntry : int

entry id

Tags
global

ADO Connection $objDatabase

global

Array $_ARRAYLANG

unlinkContact()

Unlink the contact

public unlinkContact(int $contactId) : null
Parameters
$contactId : int
Tags
global

ADO Connection $objDatabase

Return values
null

updateCustomerContacts()

Update Customer Contacts

public updateCustomerContacts(array<string|int, mixed> $contacts, int $customerId) : null
Parameters
$contacts : array<string|int, mixed>
$customerId : int
Tags
global

ADO Connection $objDatabase

Return values
null

updateCustomerMemberships()

Update Customer Memberships

public updateCustomerMemberships(array<string|int, mixed> $memberShips, int $customerId) : null
Parameters
$memberShips : array<string|int, mixed>
$customerId : int
Tags
global

ADO Connection $objDatabase

Return values
null

uploadFinished()

the upload is finished rewrite the names write the uploaded files to the database

public static uploadFinished(string $tempPath, string $tempWebPath, array<string|int, mixed> $data, int $uploadId, array<string|int, mixed> $fileInfos, string $response) : array<string|int, mixed>
Parameters
$tempPath : string

the temporary file path

$tempWebPath : string

the temporary file path which is accessable by web browser

$data : array<string|int, mixed>

the data which are attached by uploader init method

$uploadId : int

the upload id

$fileInfos : array<string|int, mixed>

the file infos

$response : string

the respose

Return values
array<string|int, mixed>

the target paths

validateCustomer()

Validate the Customer

public validateCustomer([string $customerName = '' ][, int $customerId = '' ][, int $id = 0 ]) : bool
Parameters
$customerName : string = ''
$customerId : int = ''
$id : int = 0
Tags
global

ADO Connection $objDatabase

Return values
bool

validation()

validation for the notes

public validation(string $name[, int $id = 0 ]) : true
Parameters
$name : string

validation name

$id : int = 0

id

Tags
global

array $_ARRAYLANG

global

object $objDatabase

Return values
true

createThumbnailOfPicture()

Create thumbnail of image

protected createThumbnailOfPicture(string $imageName) : string
Parameters
$imageName : string
Return values
string

getTaskPermission()

Returns true or false for task edit and delete permission

protected getTaskPermission(int $added_user, int $assigned_user) : bool

Returns true or false for task edit and delete permission.

Parameters
$added_user : int

The addeduser of the task

$assigned_user : int

responsible user

Return values
bool

True if the user has the access, false otherwise

getTemporaryUploadPath()

Gets the temporary upload location for files.

protected static getTemporaryUploadPath(int $submissionId, mixed $fieldId, mixed $dir) : array<string|int, mixed>
Parameters
$submissionId : int
$fieldId : mixed
$dir : mixed
Tags
throws
ContactException
Return values
array<string|int, mixed>

array('path','webpath', 'dirname')

moveUploadedImageInToPlace()

Move uploaded image into respective folder

protected static moveUploadedImageInToPlace(object $objUser, string $tmpImageName, string $name[, bool $profilePic = false ]) : string
Parameters
$objUser : object
$tmpImageName : string
$name : string
$profilePic : bool = false
Return values
string

        
On this page

Search results