company.lib.php File Reference

Ensemble de functions de base pour le module societe. More...

Go to the source code of this file.

Functions
	societe_prepare_head (Societe $object)
	Return array of tabs to used on pages for third parties cards. More...
	societe_prepare_head2 ($object)
	Return array of tabs to used on page. More...
	societe_admin_prepare_head ()
	Return array head with list of tabs to view object information. More...
	getCountry ($searchkey, $withcode='', $dbtouse=null, $outputlangs=null, $entconv=1, $searchlabel='')
	Return country label, code or id from an id, code or label. More...
	getState ($id, $withcode='', $dbtouse=null, $withregion=0, $outputlangs=null, $entconv=1)
	Return state translated from an id. More...
	currency_name ($code_iso, $withcode=0, $outputlangs=null)
	Return label of currency or code+label. More...
	getFormeJuridiqueLabel ($code)
	Return the name translated of juridical status. More...
	getCountriesInEEC ()
	Return list of countries that are inside the EEC (European Economic Community) Note: Try to keep this function as a "memory only" function for performance reasons. More...
	isInEEC ($object)
	Return if a country of an object is inside the EEC (European Economic Community) More...
	show_projects ($conf, $langs, $db, $object, $backtopage='', $nocreatelink=0, $morehtmlright='')
	Show html area for list of projects. More...
	show_contacts ($conf, $langs, $db, $object, $backtopage='', $showuserlogin=0)
	Show html area for list of contacts. More...
	show_actions_todo ($conf, $langs, $db, $filterobj, $objcon=null, $noprint=0, $actioncode='')
	Show html area with actions to do. More...
	show_actions_done ($conf, $langs, $db, $filterobj, $objcon=null, $noprint=0, $actioncode='', $donetodo='done', $filters=array(), $sortfield='a.datep, a.id', $sortorder='DESC', $module='')
	Show html area with actions (done or not, ignore the name of function). More...
	show_subsidiaries ($conf, $langs, $db, $object)
	Show html area for list of subsidiaries. More...
	addEventTypeSQL (&$sql, $actioncode, $sqlANDOR="AND")
	Add Event Type SQL. More...
	addOtherFilterSQL (&$sql, $donetodo, $now, $filters)
	Add Event Type SQL. More...
	addMailingEventTypeSQL ($actioncode, $objcon, $filterobj)
	Add Mailing Event Type SQL. More...
	htmlPrintOnlineFooter ($fromcompany, $langs, $addformmessage=0, $suffix='', $object=null)
	Show footer of company in HTML pages. More...

Detailed Description

Ensemble de functions de base pour le module societe.

Definition in file company.lib.php.

Function Documentation

addEventTypeSQL()

addEventTypeSQL	(	&	$sql,
			$actioncode,
			$sqlANDOR = "AND"
	)

Add Event Type SQL.

Parameters

string	$sql	$sql modified
string	$actioncode	Action code
string	$sqlANDOR	"AND", "OR" or "" sql condition

Returns

string sql request

Definition at line 2464 of file company.lib.php.

addMailingEventTypeSQL()

addMailingEventTypeSQL	(		$actioncode,
			$objcon,
			$filterobj
	)

Add Mailing Event Type SQL.

Parameters

string	$actioncode	Action code
Object	$objcon	objcon
Object	$filterobj	filterobj

Returns

string

Definition at line 2530 of file company.lib.php.

addOtherFilterSQL()

addOtherFilterSQL	(	&	$sql,
			$donetodo,
			$now,
			$filters
	)

Add Event Type SQL.

Parameters

string	$sql	$sql modified
string	$donetodo	donetodo
string	$now	now
array	$filters	array

Returns

string sql request

Definition at line 2503 of file company.lib.php.

currency_name()

currency_name	(		$code_iso,
			$withcode = 0,
			$outputlangs = null
	)

Return label of currency or code+label.

Parameters

string	$code_iso	Code iso of currency
int	$withcode	'1'=show code + label
Translate	$outputlangs	Output language

Returns

string Label translated of currency

Definition at line 687 of file company.lib.php.

getCountriesInEEC()

getCountriesInEEC

(

)

Return list of countries that are inside the EEC (European Economic Community) Note: Try to keep this function as a "memory only" function for performance reasons.

Returns

array Array of countries code in EEC

Definition at line 768 of file company.lib.php.

Referenced by isInEEC().

getCountry()

getCountry	(		$searchkey,
			$withcode = '',
			$dbtouse = null,
			$outputlangs = null,
			$entconv = 1,
			$searchlabel = ''
	)

Return country label, code or id from an id, code or label.

Parameters

int | string	$searchkey	Id or code of country to search
string	$withcode	'0'=Return label, '1'=Return code + label, '2'=Return code from id, '3'=Return id from code, 'all'=Return array('id'=>,'code'=>,'label'=>)
DoliDB	$dbtouse	Database handler (using in global way may fail because of conflicts with some autoload features)
Translate	$outputlangs	Langs object for output translation
int	$entconv	0=Return value without entities and not converted to output charset, 1=Ready for html output
string	$searchlabel	Label of country to search (warning: searching on label is not reliable)

Returns

int|string|array{id:int,code:string,label:string} Integer with country id or String with country code or translated country name or Array('id','code','label') or 'NotDefined'

Definition at line 535 of file company.lib.php.

