dolibarr  20.0.0-beta
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Adherent Class Reference

Class to manage members of a foundation. More...

Inheritance diagram for Adherent:
Inheritance graph
[legend]
Collaboration diagram for Adherent:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 send_an_email ($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='', $moreinheader='')
 Function sending an email to the current member with the text supplied in parameter. More...
 
 sendEmail ($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='', $moreinheader='')
 Function sending an email to the current member with the text supplied in parameter. More...
 
 makeSubstitution ($text)
 Make substitution of tags into text with value of current object. More...
 
 getmorphylib ($morphy='', $addbadge=0)
 Return translated label by the nature of a adherent (physical or moral) More...
 
 create ($user, $notrigger=0)
 Create a member into database. More...
 
 update ($user, $notrigger=0, $nosyncuser=0, $nosyncuserpass=0, $nosyncthirdparty=0, $action='update')
 Update a member in database (standard information and password) More...
 
 update_end_date ($user)
 Update denormalized last subscription date. More...
 
 delete ($user, $notrigger=0)
 Fonction to delete a member and its data. More...
 
 setPassword ($user, $password='', $isencrypted=0, $notrigger=0, $nosyncuser=0)
 Change password of a user. More...
 
 setUserId ($userid)
 Set link to a user. More...
 
 setThirdPartyId ($thirdpartyid)
 Set link to a third party. More...
 
 fetch_login ($login)
 Method to load member from its login. More...
 
 fetch_name ($firstname, $lastname)
 Method to load member from its name. More...
 
 fetch ($rowid, $ref='', $fk_soc=0, $ref_ext='', $fetch_optionals=true, $fetch_subscriptions=true)
 Load member from database. More...
 
 fetch_subscriptions ()
 Function to get member subscriptions data: subscriptions, first_subscription_date, first_subscription_date_start, first_subscription_date_end, first_subscription_amount last_subscription_date, last_subscription_date_start, last_subscription_date_end, last_subscription_amount. More...
 
 fetchPartnerships ($mode)
 Function to get partnerships array. More...
 
 subscription ($date, $amount, $accountid=0, $operation='', $label='', $num_chq='', $emetteur_nom='', $emetteur_banque='', $datesubend=0, $fk_type=null)
 Insert subscription into database and eventually add links to banks, mailman, etc... More...
 
 subscriptionComplementaryActions ($subscriptionid, $option, $accountid, $datesubscription, $paymentdate, $operation, $label, $amount, $num_chq, $emetteur_nom='', $emetteur_banque='', $autocreatethirdparty=0, $ext_payment_id='', $ext_payment_site='')
 Do complementary actions after subscription recording. More...
 
 validate ($user)
 Function that validate a member. More...
 
 resiliate ($user)
 Fonction qui resilie un adherent. More...
 
 exclude ($user)
 Functiun to exclude (set adherent.status to -2) a member TODO A private note should be added to know why the member has been excluded For historical purpose it add an "extra-subscription" type excluded. More...
 
 add_to_abo ()
 Function to add member into external tools mailing-list, spip, etc. More...
 
 del_to_abo ()
 Function to delete a member from external tools like mailing-list, spip, etc. More...
 
 getCivilityLabel ()
 Return civility label of a member. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpictoimg=0, $maxlen=0, $option='card', $mode='', $morecss='', $save_lastsearch_value=-1, $notooltip=0, $addlinktonotes=0)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Retourne le libelle du statut d'un adherent (brouillon, valide, resilie, exclu) More...
 
 LibStatut ($status, $need_subscription, $date_end_subscription, $mode=0)
 Renvoi le libelle d'un statut donne. More...
 
 loadStateBoard ()
 Load indicators this->nb in state board. More...
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 _load_ldap_dn ($info, $mode=0)
 Retourne chaine DN complete dans l'annuaire LDAP pour l'objet. More...
 
 _load_ldap_info ()
 Initialise tableau info (tableau des attributes LDAP) More...
 
 info ($id)
 Load type info information in the member object. More...
 
 getNbOfEMailings ()
 Return number of mass Emailing received by this member with its email. More...
 
 setCategories ($categories)
 Sets object to supplied categories. More...
 
 hasDelay ()
 Return if a member is late (subscription late) or not. More...
 
 sendReminderForExpiredSubscription ($daysbeforeendlist='10')
 Send reminders by emails before subscription end CAN BE A CRON TASK. More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 errorsToString ()
 Method to output saved errors. More...
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output. More...
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output. More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contact_id into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_project ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms. More...
 
 setTransportMode ($id)
 Change the transport mode methods. More...
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=0, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id, $includealltree=0)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 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). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. More...
 
 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). More...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0, $entity=0)
 Function to check if an object is used by others (by children). More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 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. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 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. More...
 
 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) More...
 
 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). More...
 
 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). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. More...
 
 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. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 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. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 getDataToShowPhoto More...
 
 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. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isDuration ($info)
 Function test if type is duration. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object in the database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed status. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories. More...
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories. More...
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object. More...
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database. More...
 

