dolibarr 20.0.0
|
Class to manage members of a foundation. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
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. | |
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. | |
makeSubstitution ($text) | |
Make substitution of tags into text with value of current object. | |
getmorphylib ($morphy='', $addbadge=0) | |
Return translated label by the nature of a adherent (physical or moral) | |
create ($user, $notrigger=0) | |
Create a member into database. | |
update ($user, $notrigger=0, $nosyncuser=0, $nosyncuserpass=0, $nosyncthirdparty=0, $action='update') | |
Update a member in database (standard information and password) | |
update_end_date ($user) | |
Update denormalized last subscription date. | |
delete ($user, $notrigger=0) | |
Fonction to delete a member and its data. | |
setPassword ($user, $password='', $isencrypted=0, $notrigger=0, $nosyncuser=0) | |
Change password of a user. | |
setUserId ($userid) | |
Set link to a user. | |
setThirdPartyId ($thirdpartyid) | |
Set link to a third party. | |
fetch_login ($login) | |
Method to load member from its login. | |
fetch_name ($firstname, $lastname) | |
Method to load member from its name. | |
fetch ($rowid, $ref='', $fk_soc=0, $ref_ext='', $fetch_optionals=true, $fetch_subscriptions=true) | |
Load member from database. | |
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. | |
fetchPartnerships ($mode) | |
Function to get partnerships array. | |
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... | |
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. | |
validate ($user) | |
Function that validate a member. | |
resiliate ($user) | |
Fonction qui resilie un 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. | |
add_to_abo () | |
Function to add member into external tools mailing-list, spip, etc. | |
del_to_abo () | |
Function to delete a member from external tools like mailing-list, spip, etc. | |
getCivilityLabel () | |
Return civility label of a member. | |
getTooltipContentArray ($params) | |
getTooltipContentArray | |
getNomUrl ($withpictoimg=0, $maxlen=0, $option='card', $mode='', $morecss='', $save_lastsearch_value=-1, $notooltip=0, $addlinktonotes=0) | |
Return clicable name (with picto eventually) | |
getLibStatut ($mode=0) | |
Retourne le libelle du statut d'un adherent (brouillon, valide, resilie, exclu) | |
LibStatut ($status, $need_subscription, $date_end_subscription, $mode=0) | |
Renvoi le libelle d'un statut donne. | |
loadStateBoard () | |
Load indicators this->nb in state board. | |
load_board ($user, $mode) | |
Load indicators for dashboard (this->nbtodo and this->nbtodolate) | |
generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null) | |
Create a document onto disk according to template module. | |
initAsSpecimen () | |
Initialise an instance with random values. | |
_load_ldap_dn ($info, $mode=0) | |
Retourne chaine DN complete dans l'annuaire LDAP pour l'objet. | |
_load_ldap_info () | |
Initialise tableau info (tableau des attributes LDAP) | |
info ($id) | |
Load type info information in the member object. | |
getNbOfEMailings () | |
Return number of mass Emailing received by this member with its email. | |
setCategories ($categories) | |
Sets object to supplied categories. | |
hasDelay () | |
Return if a member is late (subscription late) or not. | |
sendReminderForExpiredSubscription ($daysbeforeendlist='10') | |
Send reminders by emails before subscription end CAN BE A CRON TASK. | |
getKanbanView ($option='', $arraydata=null) | |
Return clicable link of object (with eventually picto) | |
Public Member Functions inherited from CommonObject | |
isEmpty () | |
isEmpty We consider CommonObject isEmpty if this->id is empty | |
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. | |
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. | |
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. | |
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. | |
setPaymentMethods ($id) | |
Change the payments methods. | |
setMulticurrencyCode ($code) | |
Change the multicurrency code. | |
setPaymentTerms ($id, $deposit_percent=null) | |
Change the payments terms. | |
setTransportMode ($id) | |
Change the transport mode methods. | |
setRetainedWarrantyPaymentTerms ($id) | |
Change the retained warranty payments terms. | |
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. | |
setBankAccount ($fk_account, $notrigger=0, $userused=null) | |
Change the bank account. | |
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. | |
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='fk_statut') | |
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. | |
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) | |
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) | |
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. | |
call_trigger ($triggerName, $user) | |
Call trigger based on this instance. | |
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) | |
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 fields 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. | |
defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0) | |
Get buy price to use for margin calculation. | |
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. | |
deleteLineCommon (User $user, $idline, $notrigger=0) | |
Delete a line of object in database. | |
setStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
Set to a status. | |
setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
Set to a signed 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. | |
Static Public Member Functions | |
static | replaceThirdparty ($db, $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. | |
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. | |
commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
Common function for all objects extending CommonObject for generating documents. | |
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 members of a foundation.
Definition at line 48 of file adherent.class.php.
Adherent::__construct | ( | $db | ) |
Constructor.
Definition at line 379 of file adherent.class.php.
References status, STATUS_DRAFT, and statut.
Adherent::_load_ldap_dn | ( | $info, | |
$mode = 0 ) |
Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.
array | $info | Info array loaded by _load_ldap_info |
int | $mode | 0=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) |
Definition at line 2715 of file adherent.class.php.
References getDolGlobalString().
Adherent::_load_ldap_info | ( | ) |
Initialise tableau info (tableau des attributes LDAP)
Definition at line 2740 of file adherent.class.php.
References dol_hash(), dol_print_date(), dol_string_nohtmltag(), dolGetLdapPasswordHash(), getArrayOfSocialNetworks(), getDolGlobalString(), getFullName(), and statut.
Adherent::add_to_abo | ( | ) |
Function to add member into external tools mailing-list, spip, etc.
Definition at line 2120 of file adherent.class.php.
References getDolGlobalString().
Adherent::create | ( | $user, | |
$notrigger = 0 ) |
Create a member into database.
User | $user | Object user qui demande la creation |
int | $notrigger | 1 ne declenche pas les triggers, 0 sinon |
Definition at line 608 of file adherent.class.php.
References CommonObject\call_trigger(), dol_buildpath(), dol_now(), dol_syslog(), getDolGlobalString(), isValidEmail(), ref, and update().
Adherent::del_to_abo | ( | ) |
Function to delete a member from external tools like mailing-list, spip, etc.
Definition at line 2172 of file adherent.class.php.
References getDolGlobalString().
Adherent::delete | ( | $user, | |
$notrigger = 0 ) |
Fonction to delete a member and its data.
Definition at line 1061 of file adherent.class.php.
References CommonObject\call_trigger(), CommonObject\deleteExtraFields(), dol_syslog(), and setUserId().
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.
Definition at line 2075 of file adherent.class.php.
References CommonObject\call_trigger(), dol_syslog(), STATUS_EXCLUDED, and statut.
Adherent::fetch | ( | $rowid, | |
$ref = '', | |||
$fk_soc = 0, | |||
$ref_ext = '', | |||
$fetch_optionals = true, | |||
$fetch_subscriptions = true ) |
Load member from database.
int | $rowid | Id of object to load |
string | $ref | To load member from its ref |
int | $fk_soc | To load member from its link to third party |
string | $ref_ext | External reference |
bool | $fetch_optionals | To load optionals (extrafields) |
bool | $fetch_subscriptions | To load member subscriptions |
Definition at line 1392 of file adherent.class.php.
References dol_syslog(), CommonObject\fetch_optionals(), fetch_subscriptions(), ref, status, statut, and type.
Referenced by fetch_login(), and fetch_name().
Adherent::fetch_login | ( | $login | ) |
Method to load member from its login.
string | $login | login of member |
Definition at line 1332 of file adherent.class.php.
References dol_print_error(), and fetch().
Adherent::fetch_name | ( | $firstname, | |
$lastname ) |
Method to load member from its name.
string | $firstname | Firstname |
string | $lastname | Lastname |
Definition at line 1360 of file adherent.class.php.
References dol_print_error(), and fetch().
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.
Definition at line 1542 of file adherent.class.php.
References dol_syslog().
Referenced by fetch().
Adherent::fetchPartnerships | ( | $mode | ) |
Function to get partnerships array.
string | $mode | 'member' or 'thirdparty' |
Definition at line 1607 of file adherent.class.php.
Adherent::generateDocument | ( | $modele, | |
$outputlangs, | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0, | |||
$moreparams = null ) |
Create a document onto disk according to template module.
string | $modele | Force template to use ('' to not force) |
Translate | $outputlangs | object lang a utiliser pour traduction |
int | $hidedetails | Hide details of lines |
int | $hidedesc | Hide description |
int | $hideref | Hide ref |
null | array | $moreparams | Array to provide more information |
Definition at line 2613 of file adherent.class.php.
References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().
Adherent::getCivilityLabel | ( | ) |
Return civility label of a member.
Definition at line 2223 of file adherent.class.php.
Referenced by makeSubstitution().
Adherent::getKanbanView | ( | $option = '', | |
$arraydata = null ) |
Return clicable link of object (with eventually picto)
string | $option | Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
array | $arraydata | Array of data |
Definition at line 3260 of file adherent.class.php.
References getNomUrl(), img_picto(), LibStatut(), Form\showphoto(), and status.
Adherent::getLibStatut | ( | $mode = 0 | ) |
Retourne le libelle du statut d'un adherent (brouillon, valide, resilie, exclu)
int | $mode | 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto |
Reimplemented in WebPortalMember.
Definition at line 2429 of file adherent.class.php.
References LibStatut(), and statut.
Referenced by getTooltipContentArray().
Adherent::getmorphylib | ( | $morphy = '', | |
$addbadge = 0 ) |
Return translated label by the nature of a adherent (physical or moral)
string | $morphy | Nature of the adherent (physical or moral) |
int<0,2> | $addbadge Add badge (1=Full label, 2=First letters only) |
Definition at line 557 of file adherent.class.php.
References dol_strtoupper(), and dolGetFirstLetters().
Referenced by getTooltipContentArray().
Adherent::getNbOfEMailings | ( | ) |
Return number of mass Emailing received by this member with its email.
Definition at line 2927 of file adherent.class.php.
Adherent::getNomUrl | ( | $withpictoimg = 0, | |
$maxlen = 0, | |||
$option = 'card', | |||
$mode = '', | |||
$morecss = '', | |||
$save_lastsearch_value = -1, | |||
$notooltip = 0, | |||
$addlinktonotes = 0 ) |
Return clicable name (with picto eventually)
int | $withpictoimg | 0=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 | $maxlen | length max label |
string | $option | Page 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 | $morecss | Add more css on link |
int | $save_lastsearch_value | -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking |
int | $notooltip | 1=Disable tooltip |
int | $addlinktonotes | 1=Add link to notes |
Reimplemented in WebPortalMember.
Definition at line 2306 of file adherent.class.php.
References dol_escape_htmltag(), dol_string_nohtmltag(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getFullName(), getTooltipContentArray(), img_object(), img_picto(), Form\showphoto(), and statut.
Referenced by getKanbanView().
Adherent::getTooltipContentArray | ( | $params | ) |
getTooltipContentArray
array | $params | params to construct tooltip data |
Reimplemented from CommonObject.
Reimplemented in WebPortalMember.
Definition at line 2241 of file adherent.class.php.
References dol_format_address(), getDolGlobalString(), getFullName(), getLibStatut(), getmorphylib(), img_picto(), ref, and Form\showphoto().
Referenced by getNomUrl().
Adherent::hasDelay | ( | ) |
Return if a member is late (subscription late) or not.
Definition at line 2983 of file adherent.class.php.
Adherent::info | ( | $id | ) |
Load type info information in the member object.
int | $id | Id of member to load |
Definition at line 2891 of file adherent.class.php.
References dol_print_error(), and dol_syslog().
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.
Definition at line 2642 of file adherent.class.php.
References dol_now(), dol_time_plus_duree(), ref, STATUS_DRAFT, statut, and type.
Adherent::LibStatut | ( | $status, | |
$need_subscription, | |||
$date_end_subscription, | |||
$mode = 0 ) |
Renvoi le libelle d'un statut donne.
int | $status | Id status |
int | $need_subscription | 1 if member type need subscription, 0 otherwise |
int | $date_end_subscription | Date fin adhesion |
int | $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 |
Reimplemented in WebPortalMember.
Definition at line 2444 of file adherent.class.php.
References dol_now().
Referenced by getKanbanView(), and getLibStatut().
Adherent::load_board | ( | $user, | |
$mode ) |
Load indicators for dashboard (this->nbtodo and this->nbtodolate)
User | $user | Object user |
string | $mode | "expired" for membership to renew, "shift" for member to validate |
Definition at line 2528 of file adherent.class.php.
References dol_now(), dol_print_error(), img_object(), and STATUS_DRAFT.
Adherent::loadStateBoard | ( | ) |
Load indicators this->nb in state board.
Definition at line 2495 of file adherent.class.php.
References dol_print_error().
Adherent::makeSubstitution | ( | $text | ) |
Make substitution of tags into text with value of current object.
string | $text | Text to make substitution to |
Definition at line 483 of file adherent.class.php.
References complete_substitutions_array(), dol_htmlentitiesbr(), dol_print_date(), dol_textishtml(), getCivilityLabel(), getDolGlobalString(), getFullName(), make_substitutions(), ref, type, and yn().
Referenced by sendEmail().
|
static |
Function used to replace a thirdparty id with another one.
Definition at line 2971 of file adherent.class.php.
References CommonObject\commonReplaceThirdparty().
Adherent::resiliate | ( | $user | ) |
Fonction qui resilie un adherent.
Definition at line 2025 of file adherent.class.php.
References CommonObject\call_trigger(), dol_syslog(), STATUS_RESILIATED, and statut.
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.
string | $text | Content of message (not html entities encoded) |
string | $subject | Subject of message |
array | $filename_list | Array of attached files |
array | $mimetype_list | Array of mime types of attached files |
array | $mimefilename_list | Array of public names of attached files |
string | $addr_cc | Email cc |
string | $addr_bcc | Email bcc |
int | $deliveryreceipt | Ask a delivery receipt |
int | $msgishtml | 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection |
string | $errors_to | errors to |
string | $moreinheader | Add more html headers |
Definition at line 412 of file adherent.class.php.
References dol_syslog(), and 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.
string | $text | Content of message (not html entities encoded) |
string | $subject | Subject of message |
array | $filename_list | Array of attached files |
array | $mimetype_list | Array of mime types of attached files |
array | $mimefilename_list | Array of public names of attached files |
string | $addr_cc | Email cc |
string | $addr_bcc | Email bcc |
int | $deliveryreceipt | Ask a delivery receipt |
int | $msgishtml | 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection |
string | $errors_to | errors to |
string | $moreinheader | Add more html headers |
Definition at line 437 of file adherent.class.php.
References dol_htmlentitiesbr(), dol_syslog(), dol_textishtml(), getDolGlobalString(), and makeSubstitution().
Referenced by send_an_email().
Adherent::sendReminderForExpiredSubscription | ( | $daysbeforeendlist = '10' | ) |
Send reminders by emails before subscription end CAN BE A CRON TASK.
string | $daysbeforeendlist | Nb 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' |
Definition at line 3008 of file adherent.class.php.
References complete_substitutions_array(), dol_concatdesc(), dol_escape_htmltag(), dol_getdate(), dol_mktime(), dol_now(), dol_syslog(), dol_time_plus_duree(), getCommonSubstitutionArray(), getDolGlobalString(), getLanguageCodeFromCountryCode(), CMailFile\getValidAddress(), and make_substitutions().
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.
int[] | int | $categories | Category or categories IDs |
Definition at line 2957 of file adherent.class.php.
Adherent::setPassword | ( | $user, | |
$password = '', | |||
$isencrypted = 0, | |||
$notrigger = 0, | |||
$nosyncuser = 0 ) |
Change password of a user.
User | $user | Object user de l'utilisateur qui fait la modification |
string | $password | New password (to generate if empty) |
int | $isencrypted | 0 ou 1 if the password needs to be encrypted in the DB (default: 0) |
int | $notrigger | 1=Does not raise the triggers |
int | $nosyncuser | Do not synchronize linked user |
Definition at line 1155 of file adherent.class.php.
References CommonObject\call_trigger(), dol_hash(), dol_print_error(), dol_syslog(), and getRandomPassword().
Referenced by update().
Adherent::setThirdPartyId | ( | $thirdpartyid | ) |
Set link to a third party.
int | $thirdpartyid | Id of user to link to |
Definition at line 1293 of file adherent.class.php.
References dol_syslog().
Adherent::setUserId | ( | $userid | ) |
Set link to a user.
int | $userid | Id of user to link to |
Definition at line 1252 of file adherent.class.php.
References dol_syslog().
Referenced by delete().
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...
int | $date | Date of effect of subscription |
double | $amount | Amount of subscription (0 accepted for some members) |
int | $accountid | Id bank account. NOT USED. |
string | $operation | Code of payment mode (if Id bank account provided). Example: 'CB', ... NOT USED. |
string | $label | Label operation (if Id bank account provided). |
string | $num_chq | Numero cheque (if Id bank account provided) |
string | $emetteur_nom | Name of cheque writer |
string | $emetteur_banque | Name of bank of cheque |
int | $datesubend | Date end subscription |
int | $fk_type | Member type id |
Definition at line 1635 of file adherent.class.php.
References dol_now(), dol_time_plus_duree(), CommonObject\setErrorsFromObject(), and update_end_date().
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.
int | $subscriptionid | Id of created subscription |
string | $option | Which action ('bankdirect', 'bankviainvoice', 'invoiceonly', ...) |
int | $accountid | Id bank account |
int | $datesubscription | Date of subscription |
int | $paymentdate | Date of payment |
string | $operation | Code of type of operation (if Id bank account provided). Example 'CB', ... |
string | $label | Label operation (if Id bank account provided) |
double | $amount | Amount of subscription (0 accepted for some members) |
string | $num_chq | Numero cheque (if Id bank account provided) |
string | $emetteur_nom | Name of cheque writer |
string | $emetteur_banque | Name of bank of cheque |
int | $autocreatethirdparty | Auto create new thirdparty if member not yet linked to a thirdparty and we request an option that generate invoice. |
string | $ext_payment_id | External id of payment (for example Stripe charge id) |
string | $ext_payment_site | Name of external paymentmode (for example 'stripe') |
Definition at line 1715 of file adherent.class.php.
References dol_getIdFromCode(), dol_now(), dol_syslog(), get_default_tva(), getDolGlobalInt(), getDolGlobalString(), getFullName(), GETPOST(), GETPOSTISARRAY(), price2num(), CommonObject\setErrorsFromObject(), and Facture\TYPE_STANDARD.
Adherent::update | ( | $user, | |
$notrigger = 0, | |||
$nosyncuser = 0, | |||
$nosyncuserpass = 0, | |||
$nosyncthirdparty = 0, | |||
$action = 'update' ) |
Update a member in database (standard information and password)
User | $user | User making update |
int | $notrigger | 1=disable trigger UPDATE (when called by create) |
int | $nosyncuser | 0=Synchronize linked user (standard info), 1=Do not synchronize linked user |
int | $nosyncuserpass | 0=Synchronize linked user (password), 1=Do not synchronize linked user |
int | $nosyncthirdparty | 0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty |
string | $action | Current action for hookmanager |
Definition at line 740 of file adherent.class.php.
References CommonObject\call_trigger(), clean_url(), dol_syslog(), getDolGlobalString(), CommonObject\insertExtraFields(), isValidEmail(), ref, setPassword(), setUpperOrLowerCase(), statut, and type.
Referenced by create().
Adherent::update_end_date | ( | $user | ) |
Update denormalized last subscription date.
This function is called when we delete a subscription for example.
Definition at line 1011 of file adherent.class.php.
References dol_syslog().
Referenced by subscription().
Adherent::validate | ( | $user | ) |
Function that validate a member.
User | $user | user adherent qui valide |
Definition at line 1972 of file adherent.class.php.
References CommonObject\call_trigger(), dol_now(), dol_syslog(), STATUS_VALIDATED, and statut.