dolibarr  9.0.0
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:
+ Collaboration diagram for Adherent:

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...
 
 makeSubstitution ($text)
 Make substitution of tags into text with value of current object. More...
 
 getmorphylib ($morphy='')
 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 ($rowid, $user, $notrigger=0)
 Fonction qui supprime l'adherent et les donnees associees. 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='', $ref_ext='', $fetch_optionals=true, $fetch_subscriptions=true)
 Load member from database. More...
 
 fetch_subscriptions ()
 Function to get member subscriptions data 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...
 
 subscription ($date, $amount, $accountid=0, $operation='', $label='', $num_chq='', $emetteur_nom='', $emetteur_banque='', $datesubend=0)
 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)
 Do complementary actions after subscription recording. More...
 
 validate ($user)
 Function that validate a member. More...
 
 resiliate ($user)
 Fonction qui resilie un adherent. 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...
 
 getNomUrl ($withpictoimg=0, $maxlen=0, $option='card', $mode='', $morecss='', $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Retourne le libelle du statut d'un adherent (brouillon, valide, resilie) More...
 
 LibStatut ($statut, $need_subscription, $date_end_subscription, $mode=0)
 Renvoi le libelle d'un statut donne. More...
 
 load_state_board ()
 Charge indicateurs this->nb de tableau de bord. More...
 
 load_board ($user)
 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 attributs LDAP) More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet adherent. 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...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. 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. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 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...
 
 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->contactid 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_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)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $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=false, $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)
 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='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $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)
 Add objects linked in llx_element_element. 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...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 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)
 Function to check if an object is used by others. 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...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 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='')
 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...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. 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...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 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...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. 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...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. 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...
 

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 an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $pass
 Clear password in memory.
 
 $pass_indatabase
 Clear password in database (defined if DATABASE_PWD_ENCRYPTED=0)
 
 $pass_indatabase_crypted
 Encrypted password in database (always defined)
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 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...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage members of a foundation.

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

Constructor & Destructor Documentation

◆ __construct()

Adherent::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

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 2396 of file adherent.class.php.

◆ _load_ldap_info()

Adherent::_load_ldap_info ( )

Initialise tableau info (tableau des attributs LDAP)

Returns
array Tableau info des attributs

Definition at line 2414 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 <0 if KO, >0 if OK

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

◆ create()

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

Create a member into database.

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

Definition at line 376 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 <0 if KO, >0 if OK

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

◆ delete()

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

Fonction qui supprime l'adherent et les donnees associees.

Parameters
int$rowidId of member to delete
User$userUser object
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, 0=nothing to do, >0 if OK

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

◆ fetch()

Adherent::fetch (   $rowid,
  $ref = '',
  $fk_soc = '',
  $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 1181 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 1113 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 1145 of file adherent.class.php.

◆ fetch_subscriptions()

Adherent::fetch_subscriptions ( )

Function to get member subscriptions data 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 <0 si KO, >0 si OK

Definition at line 1321 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$outputlangsobjet 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 2304 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 1994 of file adherent.class.php.

◆ getLibStatut()

Adherent::getLibStatut (   $mode = 0)

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

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

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

◆ getmorphylib()

Adherent::getmorphylib (   $morphy = '')

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

Parameters
string$morphyNature of the adherent (physical or moral)
Returns
string Label

Definition at line 360 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 2577 of file adherent.class.php.

◆ getNomUrl()

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

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)
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, '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
Returns
string Chaine avec URL

Definition at line 2015 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 2668 of file adherent.class.php.

◆ info()

Adherent::info (   $id)

Charge les informations d'ordre info dans l'objet adherent.

Parameters
int$idId of member to load
Returns
void

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

◆ 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
void

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

◆ LibStatut()

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

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
int$need_subscription1 if member type need subscription, 0 otherwise
int$date_end_subscriptionDate fin adhesion
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label

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

◆ load_board()

Adherent::load_board (   $user)

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

Parameters
User$userObjet user
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

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

◆ load_state_board()

Adherent::load_state_board ( )

Charge indicateurs this->nb de tableau de bord.

Returns
int <0 if KO, >0 if OK

Definition at line 2205 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 293 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 2654 of file adherent.class.php.

References CommonObject\commonReplaceThirdparty().

◆ resiliate()

Adherent::resiliate (   $user)

Fonction qui resilie un adherent.

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

Definition at line 1829 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_toerros to
string$moreinheaderAdd more html headers
Returns
int <0 if KO, >0 if OK

Definition at line 248 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 2690 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$categories Category or categories IDs
Returns
void

Definition at line 2610 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 si il faut crypter le mot de passe en base (0 par defaut)
int$notrigger1=Ne declenche pas les triggers
int$nosyncuserDo not synchronize linked user
Returns
string If OK return clear password, 0 if no change, < 0 if error

Definition at line 925 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 1070 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 1036 of file adherent.class.php.

◆ subscription()

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

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
string$operationType of payment (if Id bank account provided). Example: 'CB', ...
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
Returns
int rowid of record added, <0 if KO

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

◆ subscriptionComplementaryActions()

Adherent::subscriptionComplementaryActions (   $subscriptionid,
  $option,
  $accountid,
  $datesubscription,
  $paymentdate,
  $operation,
  $label,
  $amount,
  $num_chq,
  $emetteur_nom = '',
  $emetteur_banque = '',
  $autocreatethirdparty = 0 
)

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
string$autocreatethirdpartyAuto create new thirdparty if member not yet linked to a thirdparty and we request an option that generate invoice.
Returns
int <0 if KO, >0 if OK

Definition at line 1483 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 <0 if KO, >0 if OK

Definition at line 502 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 <0 if KO, >0 if OK

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

◆ validate()

Adherent::validate (   $user)

Function that validate a member.

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

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


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