getFormeJuridiqueLabel()

getFormeJuridiqueLabel

(

$code

)

Return the name translated of juridical status.

Parameters

string

$code

Code of juridical status

Returns

string Value of the juridical status

Definition at line 731 of file company.lib.php.

getState()

getState	(		$id,
			$withcode = '',
			$dbtouse = null,
			$withregion = 0,
			$outputlangs = null,
			$entconv = 1
	)

Return state translated from an id.

Return value is always utf8 encoded and without entities.

Parameters

int	$id	id of state (province/departement)
string	$withcode	'0'=Return label, '1'=Return string code + label, '2'=Return code, 'all'=return array('id'=>,'code'=>,'label'=>)
DoliDB	$dbtouse	Database handler (using in global way may fail because of conflicts with some autoload features)
int	$withregion	'0'=Ignores region, '1'=Add region name/code/id as needed to output,
Translate	$outputlangs	Langs object for output translation, not fully implemented yet
int	$entconv	0=Return value without entities and not converted to output charset, 1=Ready for html output

Returns

string|array String with state code or state name or Array('id','code','label')/Array('id','code','label','region_code','region')

Definition at line 615 of file company.lib.php.

htmlPrintOnlineFooter()

htmlPrintOnlineFooter	(		$fromcompany,
			$langs,
			$addformmessage = 0,
			$suffix = '',
			$object = null
	)

Show footer of company in HTML pages.

Parameters

Societe	$fromcompany	Third party
Translate	$langs	Output language
int	$addformmessage	Add the payment form message
string	$suffix	Suffix to use on constants
Object	$object	Object related to payment

Returns

void

Definition at line 2575 of file company.lib.php.

isInEEC()

isInEEC

(

$object

)

Return if a country of an object is inside the EEC (European Economic Community)

Parameters

Object

$object

Object

Returns

boolean true = country inside EEC, false = country outside EEC

Definition at line 805 of file company.lib.php.

References $object, and getCountriesInEEC().

show_actions_done()

show_actions_done	(		$conf,
			$langs,
			$db,
			$filterobj,
			$objcon = null,
			$noprint = 0,
			$actioncode = '',
			$donetodo = 'done',
			$filters = array(),
			$sortfield = 'a.datep,
		a.id'	,
			$sortorder = 'DESC',
			$module = ''
	)

Show html area with actions (done or not, ignore the name of function).

Note: Global parameter $param must be defined.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Object db
mixed	$filterobj	Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket... to list events linked to an object
Contact	$objcon	Filter on object contact to filter events on a contact
int	$noprint	Return string but does not output it
string | string[]	$actioncode	Filter on actioncode
string	$donetodo	Filter on event 'done' or 'todo' or ''=nofilter (all).
array	$filters	Filter on other fields
string	$sortfield	Sort field
string	$sortorder	Sort order
string	$module	You can add module name here if elementtype in table llx_actioncomm is objectkey@module

Returns

string|void Return html part or void if noprint is 1

Definition at line 1712 of file company.lib.php.

show_actions_todo()

show_actions_todo	(		$conf,
			$langs,
			$db,
			$filterobj,
			$objcon = null,
			$noprint = 0,
			$actioncode = ''
	)

Show html area with actions to do.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Object db
Adherent | Societe	$filterobj	Object thirdparty or member
Contact	$objcon	Object contact
int	$noprint	Return string but does not output it
string | string[]	$actioncode	Filter on actioncode

Returns

string|void Return html part or void if noprint is 1

Definition at line 1681 of file company.lib.php.

show_contacts()

show_contacts	(		$conf,
			$langs,
			$db,
			$object,
			$backtopage = '',
			$showuserlogin = 0
	)

Show html area for list of contacts.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Database handler
Societe	$object	Third party object
string	$backtopage	Url to go once contact is created
int	$showuserlogin	1=Show also user login if it exists

Returns

int

Definition at line 1092 of file company.lib.php.

show_projects()

show_projects	(		$conf,
			$langs,
			$db,
			$object,
			$backtopage = '',
			$nocreatelink = 0,
			$morehtmlright = ''
	)

Show html area for list of projects.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Database handler
Object	$object	Third party object
string	$backtopage	Url to go once contact is created
int	$nocreatelink	1=Hide create project link
string	$morehtmlright	More html on right of title

Returns

int

Definition at line 830 of file company.lib.php.

show_subsidiaries()

show_subsidiaries	(		$conf,
			$langs,
			$db,
			$object
	)

Show html area for list of subsidiaries.

Parameters

Conf	$conf	Object conf
Translate	$langs	Object langs
DoliDB	$db	Database handler
Societe	$object	Third party object

Returns

int

Definition at line 2382 of file company.lib.php.

societe_admin_prepare_head()

societe_admin_prepare_head

(

)

Return array head with list of tabs to view object information.

Returns

array head array with tabs

Definition at line 473 of file company.lib.php.

societe_prepare_head()

societe_prepare_head

(

Societe

$object

)

Return array of tabs to used on pages for third parties cards.

Parameters

Societe

$object

Object company shown

Returns

array Array of tabs

Definition at line 43 of file company.lib.php.

societe_prepare_head2()

societe_prepare_head2

(

$object

)

Return array of tabs to used on page.

Parameters

Object

$object

Object for tabs

Returns

array Array of tabs

Definition at line 447 of file company.lib.php.