Static Public Member Functions

static replaceThirdparty ($db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
- 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. More...
 
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. More...
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Public Attributes

const STATUS_DRAFT = -1
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_RESILIATED = 0
 Resiliated.
 
const STATUS_EXCLUDED = -2
 Excluded.
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements. More...
 
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage members of a foundation.

Definition at line 48 of file adherent.class.php.

Constructor & Destructor Documentation

◆ __construct()

Adherent::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 379 of file adherent.class.php.

References status, and STATUS_DRAFT.

Member Function Documentation

◆ _load_ldap_dn()

Adherent::_load_ldap_dn (   $info,
  $mode = 0 
)

Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.

Parameters
array$infoInfo array loaded by _load_ldap_info
int$mode0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb) 1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb) 2=Return key only (uid=qqq)
Returns
string DN

Definition at line 2715 of file adherent.class.php.

◆ _load_ldap_info()

Adherent::_load_ldap_info ( )

Initialise tableau info (tableau des attributes LDAP)

Returns
array Tableau info des attributes

Definition at line 2740 of file adherent.class.php.

◆ add_to_abo()

Adherent::add_to_abo ( )

Function to add member into external tools mailing-list, spip, etc.

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2120 of file adherent.class.php.

◆ create()

Adherent::create (   $user,
  $notrigger = 0 
)

Create a member into database.

Parameters
User$userObject user qui demande la creation
int$notrigger1 ne declenche pas les triggers, 0 sinon
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 608 of file adherent.class.php.

◆ del_to_abo()

Adherent::del_to_abo ( )

Function to delete a member from external tools like mailing-list, spip, etc.

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2172 of file adherent.class.php.

◆ delete()

Adherent::delete (   $user,
  $notrigger = 0 
)

Fonction to delete a member and its data.

Parameters
User$userUser object
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, 0=nothing to do, >0 if OK

Definition at line 1061 of file adherent.class.php.

◆ exclude()

Adherent::exclude (   $user)

Functiun to exclude (set adherent.status to -2) a member TODO A private note should be added to know why the member has been excluded For historical purpose it add an "extra-subscription" type excluded.

Parameters
User$userUser making change
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2075 of file adherent.class.php.

References $sql, and dol_syslog().

◆ fetch()

Adherent::fetch (   $rowid,
  $ref = '',
  $fk_soc = 0,
  $ref_ext = '',
  $fetch_optionals = true,
  $fetch_subscriptions = true 
)

Load member from database.

Parameters
int$rowidId of object to load
string$refTo load member from its ref
int$fk_socTo load member from its link to third party
string$ref_extExternal reference
bool$fetch_optionalsTo load optionals (extrafields)
bool$fetch_subscriptionsTo load member subscriptions
Returns
int >0 if OK, 0 if not found, <0 if KO

Definition at line 1392 of file adherent.class.php.

◆ fetch_login()

Adherent::fetch_login (   $login)

Method to load member from its login.

Parameters
string$loginlogin of member
Returns
void

Definition at line 1332 of file adherent.class.php.

◆ fetch_name()

Adherent::fetch_name (   $firstname,
  $lastname 
)

Method to load member from its name.

Parameters
string$firstnameFirstname
string$lastnameLastname
Returns
void

Definition at line 1360 of file adherent.class.php.

