|
dolibarr 25.0.0-alpha
|
Class to manage third parties objects (customers, suppliers, prospects...) More...


Public Member Functions | |
| __construct ($db) | |
| Constructor. | |
| create (User $user, $notrigger=0) | |
| Create third party in database. | |
| create_individual (User $user, $no_email=0, $tags=array(), $notrigger=0) | |
| Create a contact/address from thirdparty. | |
| verify () | |
| Check properties of third party are ok (like name, third party codes, ...) Used before an add or update. | |
| update ($id, User $user, $call_trigger=1, $allowmodcodeclient=0, $allowmodcodefournisseur=0, $action='update', $nosyncmember=1) | |
| Update parameters of third party. | |
| fetch ($rowid, $ref='', $ref_ext='', $barcode='', $idprof1='', $idprof2='', $idprof3='', $idprof4='', $idprof5='', $idprof6='', $email='', $ref_alias='', $is_client=0, $is_supplier=0) | |
| Load a third party from database into memory. | |
| setBankAccount ($fk_account, $notrigger=0, $userused=null) | |
| Change the bank account. | |
| setPaymentTerms ($id, $deposit_percent=null) | |
| Change the payments terms. | |
| setPaymentMethods ($id) | |
| Change the payments methods. | |
| findNearest ($rowid=0, $ref='', $ref_ext='', $barcode='', $idprof1='', $idprof2='', $idprof3='', $idprof4='', $idprof5='', $idprof6='', $email='', $ref_alias='', $is_client=0, $is_supplier=0, $vatnumber='') | |
| Search the thirdparty that match the most the provided parameters. | |
| delete ($id, $fuser=null, $call_trigger=1, $nodeletefiles=0) | |
| Delete a third party from database and all its dependencies (contacts, rib...) | |
| set_as_client () | |
| Define third party as a customer. | |
| setAsCustomer () | |
| Define third party as a customer. | |
| set_remise_client ($remise, $note, User $user) | |
| Defines the company as a customer. | |
| set_remise_supplier ($remise, $note, User $user) | |
| Defines the company as a customer. | |
| set_remise_except ($remise, User $user, $desc, $vatrate='', $discount_type=0, $price_base_type='HT') | |
| Add a discount for third party. | |
| getAvailableDiscounts ($user=null, $filter='', $maxvalue=0, $discount_type=0) | |
| Returns amount of included taxes of the current discounts/credits available from the company. | |
| getOpenCreditNotesNotYetConvertedIntoDiscount ($discount_type=0) | |
| Return amount (with tax) of discounts currently available for a company, user or other criteria. | |
| getSalesRepresentatives (User $user, $mode=0, $sortfield=null, $sortorder=null) | |
| Return array of sales representatives. | |
| setPriceLevel ($price_level, User $user) | |
| Set the price level. | |
| add_commercial (User $user, $commid) | |
| Add link to sales representative. | |
| del_commercial (User $user, $commid) | |
| Add link to sales representative. | |
| getTooltipContentArray ($params) | |
| getTooltipContentArray | |
| getNomUrl ($withpicto=0, $option='', $maxlen=0, $notooltip=0, $save_lastsearch_value=-1, $noaliasinname=0, $target='', $morecss='valignmiddle', $addlinktonotes=0) | |
| Return a link on thirdparty (with picto) | |
| getTypeUrl ($withpicto=0, $option='', $notooltip=0, $tag='a') | |
| Return link(s) on type of thirdparty (with picto) | |
| getLibStatut ($mode=0) | |
| Return label of status (activity, closed) | |
| LibStatut ($status, $mode=0) | |
| Return the label of a given status. | |
| thirdparty_and_contact_email_array ($addthirdparty=0) | |
| Return list of contacts emails existing for third party. | |
| thirdparty_and_contact_phone_array () | |
| Return list of contacts mobile phone existing for third party. | |
| contact_property_array ($mode='email', $hidedisabled=0) | |
| Return list of contacts emails or mobile existing for third party. | |
| contact_array () | |
| Return the contact list of this company. | |
| contact_array_objects () | |
| Return the contact list of this company. | |
| contact_get_property ($rowid, $mode) | |
| Return property of contact from its id. | |
| display_rib ($mode='label') | |
| Return bank number property of thirdparty (label or rum) | |
| get_all_rib () | |
| Return Array of RIB. | |
| getDefaultRib () | |
| codeclient_modifiable () | |
| Check if a client code is editable based on the parameters of the code control module. | |
| codefournisseur_modifiable () | |
| Check if a vendor code is editable in the code control module configuration. | |
| check_codeclient () | |
| Check customer code. | |
| check_codefournisseur () | |
| Check supplier code. | |
| get_codecompta ($type) | |
| Assigns a accounting code from the accounting code module. | |
| setParent ($id) | |
| Define parent company of current company. | |
| validateFamilyTree ($idparent, $idchild, $counter=0) | |
| Check if a thirdparty $idchild is or not inside the parents (or grand parents) of another thirdparty id $idparent. | |
| getParentsForCompany ($company_id, $parents=array()) | |
| Get parents for company. | |
| getChildrenForCompany ($company_id) | |
| Get children for company. | |
| id_prof_verifiable ($idprof) | |
| Returns if a profid should be verified to be unique. | |
| id_prof_exists ($idprof, $value, $socid=0) | |
| Verify if a profid exists into database for others thirds. | |
| id_prof_check ($idprof) | |
| Check the validity of a professional identifier according to the properties (country) of the thirdparty (siren, siret, ...) | |
| id_prof_url ($idprof, $thirdparty) | |
| Return an url to check online a professional id or empty string. | |
| has_projects () | |
| Indicates if the company has projects. | |
| info ($id) | |
| Load information for tab info. | |
| isACompany () | |
| Check if third party is a company (Business) or an end user (Consumer) | |
| isInEEC () | |
| Return if a company is inside the EEC (European Economic Community) | |
| isInSEPA () | |
| Return if a company is inside the SEPA zone (Single Euro Payment Area) | |
| LoadSupplierCateg () | |
| Load the list of provider categories. | |
| AddFournisseurInCategory ($categorie_id) | |
| Insert link supplier - category. | |
| getNbOfEMailings () | |
| Return number of mass Emailing received by this contacts with its email. | |
| setNoEmail ($no_email, $unsubscribegroup='') | |
| Set "blacklist" mailing status. | |
| getNoEmail () | |
| get "blacklist" mailing status set no_email attribute to 1 or 0 | |
| create_from_member (Adherent $member, $socname='', $socalias='', $customercode='') | |
| Create a third party into database from a member object. | |
| setMysoc (Conf $conf) | |
| Set properties with value into $conf. | |
| initAsSpecimen () | |
| Initialise an instance with random values. | |
| useLocalTax ($localTaxNum=0, $mode=0, $thirdparty=null) | |
| Check if we must use localtax feature or not according to country (country of $mysoc in most cases). | |
| useNPR () | |
| Check if we must use NPR Vat (french stupid rule) or not according to country (country of $mysoc in most cases). | |
| useRevenueStamp () | |
| Check if we must use revenue stamps feature or not according to country (country of $mysoc in most cases). | |
| getLibProspLevel () | |
| Return prostect level. | |
| LibProspLevel ($fk_prospectlevel) | |
| Return label of prospect level. | |
| getLibProspCommStatut ($mode=0, $label='') | |
| Return status of prospect. | |
| LibProspCommStatut ($status, $mode=0, $label='', $picto='') | |
| Return label of a given status. | |
| getOutstandingProposals ($mode='customer') | |
| Return amount of proposal not yet paid and total an dlist of all proposals. | |
| getOutstandingOrders ($mode='customer') | |
| Return amount of order not yet paid and total and list of all orders. | |
| getInvoiceRemainToPayInOutstanding ($invoice, $mode='customer', $late=0) | |
| Remain to pay for one invoice if it counts in getOutstandingBills() "opened" (same rules as tiles). | |
| getOutstandingBills ($mode='customer', $late=0) | |
| Return amount of bill not yet paid and total of all invoices. | |
| getLibCustProspStatut () | |
| Return label of status customer is prospect/customer. | |
| LibCustProspStatut ($status) | |
| Return the label of the customer/prospect status. | |
| calculateVATNumberFromProperties ($thirdparty) | |
| Calculate VAT intracommunity number for a thirdparty if missing, from the professional ID. | |
| generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null) | |
| Create a document onto disk according to template module. | |
| setCategories ($categories, $type_categ, $remove_existing=true) | |
| Sets object to supplied categories. | |
| setSalesRep ($salesrep, $onlyAdd=false) | |
| Sets sales representatives of the thirdparty. | |
| setThirdpartyType ($typent_id) | |
| Define third-party type of current company. | |
| setAccountancyCode ($type, $value) | |
| Sets an accountancy code for a thirdparty. | |
| fetchPartnerships ($mode) | |
| Function to get partnerships array. | |
| getKanbanView ($option='', $arraydata=array()) | |
| Return clickable link of object (with optional picto) | |
| getContacts ($list=0, $code='', $element='', $status=-1) | |
| Get array of all contacts for a society (stored in societe_contacts instead of element_contacts for all other objects) | |
| mergeCompany ($soc_origin_id) | |
| Merge a company with current one, deleting the given company $soc_origin_id. | |
Public Member Functions inherited from CommonObject | |
| setErrorsFromObject ($object) | |
| setErrorsFromObject | |
| getTooltipContent ($params) | |
| getTooltipContent | |
| errorsToString () | |
| Method to output saved errors. | |
| getFormatedCustomerRef ($objref) | |
| Return customer ref for screen output. | |
| getFormatedSupplierRef ($objref) | |
| Return supplier ref for screen output. | |
| getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='') | |
| Return full address of contact. | |
| getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0) | |
| Return the link of last main doc file for direct public download. | |
| add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0) | |
| Add a link between element $this->element and a contact. | |
| copy_linked_contact ($objFrom, $source='internal') | |
| Copy contact from one element to current. | |
| update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0) | |
| Update a link to contact line. | |
| delete_contact ($rowid, $notrigger=0) | |
| Delete a link to contact line. | |
| delete_linked_contact ($source='', $code='') | |
| Delete all links between an object $this and all its contacts in llx_element_contact. | |
| liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array()) | |
| Get array of all contacts for an object. | |
| swapContactStatus ($rowid) | |
| Update status of a contact linked to object. | |
| liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='') | |
| Return array with list of possible values for type of contacts. | |
| listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='') | |
| Return array with list of possible values for type of contacts. | |
| getIdContact ($source, $code, $status=0) | |
| Return id of contacts for a source and a contact code. | |
| fetch_contact ($contactid=null) | |
| Load object contact with id=$this->contact_id into $this->contact. | |
| fetch_thirdparty ($force_thirdparty_id=0) | |
| Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. | |
| fetchOneLike ($ref) | |
| Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. | |
| fetch_barcode () | |
| Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. | |
| fetchBarCode () | |
| Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. | |
| fetchProject () | |
| Load the project with id $this->fk_project into this->project. | |
| fetch_project () | |
| Load the project with id $this->fk_project into this->project. | |
| fetch_projet () | |
| Load the project with id $this->fk_project into this->project. | |
| fetch_product () | |
| Load the product with id $this->fk_product into this->product. | |
| fetchWarehouse ($force_warehouse_id=0) | |
| Load the warehouse of object, from id $this->warehouse_id or $this->fk_warehouse, into this->warehouse. | |
| fetch_user ($userid) | |
| Load the user with id $userid into this->user. | |
| fetch_origin () | |
| Read linked origin object. | |
| fetchObjectFrom ($table, $field, $key, $element=null) | |
| Load object from specific field. | |
| getValueFrom ($table, $id, $field) | |
| Getter generic. | |
| setFieldValue (User $user, $fieldKey, $value, $byPassUserPermission=false) | |
| Set a value for a dynamic field on the current object. | |
| getFieldUiValue ($field) | |
| Return the value of a field of $fields, read in the property holding it (see getFieldPropertyName()). | |
| updateFieldFromUi (User $user, $field, $value) | |
| Update a field from the user interface (ajax edition of cards...) and save it into database. | |
| getFieldValueFromAjaxPost ($field) | |
| Return the value of a field posted by the user interface (ajax edition of fields). | |
| ajaxOutputField ($field) | |
| Return the output html of a field for the user interface (ajax edition of fields). | |
| ajaxInputField ($field) | |
| Return the input html of a field for the user interface (ajax edition of fields). | |
| setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif') | |
| Setter generic. | |
| load_previous_next_ref ($filter, $fieldid, $nodbprefix=0) | |
| Load properties id_previous and id_next by comparing $fieldid with $this->ref. | |
| getListContactId ($source='external') | |
| Return list of id of contacts of object. | |
| setProject ($projectid, $notrigger=0) | |
| Link element with a project. | |
| setMulticurrencyCode ($code) | |
| Change the multicurrency code. | |
| setTransportMode ($id) | |
| Change the transport mode methods. | |
| setDeliveryAddress ($id) | |
| Define delivery address. | |
| setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null) | |
| Change the shipping method. | |
| setWarehouse ($warehouse_id) | |
| Change the warehouse. | |
| setDocModel ($user, $modelpdf) | |
| Set last model used by doc generator. | |
| line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true) | |
| Save a new position (field rang) for details lines. | |
| getChildrenOfLine ($id, $includealltree=0) | |
| Get children of line. | |
| line_up ($rowid, $fk_parent_line=true) | |
| Update a line to have a lower rank. | |
| line_down ($rowid, $fk_parent_line=true) | |
| Update a line to have a higher rank. | |
| updateRangOfLine ($rowid, $rang) | |
| Update position of line (rang) | |
| line_ajaxorder ($rows) | |
| Update position of line with ajax (rang) | |
| updateLineUp ($rowid, $rang) | |
| Update position of line up (rang) | |
| updateLineDown ($rowid, $rang, $max) | |
| Update position of line down (rang) | |
| getRangOfLine ($rowid) | |
| Get position of line (rang) | |
| getIdOfLine ($rang) | |
| Get rowid of the line relative to its position. | |
| roundQtyToPackaging ($qty, $packaging) | |
| Round a quantity up to the next multiple of a packaging quantity (options PRODUCT_USE_CUSTOMER_PACKAGING and PRODUCT_USE_SUPPLIER_PACKAGING). | |
| line_max ($fk_parent_line=0) | |
| Get max value used for position of line (rang) | |
| update_ref_ext ($ref_ext) | |
| Update external ref of element. | |
| update_note ($note, $suffix='', $notrigger=0) | |
| Update note of element. | |
| update_note_public ($note) | |
| Update public note (kept for backward compatibility) | |
| update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null) | |
| Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). | |
| add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0) | |
| Add an object link into llx_element_element. | |
| getElementType () | |
| Return an element type string formatted like element_element target_type and source_type. | |
| fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1) | |
| Fetch array of objects linked to current object (object of enabled modules only). | |
| clearObjectLinkedCache () | |
| Clear the cache saying that all linked object were already loaded. | |
| updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0) | |
| Update object linked of a current object. | |
| deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0) | |
| Delete all links between an object $this. | |
| setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='') | |
| Set status of an object. | |
| getCanvas ($id=0, $ref='') | |
| Load type of canvas of an object if it exists. | |
| getSpecialCode ($lineid) | |
| Get special code of a line. | |
| isObjectUsed ($id=0, $entity=0) | |
| Function to check if an object is used by others (by children). | |
| hasProductsOrServices ($predefined=-1) | |
| Function to say how many lines object contains. | |
| getTotalDiscount () | |
| Function that returns the total amount HT of discounts applied for all lines. | |
| getTotalWeightVolume () | |
| Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. | |
| setExtraParameters () | |
| Set extra parameters. | |
| formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl') | |
| Show add free and predefined products/services form. | |
| printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl') | |
| Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. | |
| getObjectLinesDisplayContext () | |
| Return the display context of the lines, as defined by the card of the object before printObjectLines() and formAddObjectLine(). | |
| initObjectLinesDisplay () | |
| Init the display of the lines: set the global variables used by the line templates (objectline_xxx.tpl.php) from getObjectLinesDisplayContext() To call in the card before printObjectLines() and formAddObjectLine(). | |
| getObjectLineHtml ($lineid, $action='') | |
| Return the HTML of a line as printed in the card by printObjectLines(), hooks printObjectLine and printObjectSubLine included. | |
| printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl') | |
| Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) | |
| printOriginLinesList ($restrictlist='', $selectedLines=array()) | |
| Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). | |
| printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array()) | |
| Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). | |
| add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0, $notrigger=0) | |
| Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. | |
| delete_resource ($rowid, $element='', $notrigger=0) | |
| Delete a link to resource line. | |
| __clone () | |
| Overwrite magic function to solve problem of cloning object that are kept as references. | |
| indexFile ($destfull, $update_main_doc_field) | |
| Index a file into the ECM database. | |
| addThumbs ($file, $quality=50) | |
| Build thumb. | |
| delThumbs ($file) | |
| Delete thumbs. | |
| getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml') | |
| Return the default value to use for a field when showing the create form of object. | |
| fetchValuesForExtraLanguages () | |
| Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. | |
| setValuesForExtraLanguages ($onlykey='') | |
| Fill array_options property of object by extrafields value (using for data sent by forms) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty. | |
| fetchNoCompute ($id) | |
| Function to make a fetch but set environment to avoid to load computed values before. | |
| fetch_optionals ($rowid=null, $optionsArray=null) | |
| Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. | |
| deleteExtraFields () | |
| Delete all extra fields values for the current object. | |
| insertExtraFields ($trigger='', $userused=null) | |
| Add/Update all extra fields values for the current object. | |
| insertExtraLanguages ($trigger='', $userused=null) | |
| Add/Update all extra languages values for the current object. | |
| updateExtraField ($key, $trigger=null, $userused=null) | |
| Update 1 extra field value for the current object. | |
| getExtraField ($key) | |
| Convenience method for retrieving the value of an extrafield without actually fetching it from the database. | |
| setExtraField ($key, $value) | |
| Convenience method for setting the value of an extrafield without actually updating it in the database. | |
| updateExtraLanguages ($key, $trigger=null, $userused=null) | |
| Update an extra language value for the current object. | |
| showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0) | |
| Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. | |
| clearFieldError ($fieldKey) | |
| clear validation message result for a field | |
| setFieldError ($fieldKey, $msg='') | |
| set validation error message a field | |
| getFieldError ($fieldKey) | |
| get field error message | |
| validateField ($fields, $fieldKey, $fieldValue) | |
| Return validation test result for a field. | |
| showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card') | |
| Function to show lines of extrafields with output data. | |
| getJSListDependancies ($type='_extra') | |
| getRights () | |
| Returns the rights used for this class. | |
| getRightsForUser (User $user) | |
| Returns the rights used for this class for a specific user. | |
| hasUserPermission (User $user, $mode='write') | |
| Check if user has a permission on this type of object. | |
| hasUserWritePermissionOnField (User $user, $field) | |
| Check if user has write permission on a field of this object. | |
| hasUserPermissionOnField (User $user, $field, $mode='write') | |
| Check if user has a permission on a field of this object. | |
| isFieldEditAllowed (User $user, $field, $byPassUserPermission=false) | |
| Check whether a given field is allowed to be edited on the current object. | |
| isFieldEditableFromUi (User $user, $field) | |
| Check whether a field can be edited from the user interface with generic tools (ajax edition of cards...), where the user chooses the field to modify. | |
| isFieldReadableFromUi (User $user, $field) | |
| Check whether the value of a field can be read from the user interface with generic tools (ajax refresh of the values displayed on a card...), by a user allowed to read the object. | |
| defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0, $qty=0) | |
| Get buy price to use for margin calculation. | |
| getLinkedBuyPriceDocuments ($user, $lineid, $oldbuyprice=null) | |
| Return the linked proposals, orders and invoices having, for the product of a line of this object, a cost price different from the one saved on the line (for a purchase order, the average net unit price of the product on the ordered purchase orders linked to the same documents, weighted by the quantities). | |
| updateLinkedBuyPrice ($user, $lineid, $elements) | |
| Apply the cost price of a line of this object to the lines of the same product of some linked documents. | |
| getDataToShowPhoto ($modulepart, $imagesize) | |
| Function used to get the logos or photos of an object. | |
| show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref') | |
| Show photos of an object (nbmax maximum), into several columns. | |
| isDate ($info) | |
| Function test if type is date. | |
| isDuration ($info) | |
| Function test if type is duration. | |
| isInt ($info) | |
| Function test if type is integer. | |
| isFloat ($info) | |
| Function test if type is float. | |
| isText ($info) | |
| Function test if type is text. | |
| setVarsFromFetchObj (&$obj) | |
| Function to load data from a SQL pointer into properties of current object $this. | |
| emtpyObjectVars () | |
| Sets all object fields to null. | |
| getFieldList ($alias='', $excludefields=array()) | |
| Function to concat keys of fields. | |
| createCommon (User $user, $notrigger=0) | |
| Create object in the database. | |
| fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0) | |
| Load object in memory from the database. | |
| fetchLinesCommon ($morewhere='', $noextrafields=0) | |
| Load object in memory from the database. | |
| updateCommon (User $user, $notrigger=0) | |
| Update object into database. | |
| deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0) | |
| Delete object in database. | |
| deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND") | |
| Delete all child object from a parent ID. | |
| isLineOfObject ($lineid) | |
| Check that a line belongs to this object, using $this->table_element_line and $this->fk_element. | |
| deleteLineCommon (User $user, $idline, $notrigger=0) | |
| Delete a line of object in database. | |
| setStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
| Set to a status. | |
| initAsSpecimenCommon () | |
| Initialise object with example values Id must be 0 if object instance is a specimen. | |
| fetchComments () | |
| Load comments linked with current task. | |
| getNbComments () | |
| Return nb comments already posted. | |
| trimParameters ($parameters) | |
| Trim object parameters. | |
| getCategoriesCommon ($type_categ) | |
| Sets object to given categories. | |
| setCategoriesCommon ($categories, $type_categ='', $remove_existing=true) | |
| Sets object to given categories. | |
| cloneCategories ($fromId, $toId, $type='') | |
| Copy related categories to another object. | |
| deleteEcmFiles ($mode=0) | |
| Delete related files of object in database. | |
| checkActiveProductInLines ($status='onsale') | |
| Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order. | |
| setErrorWithoutLog ($message) | |
| Set the error message for the object without logging it. | |
| setErrorWithLog ($message, $loglevel=LOG_ERR) | |
| Set the error message for the object and logs it, including the file name and line number. | |
| showLastFilePreview ($rootdir='', $relativepath='') | |
| Show preview link of the element (last generate or *<ref>*.pdf) if found and authorized to show the preview (file type) | |
Static Public Member Functions | |
| static | replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id) |
| Function used to replace a thirdparty id with another one. | |
Static Public Member Functions inherited from CommonObject | |
| static | isExistingObject ($element, $id, $ref='', $ref_ext='') |
| Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch. | |
| static | getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element) |
| Function used to get an array with all items linked to an object id in association table. | |
| static | getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element) |
| Count items linked to an object id in association table. | |
| static | deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element) |
| Function used to remove all items linked to an object id in association table. | |
| static | commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
| Function used to replace a thirdparty id with another one. | |
| static | commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
| Function used to replace a product id with another one. | |
| static | commonReplaceContact (DoliDB $dbs, $origin_id, $dest_id, array $tables, $fieldname='fk_socpeople', $ignoreerrors=0) |
| Function used to replace a contact id with another one. | |
Public Attributes | |
| const | NO_CUSTOMER = 0 |
| Third party type is no customer. | |
| const | CUSTOMER = 1 |
| Third party type is a customer. | |
| const | PROSPECT = 2 |
| Third party type is a prospect. | |
| const | CUSTOMER_AND_PROSPECT = 3 |
| Third party type is a customer and a prospect. | |
| const | NO_SUPPLIER = 0 |
| Third party supplier flag is not supplier. | |
| const | SUPPLIER = 1 |
| Third party supplier flag is a supplier. | |
Public Attributes inherited from CommonObject | |
| $origin_object | |
Protected Member Functions | |
| deprecatedProperties () | |
| Provide list of deprecated properties and replacements. | |
Protected Member Functions inherited from CommonObject | |
| onFieldValueChanged ($fieldKey, $value) | |
| Hook called by setFieldValue() after a field has been successfully assigned. | |
| getFieldPropertyName ($field) | |
| Return the name of the property of the object holding the value of a field of $fields. | |
| persistFieldValue (User $user, $field) | |
| Save into database the current value of one field, called by updateFieldFromUi(). | |
| prepareObjectLinesDisplay () | |
| Prepare the display of the lines: global $usemargins and line extrafields used by the line templates (objectline_xxx.tpl.php) Used by printObjectLines() and getObjectLineHtml() | |
| printObjectLineWithHooks ($action, $line, $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir) | |
| Print a line of the lines table: hooks printObjectLine or printObjectSubLine, then printObjectLine() if no hook replaced it Used by printObjectLines() and getObjectLineHtml() | |
| commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
| Common function for all objects extending CommonObject for generating documents. | |
| isFieldDefined ($field) | |
| Check if the field is defined in the object's field metadata. | |
| isFieldDisabled ($field) | |
| Check if the field is explicitly marked as disabled. | |
| isFieldValidationRequired ($field) | |
| Check if the field requires validation. | |
| isFieldEnabled ($field) | |
| Check if the field is enabled. | |
| isFieldMarkedNotEditable ($field) | |
| Check if the field is explicitly marked as not editable. | |
| isFieldBlockedByObjectState ($field) | |
| Check if the field is blocked by the current object state. | |
| isArray ($info) | |
| Function test if type is array. | |
| canBeNull ($info) | |
| Function test if field can be null. | |
| isForcedToNullIfZero ($info) | |
| Function test if field is forced to null if zero or empty. | |
| isIndex ($info) | |
| Function test if is indexed. | |
| setSaveQuery () | |
| Function to return the array of data key-value from the ->fields and all the ->properties of an object. | |
| quote ($value, $fieldsentry) | |
| Add quote to field value if necessary. | |
Class to manage third parties objects (customers, suppliers, prospects...)
Definition at line 57 of file societe.class.php.
| Societe::__construct | ( | $db | ) |
Constructor.
Reimplemented in Client, and Fournisseur.
Definition at line 979 of file societe.class.php.
References getDolGlobalInt(), getDolGlobalString(), and status.
| Societe::add_commercial | ( | User | $user, |
| $commid ) |
Add link to sales representative.
| User | $user | Object user |
| int | $commid | Id of user |
Definition at line 3185 of file societe.class.php.
References dol_syslog().
Referenced by create(), and setSalesRep().
| Societe::AddFournisseurInCategory | ( | $categorie_id | ) |
Insert link supplier - category.
| int | $categorie_id | Id of category |
Definition at line 4746 of file societe.class.php.
| Societe::calculateVATNumberFromProperties | ( | $thirdparty | ) |
Calculate VAT intracommunity number for a thirdparty if missing, from the professional ID.
| mixed | $thirdparty | A thirdparty object |
Definition at line 5711 of file societe.class.php.
References isValidSiren(), and isValidSiret().
| Societe::check_codeclient | ( | ) |
Check customer code.
Definition at line 4164 of file societe.class.php.
References $conf, dol_include_once(), dol_syslog(), and getDolGlobalString().
Referenced by verify().
| Societe::check_codefournisseur | ( | ) |
Check supplier code.
Definition at line 4206 of file societe.class.php.
References $conf, dol_include_once(), dol_syslog(), and getDolGlobalString().
Referenced by verify().
| Societe::codeclient_modifiable | ( | ) |
Check if a client code is editable based on the parameters of the code control module.
Definition at line 4076 of file societe.class.php.
References $conf, dol_include_once(), dol_syslog(), and getDolGlobalString().
| Societe::codefournisseur_modifiable | ( | ) |
Check if a vendor code is editable in the code control module configuration.
Definition at line 4117 of file societe.class.php.
References $conf, dol_include_once(), dol_syslog(), and getDolGlobalString().
| Societe::contact_array | ( | ) |
Return the contact list of this company.
Definition at line 3811 of file societe.class.php.
References dolGetFirstLastname().
| Societe::contact_array_objects | ( | ) |
Return the contact list of this company.
Definition at line 3840 of file societe.class.php.
| Societe::contact_get_property | ( | $rowid, | |
| $mode ) |
Return property of contact from its id.
| int | $rowid | id of contact |
| string | $mode | 'email' or 'mobile' |
Definition at line 3874 of file societe.class.php.
References dol_string_nospecial(), and dolGetFirstLastname().
| Societe::contact_property_array | ( | $mode = 'email', | |
| $hidedisabled = 0 ) |
Return list of contacts emails or mobile existing for third party.
| 'email'|'mobile' | $mode 'email' or 'mobile' |
| int<0,1> | $hidedisabled 1=Hide contact if disabled |
Definition at line 3743 of file societe.class.php.
References dolGetFirstLastname().
Referenced by thirdparty_and_contact_email_array(), and thirdparty_and_contact_phone_array().
| Societe::create | ( | User | $user, |
| $notrigger = 0 ) |
Create third party in database.
$this->code_client = -1 and $this->code_fournisseur = -1 means automatic assignment.
| User | $user | Object of user that ask creation |
| int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1011 of file societe.class.php.
References $conf, add_commercial(), dol_now(), dol_syslog(), getDolGlobalString(), MultiCurrency\getIdFromCode(), name, setEntity(), setUpperOrLowerCase(), status, update(), and verify().
Referenced by create_from_member().
| Societe::create_from_member | ( | Adherent | $member, |
| $socname = '', | |||
| $socalias = '', | |||
| $customercode = '' ) |
Create a third party into database from a member object.
| Adherent | $member | Object member |
| string | $socname | Name of third party to force |
| string | $socalias | Alias name of third party to force |
| string | $customercode | Customer code |
Definition at line 4882 of file societe.class.php.
References address, create(), create_individual(), dol_getIdFromCode(), dol_syslog(), email, getDolGlobalString(), and name.
| Societe::create_individual | ( | User | $user, |
| $no_email = 0, | |||
| $tags = array(), | |||
| $notrigger = 0 ) |
Create a contact/address from thirdparty.
| User | $user | Object user |
| int<0,1> | $no_email 1=Do not send mailing, 0=Ok to receive mailing | |
| string[] | $tags | Array of tag to affect to contact |
| int<0,1> | $notrigger 1=Does not execute triggers, 0= execute triggers |
Definition at line 1193 of file societe.class.php.
References dol_syslog(), getDolGlobalString(), isModEnabled(), CommonObject\setErrorsFromObject(), and setUpperOrLowerCase().
Referenced by create_from_member().
| Societe::del_commercial | ( | User | $user, |
| $commid ) |
Add link to sales representative.
| User | $user | Object user |
| int | $commid | Id of user |
Definition at line 3243 of file societe.class.php.
References dol_syslog().
Referenced by setSalesRep().
| Societe::delete | ( | $id, | |
| $fuser = null, | |||
| $call_trigger = 1, | |||
| $nodeletefiles = 0 ) |
Delete a third party from database and all its dependencies (contacts, rib...)
| int | $id | Id of third party to delete |
| ?User | $fuser | User who ask to delete thirdparty |
| int<0,1> | $call_trigger 0=No, 1=yes | |
| int | $nodeletefiles | Do not delete the documents files of the contact |
Definition at line 2608 of file societe.class.php.
References $conf, CommonObject\deleteExtraFields(), dol_delete_dir_recursive(), dol_include_once(), dol_is_dir(), dol_syslog(), getDolGlobalString(), and CommonObject\isObjectUsed().
|
protected |
Provide list of deprecated properties and replacements.
Reimplemented from CommonObject.
Definition at line 963 of file societe.class.php.
| Societe::display_rib | ( | $mode = 'label' | ) |
Return bank number property of thirdparty (label or rum)
| string | $mode | 'label' or 'rum' or 'format' |
Definition at line 3916 of file societe.class.php.
| Societe::fetch | ( | $rowid, | |
| $ref = '', | |||
| $ref_ext = '', | |||
| $barcode = '', | |||
| $idprof1 = '', | |||
| $idprof2 = '', | |||
| $idprof3 = '', | |||
| $idprof4 = '', | |||
| $idprof5 = '', | |||
| $idprof6 = '', | |||
| $email = '', | |||
| $ref_alias = '', | |||
| $is_client = 0, | |||
| $is_supplier = 0 ) |
Load a third party from database into memory.
| int | $rowid | Id of third party to load |
| string | $ref | Reference of third party, name (Warning, this can return several records) |
| string | $ref_ext | External reference of third party (Warning, this information is a free field not provided by Dolibarr) |
| string | $barcode | Barcode of third party to load |
| string | $idprof1 | Prof id 1 of third party (Warning, this can return several records) |
| string | $idprof2 | Prof id 2 of third party (Warning, this can return several records) |
| string | $idprof3 | Prof id 3 of third party (Warning, this can return several records) |
| string | $idprof4 | Prof id 4 of third party (Warning, this can return several records) |
| string | $idprof5 | Prof id 5 of third party (Warning, this can return several records) |
| string | $idprof6 | Prof id 6 of third party (Warning, this can return several records) |
| string | Email of third party (Warning, this can return several records) | |
| string | $ref_alias | Name_alias of third party (Warning, this can return several records) |
| int | $is_client | Only client third party |
| int | $is_supplier | Only supplier third party |
Reimplemented in Client, and Fournisseur.
Definition at line 1952 of file societe.class.php.
References $conf, address, dol_syslog(), email, CommonObject\fetch_optionals(), getDolGlobalString(), getEntity(), isModEnabled(), name, price2num(), ref, and status.
| Societe::fetchPartnerships | ( | $mode | ) |
Function to get partnerships array.
| string | $mode | 'member' or 'thirdparty' |
Definition at line 5996 of file societe.class.php.
| Societe::findNearest | ( | $rowid = 0, | |
| $ref = '', | |||
| $ref_ext = '', | |||
| $barcode = '', | |||
| $idprof1 = '', | |||
| $idprof2 = '', | |||
| $idprof3 = '', | |||
| $idprof4 = '', | |||
| $idprof5 = '', | |||
| $idprof6 = '', | |||
| $email = '', | |||
| $ref_alias = '', | |||
| $is_client = 0, | |||
| $is_supplier = 0, | |||
| $vatnumber = '' ) |
Search the thirdparty that match the most the provided parameters.
Searching rules try to find the existing third party.
| int | $rowid | Id of third party |
| string | $ref | Reference of third party, name (Warning, this can return several records) |
| string | $ref_ext | External reference of third party (Warning, this information is a free field not provided by Dolibarr) |
| string | $barcode | Barcode of third party to load |
| string | $idprof1 | Prof id 1 of third party (Warning, this can return several records) |
| string | $idprof2 | Prof id 2 of third party (Warning, this can return several records) |
| string | $idprof3 | Prof id 3 of third party (Warning, this can return several records) |
| string | $idprof4 | Prof id 4 of third party (Warning, this can return several records) |
| string | $idprof5 | Prof id 5 of third party (Warning, this can return several records) |
| string | $idprof6 | Prof id 6 of third party (Warning, this can return several records) |
| string | Email of third party (Warning, this can return several records) | |
| string | $ref_alias | Name_alias of third party (Warning, this can return several records) |
| int | $is_client | Only client third party |
| int | $is_supplier | Only supplier third party |
| string | $vatnumber | VAT number |
Definition at line 2445 of file societe.class.php.
References dol_syslog().
| Societe::generateDocument | ( | $modele, | |
| $outputlangs, | |||
| $hidedetails = 0, | |||
| $hidedesc = 0, | |||
| $hideref = 0, | |||
| $moreparams = null ) |
Create a document onto disk according to template module.
| string | $modele | Generator to use. Caller must set it to obj->model_pdf. |
| Translate | $outputlangs | object lang a utiliser pour traduction |
| int<0,1> | $hidedetails Hide details of lines | |
| int<0,1> | $hidedesc Hide description | |
| int<0,1> | $hideref Hide ref | |
| ?array<string,mixed> | $moreparams Array to provide more information |
Definition at line 5748 of file societe.class.php.
References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().
| Societe::get_all_rib | ( | ) |
Return Array of RIB.
Definition at line 3952 of file societe.class.php.
| Societe::get_codecompta | ( | $type | ) |
Assigns a accounting code from the accounting code module.
Computed value is stored into this->code_compta_client or this->code_compta_fournisseur according to $type. May be identical to the one entered or generated automatically. Currently, only the automatic generation is implemented.
| string | $type | Type of thirdparty ('customer' or 'supplier') |
Definition at line 4245 of file societe.class.php.
References $conf, dol_include_once(), and getDolGlobalString().
Referenced by update().
| Societe::getAvailableDiscounts | ( | $user = null, | |
| $filter = '', | |||
| $maxvalue = 0, | |||
| $discount_type = 0 ) |
Returns amount of included taxes of the current discounts/credits available from the company.
| ?User | $user | Filter on a user author of discounts |
| string | $filter | Other filter |
| int | $maxvalue | Filter on max value for discount |
| int<0,1> | $discount_type 0 => customer discount, 1 => supplier discount |
Definition at line 3017 of file societe.class.php.
| Societe::getChildrenForCompany | ( | $company_id | ) |
Get children for company.
| int | $company_id | ID of company to search children |
Definition at line 4406 of file societe.class.php.
References dol_syslog().
Referenced by mergeCompany().
| Societe::getContacts | ( | $list = 0, | |
| $code = '', | |||
| $element = '', | |||
| $status = -1 ) |
Get array of all contacts for a society (stored in societe_contacts instead of element_contacts for all other objects)
| int | $list | 0:Return array contains all properties, 1:Return array contains just id |
| string | $code | Filter on this code of contact type ('SHIPPING', 'BILLING', ...) |
| string | $element | Filter on this element of default contact type ('facture', 'propal', 'commande' ...) |
| int | $status | Filter by contact status: 1=Active only, 0=Inactive only, -1=All (default) |
Definition at line 6062 of file societe.class.php.
References dol_syslog().
| Societe::getDefaultRib | ( | ) |
Definition at line 3979 of file societe.class.php.
| Societe::getInvoiceRemainToPayInOutstanding | ( | $invoice, | |
| $mode = 'customer', | |||
| $late = 0 ) |
Remain to pay for one invoice if it counts in getOutstandingBills() "opened" (same rules as tiles).
| Facture | FactureFournisseur | $invoice | Invoice with id set (and fetched fields) |
| 'customer'|'supplier' | $mode 'customer' or 'supplier' | |
| int<0,1> | $late 0 all outstanding, 1 only past due date |
Definition at line 5502 of file societe.class.php.
References dol_get_first_hour(), dol_now(), price2num(), and FactureFournisseur\TYPE_CREDIT_NOTE.
| Societe::getKanbanView | ( | $option = '', | |
| $arraydata = array() ) |
Return clickable link of object (with optional picto)
| string | $option | Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
| array<string,mixed> | $arraydata Array of data |
Definition at line 6012 of file societe.class.php.
References dol_print_email(), dol_print_phone(), email, getLibStatut(), getNomUrl(), and Form\showphoto().
| Societe::getLibCustProspStatut | ( | ) |
Return label of status customer is prospect/customer.
Definition at line 5673 of file societe.class.php.
References LibCustProspStatut().
| Societe::getLibProspCommStatut | ( | $mode = 0, | |
| $label = '' ) |
Return status of prospect.
| int | $mode | 0=label long, 1=label short, 2=Picto + Label short, 3=Picto, 4=Picto + Label long |
| string | $label | Label to use for status for added status |
Definition at line 5323 of file societe.class.php.
References LibProspCommStatut().
| Societe::getLibProspLevel | ( | ) |
Return prostect level.
Definition at line 5287 of file societe.class.php.
References LibProspLevel().
| Societe::getLibStatut | ( | $mode = 0 | ) |
Return label of status (activity, closed)
| int<0,6> | $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto |
Definition at line 3653 of file societe.class.php.
References LibStatut(), and status.
Referenced by getKanbanView().
| Societe::getNbOfEMailings | ( | ) |
Return number of mass Emailing received by this contacts with its email.
Definition at line 4767 of file societe.class.php.
References email.
| Societe::getNoEmail | ( | ) |
get "blacklist" mailing status set no_email attribute to 1 or 0
Definition at line 4854 of file societe.class.php.
References email, and getEntity().
| Societe::getNomUrl | ( | $withpicto = 0, | |
| $option = '', | |||
| $maxlen = 0, | |||
| $notooltip = 0, | |||
| $save_lastsearch_value = -1, | |||
| $noaliasinname = 0, | |||
| $target = '', | |||
| $morecss = 'valignmiddle', | |||
| $addlinktonotes = 0 ) |
Return a link on thirdparty (with picto)
| int<0,2> | $withpicto Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only) | |
| string | $option | Target of link (''=auto, 'nolink'=no link, 'customer', 'prospect', 'supplier', 'project', 'agenda', ...) |
| int<0,max> | $maxlen Max length of name | |
| int<0,1> | $notooltip 1=Disable tooltip | |
| int<-1,1> | $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking | |
| int<0,1> | $noaliasinname 1=Do not add alias into the link ref | |
| string | $target | add attribute target |
| string | $morecss | More CSS |
| int<0,1> | $addlinktonotes 1=Add link to notes |
Definition at line 3443 of file societe.class.php.
References $conf, dol_escape_htmltag(), dol_string_nohtmltag(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), and name.
Referenced by getKanbanView().
| Societe::getOpenCreditNotesNotYetConvertedIntoDiscount | ( | $discount_type = 0 | ) |
Return amount (with tax) of discounts currently available for a company, user or other criteria.
| int<0,1> | $discount_type 0 => customer discount, 1 => supplier discount |
Definition at line 3038 of file societe.class.php.
References $conf.
| Societe::getOutstandingBills | ( | $mode = 'customer', | |
| $late = 0 ) |
Return amount of bill not yet paid and total of all invoices.
| 'customer'|'supplier'|'' | $mode 'customer' or 'supplier' |
| int<0,1> | $late 0 => all invoice, 1=> only late |
Definition at line 5547 of file societe.class.php.
References dol_get_first_hour(), dol_now(), dol_syslog(), getDolGlobalInt(), and FactureFournisseur\TYPE_CREDIT_NOTE.
| Societe::getOutstandingOrders | ( | $mode = 'customer' | ) |
Return amount of order not yet paid and total and list of all orders.
| 'customer'|'supplier'|'' | $mode 'customer' or 'supplier' |
Definition at line 5452 of file societe.class.php.
References dol_syslog().
| Societe::getOutstandingProposals | ( | $mode = 'customer' | ) |
Return amount of proposal not yet paid and total an dlist of all proposals.
| 'customer'|'supplier' | $mode 'customer' or 'supplier' |
Definition at line 5402 of file societe.class.php.
References dol_syslog().
| Societe::getParentsForCompany | ( | $company_id, | |
| $parents = array() ) |
Get parents for company.
| int | $company_id | ID of company to search parent |
| int[] | $parents | List of companies ID found |
Definition at line 4372 of file societe.class.php.
References dol_syslog(), and getParentsForCompany().
Referenced by getParentsForCompany().
| Societe::getSalesRepresentatives | ( | User | $user, |
| $mode = 0, | |||
| $sortfield = null, | |||
| $sortorder = null ) |
Return array of sales representatives.
| User | $user | Object user (not used) |
| int<0,1> | $mode 0=Array with properties, 1=Array of IDs. | |
| ?string | $sortfield | List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb' |
| ?string | $sortorder | Sort order, separated by comma. Example: 'ASC,DESC'; |
Definition at line 3082 of file societe.class.php.
References $conf, getDolGlobalString(), getEntity(), and isModEnabled().
Referenced by setSalesRep().
| Societe::getTooltipContentArray | ( | $params | ) |
getTooltipContentArray
| array<string,mixed> | $params params to construct tooltip data |
Reimplemented from CommonObject.
Definition at line 3278 of file societe.class.php.
References $conf, address, dol_escape_htmltag(), dol_format_address(), dol_print_phone(), dol_string_nohtmltag(), email, getDolGlobalString(), getTypeUrl(), isModEnabled(), name, Form\showphoto(), and status.
Referenced by getNomUrl().
| Societe::getTypeUrl | ( | $withpicto = 0, | |
| $option = '', | |||
| $notooltip = 0, | |||
| $tag = 'a' ) |
Return link(s) on type of thirdparty (with picto)
| int | $withpicto | Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only) |
| string | $option | ''=All |
| int | $notooltip | 1=Disable tooltip |
| string | $tag | Tag 'a' or 'span' |
Definition at line 3616 of file societe.class.php.
References getDolGlobalString(), and isModEnabled().
Referenced by getTooltipContentArray().
| Societe::has_projects | ( | ) |
Indicates if the company has projects.
Definition at line 4610 of file societe.class.php.
| Societe::id_prof_check | ( | $idprof | ) |
Check the validity of a professional identifier according to the properties (country) of the thirdparty (siren, siret, ...)
| int | $idprof | 1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm) |
Definition at line 4538 of file societe.class.php.
References isValidProfIds().
| Societe::id_prof_exists | ( | $idprof, | |
| $value, | |||
| $socid = 0 ) |
Verify if a profid exists into database for others thirds.
| string | $idprof | 'idprof1','idprof2','idprof3','idprof4','idprof5','idprof6','email' (Example: idprof1=siren, idprof2=siret, idprof3=naf, idprof4=rcs/rm) |
| string | $value | Value of profid |
| int | $socid | Id of thirdparty to exclude (if update) |
Definition at line 4479 of file societe.class.php.
References getEntity().
Referenced by verify().
| Societe::id_prof_url | ( | $idprof, | |
| $thirdparty ) |
Return an url to check online a professional id or empty string.
| int | $idprof | 1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm) |
| Societe | $thirdparty | Object thirdparty |
Definition at line 4557 of file societe.class.php.
References getDolGlobalString().
| Societe::id_prof_verifiable | ( | $idprof | ) |
Returns if a profid should be verified to be unique.
| int | $idprof | 1,2,3,4,5,6 (Example: 1=siren, 2=siret, 3=naf, 4=rcs/rm, 5=eori, 6=idprof6) |
Definition at line 4439 of file societe.class.php.
References $conf, and getDolGlobalBool().
Referenced by verify().
| Societe::info | ( | $id | ) |
Load information for tab info.
| int | $id | Id of thirdparty to load |
Definition at line 4633 of file societe.class.php.
References ref.
| Societe::initAsSpecimen | ( | ) |
| Societe::isACompany | ( | ) |
Check if third party is a company (Business) or an end user (Consumer)
Definition at line 4667 of file societe.class.php.
References getDolGlobalInt(), and getDolGlobalString().
Referenced by Interfaces\run_triggers(), and verify().
| Societe::isInEEC | ( | ) |
Return if a company is inside the EEC (European Economic Community)
Definition at line 4697 of file societe.class.php.
References isInEEC().
Referenced by isInEEC().
| Societe::isInSEPA | ( | ) |
Return if a company is inside the SEPA zone (Single Euro Payment Area)
Definition at line 4708 of file societe.class.php.
References isInSEPA().
Referenced by isInSEPA().
| Societe::LibCustProspStatut | ( | $status | ) |
Return the label of the customer/prospect status.
| int | $status | Id of prospection status |
Definition at line 5685 of file societe.class.php.
Referenced by getLibCustProspStatut().
| Societe::LibProspCommStatut | ( | $status, | |
| $mode = 0, | |||
| $label = '', | |||
| $picto = '' ) |
Return label of a given status.
| int | string | $status | Id or code for prospection status |
| int | $mode | 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto |
| string | $label | Label to use for status for added status |
| string | $picto | Name of image file to show ('filenew', ...) If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1) |
Definition at line 5342 of file societe.class.php.
References img_action().
Referenced by getLibProspCommStatut().
| Societe::LibProspLevel | ( | $fk_prospectlevel | ) |
Return label of prospect level.
| string | $fk_prospectlevel | Prospect level |
Definition at line 5299 of file societe.class.php.
Referenced by getLibProspLevel().
| Societe::LibStatut | ( | $status, | |
| $mode = 0 ) |
Return the label of a given status.
| int | $status | Status id |
| int<0,6> | $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto |
Definition at line 3666 of file societe.class.php.
Referenced by getLibStatut().
| Societe::LoadSupplierCateg | ( | ) |
Load the list of provider categories.
Definition at line 4720 of file societe.class.php.
| Societe::mergeCompany | ( | $soc_origin_id | ) |
Merge a company with current one, deleting the given company $soc_origin_id.
The company given in parameter will be removed. This is called for example by the societe/card.php file. It calls the method replaceThirdparty() of each object with relation with thirdparties, including hook 'replaceThirdparty' for external modules.
| int | $soc_origin_id | Company to merge the data from |
Definition at line 6149 of file societe.class.php.
References $conf, dol_concatdesc(), dol_dir_list(), dol_is_dir(), dol_mkdir(), dol_move(), dol_syslog(), getChildrenForCompany(), getDolGlobalString(), name, setCategories(), and update().
|
static |
Function used to replace a thirdparty id with another one.
It must be used within a transaction to avoid trouble
| DoliDB | $dbs | Database handler, because function is static we name it $dbs not $db to avoid breaking coding test |
| int | $origin_id | Old thirdparty id (will be removed) |
| int | $dest_id | New thirdparty id |
Reimplemented in Fournisseur.
Definition at line 5902 of file societe.class.php.
References CommonObject\commonReplaceThirdparty(), dol_syslog(), Database\fetch_object(), and Database\query().
| Societe::set_as_client | ( | ) |
Define third party as a customer.
Definition at line 2759 of file societe.class.php.
References dol_syslog(), and setAsCustomer().
| Societe::set_remise_client | ( | $remise, | |
| $note, | |||
| User | $user ) |
Defines the company as a customer.
| float | $remise | Value in % of the discount |
| string | $note | Note/Reason for changing the discount |
| User | $user | User who sets the discount |
Definition at line 2818 of file societe.class.php.
References $conf, dol_now(), and dol_syslog().
| Societe::set_remise_except | ( | $remise, | |
| User | $user, | ||
| $desc, | |||
| $vatrate = '', | |||
| $discount_type = 0, | |||
| $price_base_type = 'HT' ) |
Add a discount for third party.
| float | $remise | Amount of discount |
| User | $user | User adding discount |
| string | $desc | Reason of discount |
| string | $vatrate | VAT rate (may contain the vat code too). Example: '1.23', '1.23 (ABC)', ... |
| int | $discount_type | 0 => customer discount, 1 => supplier discount |
| string | $price_base_type | Price base type 'HT' or 'TTC' |
Definition at line 2943 of file societe.class.php.
References $mysoc, MultiCurrency\getIdAndTxFromCode(), getTaxesFromId(), and price2num().
| Societe::set_remise_supplier | ( | $remise, | |
| $note, | |||
| User | $user ) |
Defines the company as a customer.
| float | $remise | Value in % of the discount |
| string | $note | Note/Reason for changing the discount |
| User | $user | User who sets the discount |
Definition at line 2879 of file societe.class.php.
References $conf, dol_now(), and dol_syslog().
| Societe::setAccountancyCode | ( | $type, | |
| $value ) |
Sets an accountancy code for a thirdparty.
Also calls COMPANY_MODIFY trigger when modified
| string | $type | It can be only 'buy' or 'sell' |
| string | $value | Accountancy code |
Definition at line 5946 of file societe.class.php.
References $conf, and dol_syslog().
| Societe::setAsCustomer | ( | ) |
Define third party as a customer.
Definition at line 2772 of file societe.class.php.
References getDolGlobalInt().
Referenced by set_as_client().
| Societe::setBankAccount | ( | $fk_account, | |
| $notrigger = 0, | |||
| $userused = null ) |
Change the bank account.
Overridden to store the value per entity into llx_societe_perentity when MAIN_COMPANY_PERENTITY_SHARED is on (the thirdparty is shared between entities but not its default bank account).
| int | $fk_account | Id of bank account |
| int | $notrigger | 0=launch triggers after, 1=disable triggers |
| User | $userused | Object user |
Reimplemented from CommonObject.
Definition at line 2277 of file societe.class.php.
References $conf, dol_syslog(), and getDolGlobalString().
| Societe::setCategories | ( | $categories, | |
| $type_categ, | |||
| $remove_existing = true ) |
Sets object to supplied categories.
Assign the object to all categories not yet assigned. Unasign object from existing categories not supplied in $categories (if remove_existing==true). If remove_existing is false, existing categories are left untouch.
| int[] | int | $categories | Category ID or array of Categories IDs |
| string | $type_categ | Category type ('customer' or 'supplier') |
| boolean | $remove_existing | True: Remove existings categories from Object if not supplies by $categories, False: let them |
Definition at line 5807 of file societe.class.php.
References dol_syslog().
Referenced by mergeCompany().
| Societe::setMysoc | ( | Conf | $conf | ) |
Set properties with value into $conf.
Definition at line 4985 of file societe.class.php.
References $conf, address, dol_syslog(), email, getCountry(), getDolGlobalInt(), getDolGlobalString(), getState(), name, and price2num().
| Societe::setNoEmail | ( | $no_email, | |
| $unsubscribegroup = '' ) |
Set "blacklist" mailing status.
| int | $no_email | 1=Do not send mailing, 0=Ok to receive mailing |
| string | $unsubscribegroup | Emailing code ('' by default) |
Definition at line 4794 of file societe.class.php.
References dol_now(), email, and getEntity().
| Societe::setParent | ( | $id | ) |
Define parent company of current company.
| int | $id | Id of thirdparty to set or '' to remove |
Definition at line 4300 of file societe.class.php.
References dol_syslog(), and validateFamilyTree().
| Societe::setPaymentMethods | ( | $id | ) |
Change the payments methods.
Overridden to store mode_reglement(_supplier) per entity into llx_societe_perentity when MAIN_COMPANY_PERENTITY_SHARED is on.
| int | $id | Id of new payment method |
Reimplemented from CommonObject.
Definition at line 2390 of file societe.class.php.
References $conf, dol_syslog(), and getDolGlobalString().
| Societe::setPaymentTerms | ( | $id, | |
| $deposit_percent = null ) |
Change the payments terms.
Overridden to store cond_reglement(_supplier) per entity into llx_societe_perentity when MAIN_COMPANY_PERENTITY_SHARED is on. deposit_percent stays global (not part of the per-entity fields) and is always updated on llx_societe.
| int | $id | Id of new payment terms |
| float | $deposit_percent | % of deposit if needed by payment terms |
Reimplemented from CommonObject.
Definition at line 2335 of file societe.class.php.
References $conf, dol_syslog(), formatLogObject(), getDictionaryValue(), and getDolGlobalString().
| Societe::setPriceLevel | ( | $price_level, | |
| User | $user ) |
Set the price level.
| int | $price_level | Level of price |
| User | $user | Use making change |
Definition at line 3150 of file societe.class.php.
References dol_now().
| Societe::setSalesRep | ( | $salesrep, | |
| $onlyAdd = false ) |
Sets sales representatives of the thirdparty.
| int[] | int | $salesrep | User ID or array of user IDs |
| bool | $onlyAdd | Only add (no delete before) |
Definition at line 5827 of file societe.class.php.
References add_commercial(), del_commercial(), and getSalesRepresentatives().
| Societe::setThirdpartyType | ( | $typent_id | ) |
Define third-party type of current company.
| int | $typent_id | third party type rowid in llx_c_typent |
Definition at line 5872 of file societe.class.php.
References dol_getIdFromCode(), dol_syslog(), and CommonObject\setValueFrom().
| Societe::thirdparty_and_contact_email_array | ( | $addthirdparty = 0 | ) |
Return list of contacts emails existing for third party.
| int<0,2> | $addthirdparty 1=Add also a record for thirdparty email, 2=Same than 1 but add text ThirdParty in grey |
Definition at line 3694 of file societe.class.php.
References contact_property_array(), dol_trunc(), email, and name.
| Societe::thirdparty_and_contact_phone_array | ( | ) |
Return list of contacts mobile phone existing for third party.
Definition at line 3718 of file societe.class.php.
References contact_property_array(), dol_trunc(), and name.
| Societe::update | ( | $id, | |
| User | $user, | ||
| $call_trigger = 1, | |||
| $allowmodcodeclient = 0, | |||
| $allowmodcodefournisseur = 0, | |||
| $action = 'update', | |||
| $nosyncmember = 1 ) |
Update parameters of third party.
| int | $id | Id of company (deprecated, use 0 here and call update on an object loaded by a fetch) |
| User | $user | User who requests the update |
| int | $call_trigger | 0=no, 1=yes |
| int | $allowmodcodeclient | Inclut modif code client et code compta |
| int | $allowmodcodefournisseur | Inclut modif code fournisseur et code compta fournisseur |
| string | $action | 'add' or 'update' or 'merge' |
| int | $nosyncmember | Do not synchronize info of linked member |
Definition at line 1455 of file societe.class.php.
References $conf, address, clean_url(), dol_getIdFromCode(), dol_now(), dol_syslog(), email, get_codecompta(), getCountry(), getDolGlobalString(), MultiCurrency\getIdFromCode(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), isModEnabled(), name, price2num(), CommonObject\setErrorsFromObject(), setUpperOrLowerCase(), status, and verify().
Referenced by create(), and mergeCompany().
| Societe::useLocalTax | ( | $localTaxNum = 0, | |
| $mode = 0, | |||
| $thirdparty = null ) |
Check if we must use localtax feature or not according to country (country of $mysoc in most cases).
| int<-1,2> | $localTaxNum Use 1 or 2 to get info for only localtax1 or localtax2, 0 to get both using a boolean test using a OR, -1 to get array for each case. | |
| int<0,1> | $mode 0=Check according to vat dictionary, 1=Check according to ->localtaxX_assuj field of $thirdparty | |
| Societe | null | $thirdparty | Object thirdparty |
Definition at line 5194 of file societe.class.php.
| Societe::useNPR | ( | ) |
Check if we must use NPR Vat (french stupid rule) or not according to country (country of $mysoc in most cases).
Definition at line 5241 of file societe.class.php.
References dol_syslog().
| Societe::useRevenueStamp | ( | ) |
Check if we must use revenue stamps feature or not according to country (country of $mysoc in most cases).
Table c_revenuestamp contains the country and value of stamp per invoice.
Definition at line 5264 of file societe.class.php.
References dol_syslog().
| Societe::validateFamilyTree | ( | $idparent, | |
| $idchild, | |||
| $counter = 0 ) |
Check if a thirdparty $idchild is or not inside the parents (or grand parents) of another thirdparty id $idparent.
| int | $idparent | Id of thirdparty to check |
| int | $idchild | Id of thirdparty to compare to |
| int | $counter | Counter to protect against infinite loops |
Definition at line 4339 of file societe.class.php.
References dol_syslog(), and validateFamilyTree().
Referenced by setParent(), and validateFamilyTree().
| Societe::verify | ( | ) |
Check properties of third party are ok (like name, third party codes, ...) Used before an add or update.
Definition at line 1264 of file societe.class.php.
References $mysoc, check_codeclient(), check_codefournisseur(), email, getDolGlobalString(), id_prof_exists(), id_prof_verifiable(), isACompany(), isValidEmail(), and name.