Class CApiGcontactsCommandCreator

Class CApiGcontactsCommandCreator is used for creating query-strings which is used in database requests.

api_CommandCreator

Extended by

CApiGcontactsCommandCreator

Direct known subclasses

CApiGcontactsCommandCreatorMySQL

Indirect known subclasses

CApiGcontactsCommandCreatorPostgreSQL

Package: GContacts\Storages
Located at gcontacts/storages/db/command_creator.php

Methods summary

`protected array`	# `_getCommonSubQuery( CAccount $oAccount )` Returns common part of most queries. Returns common part of most queries. Parameters `$oAccount` Account object. Returns array
`protected array`	# `_getSearchSubQuery( string $sSearch )` Returns search part of most queries. Returns search part of most queries. Parameters `$sSearch` Search string. Returns array
`protected string`	# `_getContactQueryByWhere( string $sWhere, boolean $bIgnoreHideInGab = false )` Returns query-string with specified WHERE-part for found contact. Returns query-string with specified WHERE-part for found contact. Parameters `$sWhere` WHERE-part for query. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns string
`public string`	# `getContactItemsCountQuery( CAccount $oAccount, string $sSearch = '' )` Returns query-string for obtaining count of all global contacts found by search-string for specified account. Returns query-string for obtaining count of all global contacts found by search-string for specified account. Parameters `$oAccount` Account object. `$sSearch` = '' Search-string. Returns string
`public string`	# `getContactByIdQuery( CAccount $oAccount, mixed $mContactId, boolean $bIgnoreHideInGab = false )` Returns query-string for obtaining contact by identifier for specified account. Returns query-string for obtaining contact by identifier for specified account. Parameters `$oAccount` Account object. `$mContactId` Global contact identifier. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns string
`public string`	# `getContactByTypeIdQuery( CAccount $oAccount, mixed $mContactTypeId, boolean $bIgnoreHideInGab = false )` Returns query-string for obtaining contact by type identifier for specified account. Returns query-string for obtaining contact by type identifier for specified account. Parameters `$oAccount` Account object. `$mContactTypeId` $mGlobalContactTypeId Global contact type identifier. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns string
`public string`	# `getContactByMailingListIdQuery( mixed $iMailingListID )` Returns query-string for obtaining contact by mailing list identifier. Returns query-string for obtaining contact by mailing list identifier. Parameters `$iMailingListID` Mailing list identifier. Returns string
`public string`	# `getContactByEmailQuery( CAccount $oAccount, string $sEmail )` Returns query-string for obtaining contact by email for specified account. Returns query-string for obtaining contact by email for specified account. Parameters `$oAccount` Account object. `$sEmail` Contact email. Returns string
`public string`	# `updateContactQuery( CContact $oContact )` Returns query-string for updating contact data by contact object. Returns query-string for updating contact data by contact object. Parameters `$oContact` Contact object. Returns string
`public string`	# `getMissingGlobalContactsDataQuery( )` Returns query-string for looking for contacts in the address book belonging to the user or the mailing list. Returns query-string for looking for contacts in the address book belonging to the user or the mailing list. Returns string
`public string`	# `insertMissingGlobalContactsQuery( $aData )` Returns query-string for adding contacts to the address book. Returns query-string for adding contacts to the address book. Returns string