◆ fetch_subscriptions()

Adherent::fetch_subscriptions ( )

Function to get member subscriptions data: subscriptions, first_subscription_date, first_subscription_date_start, first_subscription_date_end, first_subscription_amount last_subscription_date, last_subscription_date_start, last_subscription_date_end, last_subscription_amount.

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1542 of file adherent.class.php.

◆ fetchPartnerships()

Adherent::fetchPartnerships (   $mode)

Function to get partnerships array.

Parameters
string$mode'member' or 'thirdparty'
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1607 of file adherent.class.php.

◆ generateDocument()

Adherent::generateDocument (   $modele,
  $outputlangs,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0,
  $moreparams = null 
)

Create a document onto disk according to template module.

Parameters
string$modeleForce template to use ('' to not force)
Translate$outputlangsobject lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

Definition at line 2613 of file adherent.class.php.

◆ getCivilityLabel()

Adherent::getCivilityLabel ( )

Return civility label of a member.

Returns
string Translated name of civility (translated with transnoentitiesnoconv)

Definition at line 2223 of file adherent.class.php.

◆ getKanbanView()

Adherent::getKanbanView (   $option = '',
  $arraydata = null 
)

Return clicable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array$arraydataArray of data
Returns
string HTML Code for Kanban thumb.

Definition at line 3260 of file adherent.class.php.

◆ getLibStatut()

Adherent::getLibStatut (   $mode = 0)

Retourne le libelle du statut d'un adherent (brouillon, valide, resilie, exclu)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label

Reimplemented in WebPortalMember.

Definition at line 2429 of file adherent.class.php.

◆ getmorphylib()

Adherent::getmorphylib (   $morphy = '',
  $addbadge = 0 
)

Return translated label by the nature of a adherent (physical or moral)

Parameters
string$morphyNature of the adherent (physical or moral)
int<0,2>$addbadge Add badge (1=Full label, 2=First letters only)
Returns
string Label

Definition at line 557 of file adherent.class.php.

◆ getNbOfEMailings()

Adherent::getNbOfEMailings ( )

Return number of mass Emailing received by this member with its email.

Returns
int Number of EMailings

Definition at line 2927 of file adherent.class.php.

References $sql.

◆ getNomUrl()

Adherent::getNomUrl (   $withpictoimg = 0,
  $maxlen = 0,
  $option = 'card',
  $mode = '',
  $morecss = '',
  $save_lastsearch_value = -1,
  $notooltip = 0,
  $addlinktonotes = 0 
)

Return clicable name (with picto eventually)

Parameters
int$withpictoimg0=No picto, 1=Include picto into link, 2=Only picto, -1=Include photo into link, -2=Only picto photo, -3=Only photo very small, -4=???)
int$maxlenlength max label
string$optionPage for link ('card', 'category', 'subscription', ...)
string$mode''=Show firstname+lastname as label (using default order), 'firstname'=Show only firstname, 'lastname'=Show only lastname, 'login'=Show login, 'ref'=Show ref
string$morecssAdd more css on link
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$notooltip1=Disable tooltip
int$addlinktonotes1=Add link to notes
Returns
string Chaine avec URL

Reimplemented in WebPortalMember.

Definition at line 2306 of file adherent.class.php.

◆ getTooltipContentArray()

Adherent::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsparams to construct tooltip data
Since
v18
Returns
array

Reimplemented from CommonObject.

Reimplemented in WebPortalMember.

Definition at line 2241 of file adherent.class.php.

◆ hasDelay()

Adherent::hasDelay ( )

Return if a member is late (subscription late) or not.

Returns
boolean True if late, False if not late

Definition at line 2983 of file adherent.class.php.

◆ info()

Adherent::info (   $id)

Load type info information in the member object.

Parameters
int$idId of member to load
Returns
void

Definition at line 2891 of file adherent.class.php.

References $sql, and dol_syslog().

◆ initAsSpecimen()

Adherent::initAsSpecimen ( )

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns
int

Definition at line 2642 of file adherent.class.php.

◆ LibStatut()

Adherent::LibStatut (   $status,
  $need_subscription,
  $date_end_subscription,
  $mode = 0 
)

