Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Extensions
checksum
Commits
04ff9b99
Commit
04ff9b99
authored
Jul 08, 2020
by
mattwire
Browse files
Add recurring self-service links
parent
7dba799f
Changes
10
Hide whitespace changes
Inline
Side-by-side
.github/FUNDING.yml
0 → 100644
View file @
04ff9b99
# These are supported funding model platforms
github
:
mattwire
CRM/Checksum/Form/Checksum.php
View file @
04ff9b99
<?php
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* Form controller class
*
* @see https://wiki.civicrm.org/confluence/display/CRMDOC/QuickForm+Reference
* Class CRM_Checksum_Form_Checksum
*/
class
CRM_Checksum_Form_Checksum
extends
CRM_Core_Form
{
public
function
buildQuickForm
()
{
$contactId
=
CRM_Utils_Array
::
value
(
'cid'
,
$_GET
,
0
);
$this
->
assign
(
'contactId'
,
$contactId
);
$this
->
assign
(
'checksumExpiryDays'
,
Civi
::
settings
()
->
get
(
'checksum_timeout'
));
$this
->
assign
(
'userFramework'
,
CRM_Core_Config
::
singleton
()
->
userFramework
);
if
(
!
empty
(
$contactId
))
{
$cs
=
CRM_Contact_BAO_Contact_Utils
::
generateChecksum
(
$contactId
);
$this
->
assign
(
'checksum'
,
$cs
);
}
if
(
!
empty
(
$contactId
))
{
$recurs
=
civicrm_api3
(
'ContributionRecur'
,
'get'
,
[
'contact_id'
=>
$contactId
]);
foreach
(
CRM_Utils_Array
::
value
(
'values'
,
$recurs
)
as
$recur
)
{
if
(
!
empty
(
$recur
[
'payment_processor_id'
]))
{
}
}
}
//$payment = new CRM_Core_Payment_Dummy();
//$payment->subscriptionURL(NULL, NULL, 'cancel');
$this
->
addButtons
(
array
(
array
(
'type'
=>
'submit'
,
...
...
README.md
View file @
04ff9b99
# uk.co.mjwconsult.checksum
Access to checksum functionality via API and contact record in CiviCRM
Access to checksum functionality via API and contact record in CiviCRM
.
## API functions
| Function | Parameters | Returns |
| ------------- | ------------- | ------------- |
| Function | Parameters | Returns |
| ------------- | ------------- | ------------- |
| ContactChecksum.generate | id=contactId | values['checksum'] |
| ContactChecksum.validate | id=contactId,checksum=checksum | values['checksum'] = true/false |
| ContactChecksum.gettimeoutdays | | values['days'] |
## Contact actions
A new action "Contact Checksum" loads a form with examples of how to use the checksum in emails etc:


.
## Recurring contributions
Example self-service links (for the current logged-in user) are available on the recurring contribution
detail view: !
[
Recur self-service links
](
docs/images/recur_checksum.png
)
These are the same as the links that are available in recurring receipt emails.
checksum.civix.php
View file @
04ff9b99
...
...
@@ -2,10 +2,87 @@
// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
/**
* The ExtensionUtil class provides small stubs for accessing resources of this
* extension.
*/
class
CRM_Checksum_ExtensionUtil
{
const
SHORT_NAME
=
"checksum"
;
const
LONG_NAME
=
"uk.co.mjwconsult.checksum"
;
const
CLASS_PREFIX
=
"CRM_Checksum"
;
/**
* Translate a string using the extension's domain.
*
* If the extension doesn't have a specific translation
* for the string, fallback to the default translations.
*
* @param string $text
* Canonical message text (generally en_US).
* @param array $params
* @return string
* Translated text.
* @see ts
*/
public
static
function
ts
(
$text
,
$params
=
[])
{
if
(
!
array_key_exists
(
'domain'
,
$params
))
{
$params
[
'domain'
]
=
[
self
::
LONG_NAME
,
NULL
];
}
return
ts
(
$text
,
$params
);
}
/**
* Get the URL of a resource file (in this extension).
*
* @param string|NULL $file
* Ex: NULL.
* Ex: 'css/foo.css'.
* @return string
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
*/
public
static
function
url
(
$file
=
NULL
)
{
if
(
$file
===
NULL
)
{
return
rtrim
(
CRM_Core_Resources
::
singleton
()
->
getUrl
(
self
::
LONG_NAME
),
'/'
);
}
return
CRM_Core_Resources
::
singleton
()
->
getUrl
(
self
::
LONG_NAME
,
$file
);
}
/**
* Get the path of a resource file (in this extension).
*
* @param string|NULL $file
* Ex: NULL.
* Ex: 'css/foo.css'.
* @return string
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
*/
public
static
function
path
(
$file
=
NULL
)
{
// return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
return
__DIR__
.
(
$file
===
NULL
?
''
:
(
DIRECTORY_SEPARATOR
.
$file
));
}
/**
* Get the name of a class within this extension.
*
* @param string $suffix
* Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
* @return string
* Ex: 'CRM_Foo_Page_HelloWorld'.
*/
public
static
function
findClass
(
$suffix
)
{
return
self
::
CLASS_PREFIX
.
'_'
.
str_replace
(
'\\'
,
'_'
,
$suffix
);
}
}
use
CRM_Checksum_ExtensionUtil
as
E
;
/**
* (Delegated) Implements hook_civicrm_config().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_config
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_config
*/
function
_checksum_civix_civicrm_config
(
&
$config
=
NULL
)
{
static
$configured
=
FALSE
;
...
...
@@ -23,7 +100,7 @@ function _checksum_civix_civicrm_config(&$config = NULL) {
array_unshift
(
$template
->
template_dir
,
$extDir
);
}
else
{
$template
->
template_dir
=
array
(
$extDir
,
$template
->
template_dir
)
;
$template
->
template_dir
=
[
$extDir
,
$template
->
template_dir
]
;
}
$include_path
=
$extRoot
.
PATH_SEPARATOR
.
get_include_path
();
...
...
@@ -35,7 +112,7 @@ function _checksum_civix_civicrm_config(&$config = NULL) {
*
* @param $files array(string)
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_xmlMenu
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_xmlMenu
*/
function
_checksum_civix_civicrm_xmlMenu
(
&
$files
)
{
foreach
(
_checksum_civix_glob
(
__DIR__
.
'/xml/Menu/*.xml'
)
as
$file
)
{
...
...
@@ -46,7 +123,7 @@ function _checksum_civix_civicrm_xmlMenu(&$files) {
/**
* Implements hook_civicrm_install().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_install
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_install
*/
function
_checksum_civix_civicrm_install
()
{
_checksum_civix_civicrm_config
();
...
...
@@ -58,12 +135,12 @@ function _checksum_civix_civicrm_install() {
/**
* Implements hook_civicrm_postInstall().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_postInstall
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_postInstall
*/
function
_checksum_civix_civicrm_postInstall
()
{
_checksum_civix_civicrm_config
();
if
(
$upgrader
=
_checksum_civix_upgrader
())
{
if
(
is_callable
(
array
(
$upgrader
,
'onPostInstall'
)
))
{
if
(
is_callable
(
[
$upgrader
,
'onPostInstall'
]
))
{
$upgrader
->
onPostInstall
();
}
}
...
...
@@ -72,7 +149,7 @@ function _checksum_civix_civicrm_postInstall() {
/**
* Implements hook_civicrm_uninstall().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_uninstall
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_uninstall
*/
function
_checksum_civix_civicrm_uninstall
()
{
_checksum_civix_civicrm_config
();
...
...
@@ -84,12 +161,12 @@ function _checksum_civix_civicrm_uninstall() {
/**
* (Delegated) Implements hook_civicrm_enable().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_enable
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_enable
*/
function
_checksum_civix_civicrm_enable
()
{
_checksum_civix_civicrm_config
();
if
(
$upgrader
=
_checksum_civix_upgrader
())
{
if
(
is_callable
(
array
(
$upgrader
,
'onEnable'
)
))
{
if
(
is_callable
(
[
$upgrader
,
'onEnable'
]
))
{
$upgrader
->
onEnable
();
}
}
...
...
@@ -98,13 +175,13 @@ function _checksum_civix_civicrm_enable() {
/**
* (Delegated) Implements hook_civicrm_disable().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_disable
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_disable
* @return mixed
*/
function
_checksum_civix_civicrm_disable
()
{
_checksum_civix_civicrm_config
();
if
(
$upgrader
=
_checksum_civix_upgrader
())
{
if
(
is_callable
(
array
(
$upgrader
,
'onDisable'
)
))
{
if
(
is_callable
(
[
$upgrader
,
'onDisable'
]
))
{
$upgrader
->
onDisable
();
}
}
...
...
@@ -116,10 +193,11 @@ function _checksum_civix_civicrm_disable() {
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
*
* @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
* @return mixed
* based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_upgrade
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_upgrade
*/
function
_checksum_civix_civicrm_upgrade
(
$op
,
CRM_Queue_Queue
$queue
=
NULL
)
{
if
(
$upgrader
=
_checksum_civix_upgrader
())
{
...
...
@@ -140,22 +218,23 @@ function _checksum_civix_upgrader() {
}
/**
* Search directory tree for files which match a glob pattern
* Search directory tree for files which match a glob pattern
.
*
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
* Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
*
* @param $dir string, base dir
* @param $pattern string, glob pattern, eg "*.txt"
* @return array(string)
* @param string $dir base dir
* @param string $pattern , glob pattern, eg "*.txt"
*
* @return array
*/
function
_checksum_civix_find_files
(
$dir
,
$pattern
)
{
if
(
is_callable
(
array
(
'CRM_Utils_File'
,
'findFiles'
)
))
{
if
(
is_callable
(
[
'CRM_Utils_File'
,
'findFiles'
]
))
{
return
CRM_Utils_File
::
findFiles
(
$dir
,
$pattern
);
}
$todos
=
array
(
$dir
)
;
$result
=
array
()
;
$todos
=
[
$dir
]
;
$result
=
[]
;
while
(
!
empty
(
$todos
))
{
$subdir
=
array_shift
(
$todos
);
foreach
(
_checksum_civix_glob
(
"
$subdir
/
$pattern
"
)
as
$match
)
{
...
...
@@ -166,7 +245,7 @@ function _checksum_civix_find_files($dir, $pattern) {
if
(
$dh
=
opendir
(
$subdir
))
{
while
(
FALSE
!==
(
$entry
=
readdir
(
$dh
)))
{
$path
=
$subdir
.
DIRECTORY_SEPARATOR
.
$entry
;
if
(
$entry
{
0
}
==
'.'
)
{
if
(
$entry
[
0
]
==
'.'
)
{
}
elseif
(
is_dir
(
$path
))
{
$todos
[]
=
$path
;
...
...
@@ -177,25 +256,27 @@ function _checksum_civix_find_files($dir, $pattern) {
}
return
$result
;
}
/**
* (Delegated) Implements hook_civicrm_managed().
*
* Find any *.mgd.php files, merge their content, and return.
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_managed
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_managed
*/
function
_checksum_civix_civicrm_managed
(
&
$entities
)
{
$mgdFiles
=
_checksum_civix_find_files
(
__DIR__
,
'*.mgd.php'
);
sort
(
$mgdFiles
);
foreach
(
$mgdFiles
as
$file
)
{
$es
=
include
$file
;
foreach
(
$es
as
$e
)
{
if
(
empty
(
$e
[
'module'
]))
{
$e
[
'module'
]
=
'uk.co.mjwconsult.checksum'
;
$e
[
'module'
]
=
E
::
LONG_NAME
;
}
$entities
[]
=
$e
;
if
(
empty
(
$e
[
'params'
][
'version'
]))
{
$e
[
'params'
][
'version'
]
=
'3'
;
}
$entities
[]
=
$e
;
}
}
}
...
...
@@ -207,7 +288,7 @@ function _checksum_civix_civicrm_managed(&$entities) {
*
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_caseTypes
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_caseTypes
*/
function
_checksum_civix_civicrm_caseTypes
(
&
$caseTypes
)
{
if
(
!
is_dir
(
__DIR__
.
'/xml/case'
))
{
...
...
@@ -218,14 +299,13 @@ function _checksum_civix_civicrm_caseTypes(&$caseTypes) {
$name
=
preg_replace
(
'/\.xml$/'
,
''
,
basename
(
$file
));
if
(
$name
!=
CRM_Case_XMLProcessor
::
mungeCaseType
(
$name
))
{
$errorMessage
=
sprintf
(
"Case-type file name is malformed (%s vs %s)"
,
$name
,
CRM_Case_XMLProcessor
::
mungeCaseType
(
$name
));
CRM_Core_Error
::
fatal
(
$errorMessage
);
// throw new CRM_Core_Exception($errorMessage);
throw
new
CRM_Core_Exception
(
$errorMessage
);
}
$caseTypes
[
$name
]
=
array
(
'module'
=>
'uk.co.mjwconsult.checksum'
,
$caseTypes
[
$name
]
=
[
'module'
=>
E
::
LONG_NAME
,
'name'
=>
$name
,
'file'
=>
$file
,
)
;
]
;
}
}
...
...
@@ -236,7 +316,7 @@ function _checksum_civix_civicrm_caseTypes(&$caseTypes) {
*
* Note: This hook only runs in CiviCRM 4.5+.
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_angularModules
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_angularModules
*/
function
_checksum_civix_civicrm_angularModules
(
&
$angularModules
)
{
if
(
!
is_dir
(
__DIR__
.
'/ang'
))
{
...
...
@@ -248,12 +328,31 @@ function _checksum_civix_civicrm_angularModules(&$angularModules) {
$name
=
preg_replace
(
':\.ang\.php$:'
,
''
,
basename
(
$file
));
$module
=
include
$file
;
if
(
empty
(
$module
[
'ext'
]))
{
$module
[
'ext'
]
=
'uk.co.mjwconsult.checksum'
;
$module
[
'ext'
]
=
E
::
LONG_NAME
;
}
$angularModules
[
$name
]
=
$module
;
}
}
/**
* (Delegated) Implements hook_civicrm_themes().
*
* Find any and return any files matching "*.theme.php"
*/
function
_checksum_civix_civicrm_themes
(
&
$themes
)
{
$files
=
_checksum_civix_glob
(
__DIR__
.
'/*.theme.php'
);
foreach
(
$files
as
$file
)
{
$themeMeta
=
include
$file
;
if
(
empty
(
$themeMeta
[
'name'
]))
{
$themeMeta
[
'name'
]
=
preg_replace
(
':\.theme\.php$:'
,
''
,
basename
(
$file
));
}
if
(
empty
(
$themeMeta
[
'ext'
]))
{
$themeMeta
[
'ext'
]
=
E
::
LONG_NAME
;
}
$themes
[
$themeMeta
[
'name'
]]
=
$themeMeta
;
}
}
/**
* Glob wrapper which is guaranteed to return an array.
*
...
...
@@ -264,29 +363,34 @@ function _checksum_civix_civicrm_angularModules(&$angularModules) {
*
* @link http://php.net/glob
* @param string $pattern
* @return array, possibly empty
*
* @return array
*/
function
_checksum_civix_glob
(
$pattern
)
{
$result
=
glob
(
$pattern
);
return
is_array
(
$result
)
?
$result
:
array
()
;
return
is_array
(
$result
)
?
$result
:
[]
;
}
/**
* Inserts a navigation menu item at a given place in the hierarchy.
*
* @param array $menu - menu hierarchy
* @param string $path - path where insertion should happen (ie. Administer/System Settings)
* @param array $item - menu you need to insert (parent/child attributes will be filled for you)
* @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
* 'Mailing', or 'Administer/System Settings'
* @param array $item - the item to insert (parent/child attributes will be
* filled for you)
*
* @return bool
*/
function
_checksum_civix_insert_navigation_menu
(
&
$menu
,
$path
,
$item
)
{
// If we are done going down the path, insert menu
if
(
empty
(
$path
))
{
$menu
[]
=
array
(
'attributes'
=>
array_merge
(
array
(
$menu
[]
=
[
'attributes'
=>
array_merge
(
[
'label'
=>
CRM_Utils_Array
::
value
(
'name'
,
$item
),
'active'
=>
1
,
)
,
$item
),
)
;
]
,
$item
),
]
;
return
TRUE
;
}
else
{
...
...
@@ -297,9 +401,9 @@ function _checksum_civix_insert_navigation_menu(&$menu, $path, $item) {
foreach
(
$menu
as
$key
=>
&
$entry
)
{
if
(
$entry
[
'attributes'
][
'name'
]
==
$first
)
{
if
(
!
isset
(
$entry
[
'child'
]))
{
$entry
[
'child'
]
=
array
()
;
$entry
[
'child'
]
=
[]
;
}
$found
=
_checksum_civix_insert_navigation_menu
(
$entry
[
'child'
],
implode
(
'/'
,
$path
),
$item
,
$key
);
$found
=
_checksum_civix_insert_navigation_menu
(
$entry
[
'child'
],
implode
(
'/'
,
$path
),
$item
);
}
}
return
$found
;
...
...
@@ -310,7 +414,7 @@ function _checksum_civix_insert_navigation_menu(&$menu, $path, $item) {
* (Delegated) Implements hook_civicrm_navigationMenu().
*/
function
_checksum_civix_navigationMenu
(
&
$nodes
)
{
if
(
!
is_callable
(
array
(
'CRM_Core_BAO_Navigation'
,
'fixNavigationMenu'
)
))
{
if
(
!
is_callable
(
[
'CRM_Core_BAO_Navigation'
,
'fixNavigationMenu'
]
))
{
_checksum_civix_fixNavigationMenu
(
$nodes
);
}
}
...
...
@@ -352,17 +456,22 @@ function _checksum_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID)
/**
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
*
* @link http://
wiki
.civicrm.org/
confluence/display/CRMDOC
/hook_civicrm_alterSettingsFolders
* @link http
s
://
docs
.civicrm.org/
dev/en/latest/hooks
/hook_civicrm_alterSettingsFolders
*/
function
_checksum_civix_civicrm_alterSettingsFolders
(
&
$metaDataFolders
=
NULL
)
{
static
$configured
=
FALSE
;
if
(
$configured
)
{
return
;
}
$configured
=
TRUE
;
$settingsDir
=
__DIR__
.
DIRECTORY_SEPARATOR
.
'settings'
;
if
(
is_dir
(
$settingsDir
)
&&
!
in_array
(
$settingsDir
,
$metaDataFolders
))
{
if
(
!
in_array
(
$settingsDir
,
$metaDataFolders
)
&&
is_dir
(
$settingsDir
)
)
{
$metaDataFolders
[]
=
$settingsDir
;
}
}
/**
* (Delegated) Implements hook_civicrm_entityTypes().
*
* Find any *.entityType.php files, merge their content, and return.
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/
function
_checksum_civix_civicrm_entityTypes
(
&
$entityTypes
)
{
$entityTypes
=
array_merge
(
$entityTypes
,
[]);
}
checksum.php
View file @
04ff9b99
<?php
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
require_once
'checksum.civix.php'
;
use
CRM_Checksum_ExtensionUtil
as
E
;
/**
* Implements hook_civicrm_config().
...
...
@@ -132,30 +142,49 @@ function checksum_civicrm_summaryActions(&$actions, $contactID) {
'href'
=>
CRM_Utils_System
::
url
(
'civicrm/contact/checksum/generate'
,
"reset=1&cid=
{
$contactID
}
"
));
}
// --- Functions below this ship commented out. Uncomment as required. ---
/**
* Implements hook_civicrm_preProcess().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess
* hook_civicrm_pageRun
*
function checksum_civicrm_preProcess($formName, &$form) {
} // */
* @param \CRM_Core_Page $page
*/
function
checksum_civicrm_pageRun
(
&
$page
)
{
$fname
=
'checksum_civicrm_pageRun_'
.
$page
->
getVar
(
'_name'
);
if
(
function_exists
(
$fname
))
{
$fname
(
$page
);
}
}
/**
* Implements hook_civicrm_navigationMenu().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
*
function checksum_civicrm_navigationMenu(&$menu) {
_checksum_civix_insert_navigation_menu($menu, NULL, array(
'label' => ts('The Page', array('domain' => 'uk.co.mjwconsult.checksum')),
'name' => 'the_page',
'url' => 'civicrm/the-page',
'permission' => 'access CiviReport,access CiviContribute',
'operator' => 'OR',
'separator' => 0,
));
_checksum_civix_navigationMenu($menu);
} // */
/*
* Display extra info on the recurring contribution view
*/
function
checksum_civicrm_pageRun_CRM_Contribute_Page_ContributionRecur
(
$page
)
{
// get the recurring contribution record or quit
$crid
=
CRM_Utils_Request
::
retrieve
(
'id'
,
'Integer'
,
$page
,
FALSE
);
try
{
$recur
=
civicrm_api3
(
'ContributionRecur'
,
'getsingle'
,
[
'id'
=>
$crid
]);
}
catch
(
CiviCRM_API3_Exception
$e
)
{
return
;
}
$paymentProcessor
=
\
Civi\Payment\System
::
singleton
()
->
getById
(
$recur
[
'payment_processor_id'
]);
$template
=
CRM_Core_Smarty
::
singleton
();
$cancelSubscriptionUrl
=
$paymentProcessor
->
subscriptionURL
(
$recur
[
'id'
],
'recur'
,
'cancel'
);
$updateSubscriptionBillingUrl
=
$paymentProcessor
->
subscriptionURL
(
$recur
[
'id'
],
'recur'
,
'billing'
);
$updateSubscriptionUrl
=
$paymentProcessor
->
subscriptionURL
(
$recur
[
'id'
],
'recur'
,
'update'
);
$checksum
=
'&cs='
.
CRM_Contact_BAO_Contact_Utils
::
generateChecksum
(
$recur
[
'contact_id'
]);
if
(
$cancelSubscriptionUrl
)
{
$template
->
assign
(
'cancelSubscriptionUrl'
,
$cancelSubscriptionUrl
.
$checksum
);
}
if
(
$updateSubscriptionBillingUrl
)
{
$template
->
assign
(
'updateSubscriptionBillingUrl'
,
$updateSubscriptionBillingUrl
.
$checksum
);
}
if
(
$updateSubscriptionUrl
)
{
$template
->
assign
(
'updateSubscriptionUrl'
,
$updateSubscriptionUrl
.
$checksum
);
}
CRM_Core_Region
::
instance
(
'page-body'
)
->
add
([
'template'
=>
'CRM/Checksum/Form/ContributionRecur.tpl'
,
]);
}
docs/checksum_screenshot.png
→
docs/
images/
checksum_screenshot.png
View file @
04ff9b99
File moved
docs/images/recur_checksum.png
0 → 100644
View file @
04ff9b99
45.5 KB
info.xml
View file @
04ff9b99
...
...
@@ -10,15 +10,14 @@
</maintainer>
<urls>
<url
desc=
"Main Extension Page"
>
https://github.com/mattwire/uk.co.mjwconsult.checksum
</url>
<url
desc=
"Support"
>
https://
github.com/mattwire/uk.co.mjwconsult.
checksum
</url>
<url
desc=
"Support"
>
https://
mjw.pt/support/
checksum
</url>
<url
desc=
"Licensing"
>
http://www.gnu.org/licenses/agpl-3.0.html
</url>
</urls>
<releaseDate>
20
18-03-07
</releaseDate>
<version>
1.
1
</version>
<develStage>
beta
</develStage>
<releaseDate>
20
20-07-08
</releaseDate>
<version>
1.
3
</version>
<develStage>
stable
</develStage>
<compatibility>
<ver>
4.7
</ver>
<ver>
4.6
</ver>
<ver>
5.24
</ver>
</compatibility>
<comments>
See:
https://civicrm.stackexchange.com/questions/4683/get-or-generate-a-contact-checksum-via-api,
...
...
templates/CRM/Checksum/Form/Checksum.tpl
View file @
04ff9b99
...
...
@@ -24,14 +24,17 @@
<h3>
An example to include in an email that you send from CiviCRM:
</h3>
<div
class=
"label"
>
A Contribution page
</div><div
class=
"content"
>
{
$contributionUrl
}{
literal
}{
contact
.
contact_id
}
&
{
contact
.
checksum
}{/
literal
}
</div>
<div
class=
"label"
>
A Profile
</div><div
class=
"content"
>
{
$profileUrl
}{
literal
}{
contact
.
contact_id
}
&
{
contact
.
checksum
}{/
literal
}
</div>
{
if
$userFramework
eq
'Drupal'
}
<div
class=
"label"
>
A Webform
</div><div
class=
"content"
>
{
$webformUrl
}{
literal
}{
contact
.
contact_id
}
&
{
contact
.
checksum
}{/
literal
}
</div>
{/
if
}
</div>
<div
class=
"crm-section"
>
<h3>
An example to include in an email that you send via an external email system (you will need to copy/paste separately for each contact as the checksums are different / or include the checksum in your contact export):
</h3>
<div
class=
"label"
>
A Contribution page
</div><div
class=
"content"
>
{
$contributionUrl
}{
$contactId
}
&
cs=
{
$checksum
}
</div>
<div
class=
"label"
>
A Profile
</div><div
class=
"content"
>
{
$profileUrl
}{
$contactId
}
&
cs=
{
$checksum
}
</div>
{
if
$userFramework
eq
'Drupal'
}
<div
class=
"label"
>
A Webform
</div><div
class=
"content"
>
{
$webformUrl
}{
$contactId
}
&
cs=
{
$checksum
}
</div>
{/
if
}
</div>
</div>
{
else
}
...
...
templates/CRM/Checksum/Form/ContributionRecur.tpl
0 → 100644
View file @
04ff9b99
{*
+--------------------------------------------------------------------+