Renvoi le libelle d'un statut donne.

Parameters
int$statusId status
int$need_subscription1 if member type need subscription, 0 otherwise
int$date_end_subscriptionDate fin adhesion
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
Returns
string Label

Reimplemented in WebPortalMember.

Definition at line 2444 of file adherent.class.php.

◆ load_board()

Adherent::load_board (   $user,
  $mode 
)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters
User$userObject user
string$mode"expired" for membership to renew, "shift" for member to validate
Returns
WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

Definition at line 2528 of file adherent.class.php.

◆ loadStateBoard()

Adherent::loadStateBoard ( )

Load indicators this->nb in state board.

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2495 of file adherent.class.php.

◆ makeSubstitution()

Adherent::makeSubstitution (   $text)

Make substitution of tags into text with value of current object.

Parameters
string$textText to make substitution to
Returns
string Value of input text string with substitutions done

Definition at line 483 of file adherent.class.php.

◆ replaceThirdparty()

static Adherent::replaceThirdparty (   $db,
  $origin_id,
  $dest_id 
)
static

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 2971 of file adherent.class.php.

References CommonObject\commonReplaceThirdparty().

◆ resiliate()

Adherent::resiliate (   $user)

Fonction qui resilie un adherent.

Parameters
User$userUser making change
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2025 of file adherent.class.php.

◆ send_an_email()

Adherent::send_an_email (   $text,
  $subject,
  $filename_list = array(),
  $mimetype_list = array(),
  $mimefilename_list = array(),
  $addr_cc = "",
  $addr_bcc = "",
  $deliveryreceipt = 0,
  $msgishtml = -1,
  $errors_to = '',
  $moreinheader = '' 
)

Function sending an email to the current member with the text supplied in parameter.

Parameters
string$textContent of message (not html entities encoded)
string$subjectSubject of message
array$filename_listArray of attached files
array$mimetype_listArray of mime types of attached files
array$mimefilename_listArray of public names of attached files
string$addr_ccEmail cc
string$addr_bccEmail bcc
int$deliveryreceiptAsk a delivery receipt
int$msgishtml1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
string$errors_toerrors to
string$moreinheaderAdd more html headers
Deprecated:
since V18
See also
sendEmail()
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 412 of file adherent.class.php.

◆ sendEmail()

Adherent::sendEmail (   $text,
  $subject,
  $filename_list = array(),
  $mimetype_list = array(),
  $mimefilename_list = array(),
  $addr_cc = "",
  $addr_bcc = "",
  $deliveryreceipt = 0,
  $msgishtml = -1,
  $errors_to = '',
  $moreinheader = '' 
)

Function sending an email to the current member with the text supplied in parameter.

Parameters
string$textContent of message (not html entities encoded)
string$subjectSubject of message
array$filename_listArray of attached files
array$mimetype_listArray of mime types of attached files
array$mimefilename_listArray of public names of attached files
string$addr_ccEmail cc
string$addr_bccEmail bcc
int$deliveryreceiptAsk a delivery receipt
int$msgishtml1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
string$errors_toerrors to
string$moreinheaderAdd more html headers
Since
V18
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 437 of file adherent.class.php.

◆ sendReminderForExpiredSubscription()

Adherent::sendReminderForExpiredSubscription (   $daysbeforeendlist = '10')

Send reminders by emails before subscription end CAN BE A CRON TASK.

Parameters
string$daysbeforeendlistNb of days before end of subscription (negative number = after subscription). Can be a list of delay, separated by a semicolon, for example '10;5;0;-5'
Returns
int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 3008 of file adherent.class.php.

◆ setCategories()

Adherent::setCategories (   $categories)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters
int[] | int$categoriesCategory or categories IDs
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2957 of file adherent.class.php.

◆ setPassword()

Adherent::setPassword (   $user,
  $password = '',
  $isencrypted = 0,
  $notrigger = 0,
  $nosyncuser = 0 
)

Change password of a user.

Parameters
User$userObject user de l'utilisateur qui fait la modification
string$passwordNew password (to generate if empty)
int$isencrypted0 ou 1 if the password needs to be encrypted in the DB (default: 0)
int$notrigger1=Does not raise the triggers
int$nosyncuserDo not synchronize linked user
Returns
string|int Clear password if change ok, 0 if no change, <0 if error

Definition at line 1155 of file adherent.class.php.

◆ setThirdPartyId()

Adherent::setThirdPartyId (   $thirdpartyid)

Set link to a third party.

Parameters
int$thirdpartyidId of user to link to
Returns
int 1=OK, -1=KO

Definition at line 1293 of file adherent.class.php.

◆ setUserId()

Adherent::setUserId (   $userid)

Set link to a user.

Parameters
int$useridId of user to link to
Returns
int 1=OK, -1=KO

Definition at line 1252 of file adherent.class.php.

◆ subscription()

Adherent::subscription (   $date,
  $amount,
  $accountid = 0,
  $operation = '',
  $label = '',
  $num_chq = '',
  $emetteur_nom = '',
  $emetteur_banque = '',
  $datesubend = 0,
  $fk_type = null 
)

Insert subscription into database and eventually add links to banks, mailman, etc...

Parameters
int$dateDate of effect of subscription
double$amountAmount of subscription (0 accepted for some members)
int$accountidId bank account. NOT USED.
string$operationCode of payment mode (if Id bank account provided). Example: 'CB', ... NOT USED.
string$labelLabel operation (if Id bank account provided).
string$num_chqNumero cheque (if Id bank account provided)
string$emetteur_nomName of cheque writer
string$emetteur_banqueName of bank of cheque
int$datesubendDate end subscription
int$fk_typeMember type id
Returns
int rowid of record added, <0 if KO

Definition at line 1635 of file adherent.class.php.

◆ subscriptionComplementaryActions()

Facture null To store the created invoice into Adherent::subscriptionComplementaryActions (   $subscriptionid,
  $option,
  $accountid,
  $datesubscription,
  $paymentdate,
  $operation,
  $label,
  $amount,
  $num_chq,
  $emetteur_nom = '',
  $emetteur_banque = '',
  $autocreatethirdparty = 0,
  $ext_payment_id = '',
  $ext_payment_site = '' 
)

Do complementary actions after subscription recording.

Parameters
int$subscriptionidId of created subscription
string$optionWhich action ('bankdirect', 'bankviainvoice', 'invoiceonly', ...)
int$accountidId bank account
int$datesubscriptionDate of subscription
int$paymentdateDate of payment
string$operationCode of type of operation (if Id bank account provided). Example 'CB', ...
string$labelLabel operation (if Id bank account provided)
double$amountAmount of subscription (0 accepted for some members)
string$num_chqNumero cheque (if Id bank account provided)
string$emetteur_nomName of cheque writer
string$emetteur_banqueName of bank of cheque
int$autocreatethirdpartyAuto create new thirdparty if member not yet linked to a thirdparty and we request an option that generate invoice.
string$ext_payment_idExternal id of payment (for example Stripe charge id)
string$ext_payment_siteName of external paymentmode (for example 'stripe')
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1715 of file adherent.class.php.

◆ update()

Adherent::update (   $user,
  $notrigger = 0,
  $nosyncuser = 0,
  $nosyncuserpass = 0,
  $nosyncthirdparty = 0,
  $action = 'update' 
)

Update a member in database (standard information and password)

Parameters
User$userUser making update
int$notrigger1=disable trigger UPDATE (when called by create)
int$nosyncuser0=Synchronize linked user (standard info), 1=Do not synchronize linked user
int$nosyncuserpass0=Synchronize linked user (password), 1=Do not synchronize linked user
int$nosyncthirdparty0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty
string$actionCurrent action for hookmanager
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 740 of file adherent.class.php.

◆ update_end_date()

Adherent::update_end_date (   $user)

Update denormalized last subscription date.

This function is called when we delete a subscription for example.

Parameters
User$userUser making change
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1011 of file adherent.class.php.

References $sql, and dol_syslog().

◆ validate()

Adherent::validate (   $user)

Function that validate a member.

Parameters
User$useruser adherent qui valide
Returns
int Return integer <0 if KO, 0 if nothing done, >0 if OK

Definition at line 1972 of file adherent.class.php.


The documentation for this class was generated from the following file: