From 20345200910157bb3683aced2a2b5a0da1de3e1f Mon Sep 17 00:00:00 2001 From: Marc Koch Date: Mon, 28 Apr 2025 10:25:44 +0200 Subject: [PATCH] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20civix=20upgrade?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CRM/TwingleCampaign/Upgrader.php | 2 +- CRM/TwingleCampaign/Upgrader/Base.php | 376 ----------------------- info.xml | 7 + mixin/lib/civimix-schema@5.78.beta1.phar | Bin 0 -> 31692 bytes phpunit.xml.dist | 2 +- twinglecampaign.civix.php | 309 +++---------------- twinglecampaign.php | 112 +------ 7 files changed, 56 insertions(+), 752 deletions(-) delete mode 100644 CRM/TwingleCampaign/Upgrader/Base.php create mode 100644 mixin/lib/civimix-schema@5.78.beta1.phar diff --git a/CRM/TwingleCampaign/Upgrader.php b/CRM/TwingleCampaign/Upgrader.php index f103551..10d1e1f 100644 --- a/CRM/TwingleCampaign/Upgrader.php +++ b/CRM/TwingleCampaign/Upgrader.php @@ -11,7 +11,7 @@ use CRM_TwingleCampaign_ExtensionUtil as E; /** * Collection of upgrade steps. */ -class CRM_TwingleCampaign_Upgrader extends CRM_TwingleCampaign_Upgrader_Base { +class CRM_TwingleCampaign_Upgrader extends CRM_Extension_Upgrader_Base { /** * This update function checks whether all custom fields defined in diff --git a/CRM/TwingleCampaign/Upgrader/Base.php b/CRM/TwingleCampaign/Upgrader/Base.php deleted file mode 100644 index c5e6ef0..0000000 --- a/CRM/TwingleCampaign/Upgrader/Base.php +++ /dev/null @@ -1,376 +0,0 @@ -ctx = array_shift($args); - $instance->queue = $instance->ctx->queue; - $method = array_shift($args); - return call_user_func_array(array($instance, $method), $args); - } - - public function __construct($extensionName, $extensionDir) { - $this->extensionName = $extensionName; - $this->extensionDir = $extensionDir; - } - - // ******** Task helpers ******** - - /** - * Run a CustomData file. - * - * @param string $relativePath the CustomData XML file path (relative to this extension's dir) - * @return bool - */ - public function executeCustomDataFile($relativePath) { - $xml_file = $this->extensionDir . '/' . $relativePath; - return $this->executeCustomDataFileByAbsPath($xml_file); - } - - /** - * Run a CustomData file - * - * @param string $xml_file the CustomData XML file path (absolute path) - * - * @return bool - */ - protected static function executeCustomDataFileByAbsPath($xml_file) { - $import = new CRM_Utils_Migrate_Import(); - $import->run($xml_file); - return TRUE; - } - - /** - * Run a SQL file. - * - * @param string $relativePath the SQL file path (relative to this extension's dir) - * - * @return bool - */ - public function executeSqlFile($relativePath) { - CRM_Utils_File::sourceSQLFile( - CIVICRM_DSN, - $this->extensionDir . DIRECTORY_SEPARATOR . $relativePath - ); - return TRUE; - } - - /** - * @param string $tplFile - * The SQL file path (relative to this extension's dir). - * Ex: "sql/mydata.mysql.tpl". - * @return bool - */ - public function executeSqlTemplate($tplFile) { - // Assign multilingual variable to Smarty. - $upgrade = new CRM_Upgrade_Form(); - - $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile; - $smarty = CRM_Core_Smarty::singleton(); - $smarty->assign('domainID', CRM_Core_Config::domainID()); - CRM_Utils_File::sourceSQLFile( - CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE - ); - return TRUE; - } - - /** - * Run one SQL query. - * - * This is just a wrapper for CRM_Core_DAO::executeSql, but it - * provides syntatic sugar for queueing several tasks that - * run different queries - */ - public function executeSql($query, $params = array()) { - // FIXME verify that we raise an exception on error - CRM_Core_DAO::executeQuery($query, $params); - return TRUE; - } - - /** - * Syntatic sugar for enqueuing a task which calls a function in this class. - * - * The task is weighted so that it is processed - * as part of the currently-pending revision. - * - * After passing the $funcName, you can also pass parameters that will go to - * the function. Note that all params must be serializable. - */ - public function addTask($title) { - $args = func_get_args(); - $title = array_shift($args); - $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), - $args, - $title - ); - return $this->queue->createItem($task, array('weight' => -1)); - } - - // ******** Revision-tracking helpers ******** - - /** - * Determine if there are any pending revisions. - * - * @return bool - */ - public function hasPendingRevisions() { - $revisions = $this->getRevisions(); - $currentRevision = $this->getCurrentRevision(); - - if (empty($revisions)) { - return FALSE; - } - if (empty($currentRevision)) { - return TRUE; - } - - return ($currentRevision < max($revisions)); - } - - /** - * Add any pending revisions to the queue. - */ - public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { - $this->queue = $queue; - - $currentRevision = $this->getCurrentRevision(); - foreach ($this->getRevisions() as $revision) { - if ($revision > $currentRevision) { - $title = ts('Upgrade %1 to revision %2', array( - 1 => $this->extensionName, - 2 => $revision, - )); - - // note: don't use addTask() because it sets weight=-1 - - $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), - array('upgrade_' . $revision), - $title - ); - $this->queue->createItem($task); - - $task = new CRM_Queue_Task( - array(get_class($this), '_queueAdapter'), - array('setCurrentRevision', $revision), - $title - ); - $this->queue->createItem($task); - } - } - } - - /** - * Get a list of revisions. - * - * @return array(revisionNumbers) sorted numerically - */ - public function getRevisions() { - if (!is_array($this->revisions)) { - $this->revisions = array(); - - $clazz = new ReflectionClass(get_class($this)); - $methods = $clazz->getMethods(); - foreach ($methods as $method) { - if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) { - $this->revisions[] = $matches[1]; - } - } - sort($this->revisions, SORT_NUMERIC); - } - - return $this->revisions; - } - - public function getCurrentRevision() { - $revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName); - if (!$revision) { - $revision = $this->getCurrentRevisionDeprecated(); - } - return $revision; - } - - private function getCurrentRevisionDeprecated() { - $key = $this->extensionName . ':version'; - if ($revision = CRM_Core_BAO_Setting::getItem('Extension', $key)) { - $this->revisionStorageIsDeprecated = TRUE; - } - return $revision; - } - - public function setCurrentRevision($revision) { - CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision); - // clean up legacy schema version store (CRM-19252) - $this->deleteDeprecatedRevision(); - return TRUE; - } - - private function deleteDeprecatedRevision() { - if ($this->revisionStorageIsDeprecated) { - $setting = new CRM_Core_BAO_Setting(); - $setting->name = $this->extensionName . ':version'; - $setting->delete(); - CRM_Core_Error::debug_log_message("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n"); - } - } - - // ******** Hook delegates ******** - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install - */ - public function onInstall() { - $files = glob($this->extensionDir . '/sql/*_install.sql'); - if (is_array($files)) { - foreach ($files as $file) { - CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file); - } - } - $files = glob($this->extensionDir . '/sql/*_install.mysql.tpl'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeSqlTemplate($file); - } - } - $files = glob($this->extensionDir . '/xml/*_install.xml'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeCustomDataFileByAbsPath($file); - } - } - if (is_callable(array($this, 'install'))) { - $this->install(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall - */ - public function onPostInstall() { - $revisions = $this->getRevisions(); - if (!empty($revisions)) { - $this->setCurrentRevision(max($revisions)); - } - if (is_callable(array($this, 'postInstall'))) { - $this->postInstall(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall - */ - public function onUninstall() { - $files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl'); - if (is_array($files)) { - foreach ($files as $file) { - $this->executeSqlTemplate($file); - } - } - if (is_callable(array($this, 'uninstall'))) { - $this->uninstall(); - } - $files = glob($this->extensionDir . '/sql/*_uninstall.sql'); - if (is_array($files)) { - foreach ($files as $file) { - CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file); - } - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable - */ - public function onEnable() { - // stub for possible future use - if (is_callable(array($this, 'enable'))) { - $this->enable(); - } - } - - /** - * @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable - */ - public function onDisable() { - // stub for possible future use - if (is_callable(array($this, 'disable'))) { - $this->disable(); - } - } - - public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) { - switch ($op) { - case 'check': - return array($this->hasPendingRevisions()); - - case 'enqueue': - return $this->enqueuePendingRevisions($queue); - - default: - } - } - -} diff --git a/info.xml b/info.xml index 0a4a89a..727eb0a 100644 --- a/info.xml +++ b/info.xml @@ -26,8 +26,15 @@ + CRM/TwingleCampaign + 24.09.1 + + menu-xml@1.0.0 + smarty@1.0.3 + + CRM_TwingleCampaign_Upgrader diff --git a/mixin/lib/civimix-schema@5.78.beta1.phar b/mixin/lib/civimix-schema@5.78.beta1.phar new file mode 100644 index 0000000000000000000000000000000000000000..079ec3621bbf0b61249d15b6934ec3a0ac19dc65 GIT binary patch literal 31692 zcmd^IOLHViQXU>_tTn~~SZvwD8ZkmlmU^VB>F$|jt!Db6mP$QE>(MJ!&%-29N>!z# zq^mM(GP9)C_Vf<`GyVk}IKTn8U~u6A#vP6vFypWW#&3Yn-Q$&6S(19T7Y@j*TdK?m z4-a<_e?^4XCl4oQlUx1%r>mR2{@Tvgv+ibRx3ToGdida1Zbd)$&O5*K&O7h?D*oY5 z{X?H7VR1G}!(nqA#z_+(9{%Dx@BH20{N#jw|M&Rs|M5?B`|qJ~o()>7(;^**MLc*u zInBahlu@T|eOEfs@4qO%e`Y%UvhK9Lx!`)c$gN}?<*Ql9XiDQQo?|NVQ14@~<{m1m!yZJ-(pA>+EL8GyrcxBQj>1dQ*~Df%QW!?%@5I%pk_(&N@R%mJ)5#OIi> z&zs}nt-~cS8SMD{EJ~DcD^5r>BRnVe!S!zil9RQK|L^a-xjiC3VmvLU? zjedW7b*r=YY;~>E?-Kwmp0e=lx(Jq*)GH8b-iU%!rIQ}{H51`LBcO9JFa0(pcxt&ZC$WWThpPC(0 zri1yIKFYpoK*qr(wKyQ;WY#qAVwxptE;CjhH~_lm#{iG1D=fKDKZK^F7X2(b1>K{p zhVT|b0J(X6OVr1$EA+=S7o~F0i}K>2o1BMvd>)a^-M)QG-DXNI%;@L^brFw7YLG?H zHoVA&=$@sQEPZ=F+EfMUl$;<;b0URkAaxSsscIbgygpiLs&1jeQJyN&Dfvn|4Ilwht7XyToh&>|$d zcJh6@(y+`RGsN1tO?e#@m%S{E3u&&PMeuh>nmjJLx&b6Xiy#Yx0u6R1L_Svj!)O$p zk_bSBF3hrHL8Y0HKN=qRWUfPvoe6oQvoDmzbFFuU5pM5rqL+3mPu5Qx2Q!~mS(xb4c@@u zg~4tu9m5vIVuBmB&`a1Vtnngf(w9aCD9(v#d(&2O;(kjaHt= zUB~}-g=1{Hh@`SOV4?mtftA^pO=N{W>(cVq*7n597D+t6_mYb zyUHH0f+ILvg02I;0RKsv31FilplHTs;NTv=N_9;UAGrf;M39RF=AU zKP64Z>ZPj7NLwhDAsOqD*6!jYIK2i$IxpKQnAM{J;m5vPMUMsykriS^=|P6f0xzqd zibZh9Ew$A{?YF!luvnh(p5r0ZJE@NSLsqUL>+eS6NpUHfapl2)7_=W)FC#eg6vm=` zO!|jZX-V6_)J=T3;u(!Ac9qfu!f`mEX?xAeuN2dv|-1;-5#ZbQ+quNDo7MbUSEgJPhY`d+@vS(8yj}#)wyr7^> zW`QW5@ZoTh+(7s_m1TXEa-iil-wFJKPSqvK%Gw_EnG3It=nY)%Y#00Vx z4%(?dhKlxAzSwYH#|s(@?Foo7N0>gxlO;&a1rl%i(M-`kfjrgA5Rq{=;h^JWis&lh zz?fqbWFU?agIua{I;0?A#t$c-^>`X1HjLp@BRRmM0bq`ZIMTs%7M;f&AF77MIfZe_ zRGv;VL;=J+sK^k8VrB#b5R*<5V1l?U%!aUH&=XZ(h#3QL#aUR8dW#1IdPwqt=Lhqj z4AC7>1f>;BEE=)-QH$fKI7^4L@#Q%yh4l!$pzwW7G7J2WD2pKMU2^WOkXg^+vx`dP zAIT;-F62mvpkh5Cf={7Eb@FR@R(?ckY=Z5TtfANK_A755uYndhCUFr^(9Yc=v1?O#{a(EU!LG$0}vs$b^7t z5oPnvB802DL#$OGL}36;pn^g1GH7c7mM09vKGR-Feehy!9Ep|}yX;QkHjbUesfk>S zM_x8+2-(Ag0vaTD;?qQ78FCanH27b(5ov1TsKz$Z8XTpr7!3^ppC-elg_`JwbFT{~ z4+C>GO*paeBU(}%t+R>?AxMM)>>enma)_sPaUP2BO=|XsOL4oJ& zH33sB_;i|&E?3ybb_fa&|SG=>D2`5sznFbm8m@RH*GS@2<+ zyhxzO>$o7Ko+Hdqe@>WtLxNhdAY|ppjcPXLT{ZX<(Kk=UV$n5@vnMVE5T)oKF=B<7jQW0nK_QB@vCF zreA3d{Z>h3l&caGEkWK5l&W^zUw?dqB)G|S-zaB{y~nqoB?i!$ym0UFx@vGv_@Vl! z`O%&Cm*(Y$**w9BvSZHaIKTrtz>jJG(eG0dyvU}50=8E;Mk0eplQhRKqyh)+HoKz; zs~^FmA*W{pyGI?EY;?RSxDifvEqI?0Aq{;n1TS$DpiAa;UHYPU;hNCUVA zpCTGc;reoJIYhw1JESm7G@T3H$KkAeniy+`)NxEZ4GNAFHW#ANP#j_agU3Zi4#UBQ z4x^Je0U%?g)J2#fn{|p!0M6(PFCpJZ8q+{yY?%(UCw_d%QvoN{;VM{^iK!QM{&7McmXg)*82e-Z_pg_;1J9qf0tGrZOkq*G{*pK zh4p)7k^!~xs&)$3(*ez;HmpPxk3FaXqsW8ry}W`ufoF_zH!Dw z+Xp?Yh4J2dNO-e@Oxdpe0DK-reHnl!^-%I))i(-Wqt_$gV2I~nw_YC2=jGf9KEsKO zS?2PBV8N@Ko-dX{Y2uZhmFvn9%kWFgGJL3S=qGxuEu!q=wG7(~kE0PU5R%n$vQm#Z zhf(_h&KN|aK1&(4y&pcbOXjC1@OqRFvRF1h-WV_Jo0`sV53e4nL>;oeVg)vjJU*i# zkJRrC<<9PYV?}LJey*)>%44KW%e--A{eUg$sZ5&U3k`ZM% z28vh`Fkc?;2iSo^GJ$3*R5Z^MenRA=pJ~Dxok5lR*dSixw@;Re_AcbJ0FW$;QH(M% z%PF&&T_pfkRCzXK1I^}Bbh6HmFA9WwUw&&h?r=Yl0ZU5yrd>SqK!;1p2-QsPrf{#F z{p@Jv>1%QWKQSJZa5FxYhqN{HzJvlr4**a|5ZnN$28iaXFFGdnI3r zpza5hn(lK0Y=(lC(C^+=m`4-X5S)){EElppYJTC80GBu^MK6eIX>1|R# zYPiWhjzaQ5IMSu}`5>eSiE%CktPYd>8MxUZUK%3ph66(lgiUl1-~-2341{oGz`F?~ zp3&%p$-hAk|7Mh&7H9K_Xb^F@T1bp6NACS`IBDSEL4i~(HZG%=a-1Sqrd>?i-tBaW zM)KVH{a_rv95Ev366EoZBl?Y_9!T9I1)Gi#masm>p~uXhnCBaMtU6%W22ckVSODt2WMeMysQa-$n+R z=yRwf93kQ42tG^-8?9qWLc4`H1G@*VH8f(5*KYE9acECoOTOd#yrI1o#3q@z_O{)4HUi4A=GK_s!hw*(7p2Od~z-dCJK& zyTAqzIWpjqwT9NQr?a`ufOf|<=h?7ajgzL|q5Ar3MC+!bMcKYa)I0Oi;9RS3ZBMiA z;Z~8@Kv@`0TFi`K@siPJPdrtF1ySJayD>VxZZbIOCSK9d4vKFao>6%bRq$MZA`(rXfjyzsimM6fo=z=oo3q0||#g4@4H< zWtB(}Ma%aoxGNbd+oOb!6I}bgLIn5xp$hH<7%!0Mg$8pP%do*Pl4I1q2yVTU8;Y79 zvJPg}L|OJtW4MIUQu~HgV51b-$@s?-C=-p@;FbtdZh}<92i6MBkzd^-qTFnOWbPb^ znr#LIYPmSu(#*q7-|_Ggt>lCxQFdpuWEGR1jNBN7FIo0*nTeMRpU=b(k6v1ZfyB z5#dI_p(xM}f)>O>j{p7jGlyk#{sd|CWS*>f?<>>u-k4cjBUIR8;>>wfn#_c~_m#1{ zH#ZzhqIsGsM0}CmnK~@*(0nLnc#{XSX9W-sb?$X+0bmpPF+ zSZU47;7w|?7F_nT($oU3 zZfMg^r{e(@GSH1)60$b$S;~AS5KtHE;}y#oN8S5g`VcQP9oa>v1R`%Oxvn;-^m1Q% z-&MpGw$1Ju(6Znpq@+B2glk;O(qf{`EiYE6=q)qhN-NCYx7EHQM}G?g`v^K*l1Ix2 zy`~@G8spu(uNG{(1;Z+8WE2*6V8ZJ?0tDYq3lI?3%k}YHO4+a$C#EDlK4|lLW_Avy zuzw#(F4_=8SW}WYy)n5&35<4|^tFk*%Hxw0jGU`$r7x9HCxp)BnOaXlctI<1pU)OB z1-Px5z2GVT>%|Yk3VS26V+5K2*d)6-g;U*27}G`d5mHT43L|GUr-Q?X0T?DBaigOQ z>sCWl&vG!wWaVGCKjYSKiJkTqLFJ4!M{#BSZ|MqA#K|0}W6`X1fSy({uFTNMYCc!J zffgiYxPq~)K7gYAkh#~C7>bmYi_uA zNXAj%a3*YIh5Suu11NDa7)@~*nW2iPltkoBz&R%Co2?QMTZfr$Z%EWB+rDMvU`&`k zy=B|_5~20{3Gy3q1VdzM{&46#lTy~o2IrxG1|7MgW9FZTa(sYG->0OaKA|-B101oE zYoAE;A6&BWD|nk=R5XN!-xE2W9Rv2#lb z+OyB@NVDGOoz2fW_USztVXL#=eZFO%{y;`~+z2aKz~RgK^;C3PIm% z*~7VAs0Gr|Bv^E17~UO}yKxF-A==~H)Ywf>E)U?;Anokf>jV0df&a)-!VAAh9ktuN z{$6jlyZuD(`NGUPry}hjs>bue*gvou$q~mOaHA0p8l#?tEG8 zpW+hP&G6dT+*$2ax)bGb`T-XmkZmYm!YJb860hyktESxDc7S1HNV6DVwwno#8#BVx z>yy!kSQH2Zkv_-84C1Tjm0zpPX0nQ6V~lLj!iXhgAH1xKOH?zv=>Kg*yK)D3Atg`??s@HFFEE?BI7UbNA+*4oBS50u3_8jFj za21;?Ea?;4Ih_FR8gb%O{-w|72@9bI&|h7D$@kPssK<+VtwU!4H=L^AIae{=g!EC zSVpn_P~DY7uHy=qoB_IeK-^~(VXQy=NM5kn$aCX$%sIRDm~O!#WYONLWGZ}z-|~v{ z0lk#4k<@_O<4wRlZ8cw!l&eKe2CPMxdASfWLs_Ds)xNF=x#n{8-lO{GDA}>bcLz{N zi8y3b75v1+$rpUNjqVp)owoWiozkT<6xkZ$5-u*RO)2t0nJ>A?L24t5c)7M_t|_38 zP~J?Goc-LFP>gfUZNA>l`c4~uDm-b_Dhg2#h%T|~%0zM@3_!@0Y0*_{{9U~)0W4%I zMsKo#j$|9S{s8+YI23~&pq~v|gc8+Y;=AK==Ug*A$8wkF%G@8Pl1p-s*uOlkRhX3@ zqbfW&KJI=(gvQ`B2>vi8Quz)GMQ%v=v+}{c!R)fJ*8QwYHgkP%Tih|vhH2|;PQhA? zAd%&TP?2JGS4DVPPtyHct+la=wSlQK;vA@M;shgIA2?s=2I zqRP1-0!CxIZc*>o6iO(sE$PVME5#G&t~+JK&0SN>)2$|BbbNwg>3Pag8v~C};Fx{S zr_g+(BZ>hNsH?)}LoUbN!h$knRx#L|VZ}^m0XI0P_T~XGu!_ghYDVALRx%kviM*nysu|tM=jwPAaLTn&ikjwC>EQ}xXo;ePt_&b{C%J~9DYFOH zqJaWoV-%V?rW?3)f)z);!J12`LgYT6I{<+MH8R?tf=;@|%b5hgPfXF8A&z-XE}L`j zd|mD6Kx^zqr&C;Hrzj~yT?rgiX{v23K)$?mSDn(93X~WsG%k+!?;PsVcu0ZLEa76W zI2_j^6*jqYqBzO4ei&d~84r>SlR1+}m+?1> zmKHOZb}Hx6%z|PvVzF>j{2qHL<;CzgCnbV~?Fu=f&}V0@x3l|Yf3Ndwb$1ni!p{J= z!9h9+CPf`VBm6MXJ~A?4-hfipg+h#yFyN7-li@wB$f~_+sZ0QGW$0kX37FJ~O5@;$-%N;D*$X6mdPESz$63LAf97rw5 zn}aSx^&oxynYRkPfTQx712`Md`5pOJ{_PgjE^=|}Yu zgpO1{j|#ft;&p~Z{3Wi7V{M-xOJ!jK6vLq|Xw00?bgG^3K z&>{t4@p)VPf~3^dW3BPOIIME!$hbe8XM|f-c4N5eDIJg?uW+^#_WFnLR8U+x9C0LE z=`8`FF>G?*j-g=wY+yBY0xlg$$*$;SNUEthh9ctIdD2{$Gc%BAgRBIng%n!r;^Lx} zqpnci0>UlnpSSc7CT~%KCr29MJf-EyyF9mn8SQP8KMcJG88U=1HJYJG5vAi|%t}5z zL49#5UxTD<6QuYjBFZ#=ji#S#C^XOw3$PL8%vafM#N#8X^ z!$tYK+yvvobK;Z4Qlm0B>X&h9)$>snrTBx`Vk4%|( zY!Aq2nv3MU3D0yU4Vc2ep22~8Ndl#k7xoj)I;X?4GNi_pXQN?i;9_omW%}@Jx!CCVuU_%M>(Ak>Hv2z{Ia1U}a|41G?cvD|!8TQCQgP z^wh@AE_Um;`%gPx_SZh`tUcYk|G~#7P%TXSMpCk{zPs~G^;REmc2svmb-w8C_4d@! zE6q52SL^kW8%PphhD`G?yW=|Cj1V_S@%vika)$rd$8|>%t@szL`miftD%+H0a*=m= zQFoq7*?ZC>-P{fX?229jLT$Z7aWbJpyXTgI+dI9hsEC5IiK3#fyy9?#P9F(dSmx(Y zxNa6&KT~M$V>!Fjb!TKzX2E&W)9@^%}8dIKJxh$kL}3?#MB(2#Z_vqP=qW?y*nc^d&8^$ zPO>rmO%yV zEH9{VH622MYBYzm=s>A=h?j0jy6vlZ47OFZG>S<3AW;tg6TpJ!+ua`_3gZix*h7P^ z>29xgzEDSwAV&@V8yPgaJc96cb(vkp;y6)ruEtztRW|U|#i$(+y&65W`VFjxaqMoO z+VOp7on38S>hv0$4KYbrTBHr(x&*81>mX^>9?(SE$ zI@);JpLK%zo?bKFm?#uq<1IP!PWo;^?RGXgyPfT|4m>Lo<%$*AFkzY2a0b~q6QDJ6 z)PO87A?h1r?=m=ieY9kiZ_V|9`kwd(AF6R#RBuO?iA87m)y}qB?`(G9{alHQ2l2Is zkI@z-z`CTKV~de&X|xze!-+h+HmTEvPz}n zb`BI%YHeq8le|PrC)>wRL}rFVAG^Bli#Zxh*+&f z;k)Qg!-4%4JS4V|LZz>eqFT#XY4}Pu4a>Iu-uX{8{z*=(W+JvM-;GBa{(fW+Td zCf;hz-1UxJ`QB$~@__|jvZp|M>yot9N6p{GSX}D{=b&+76*-9Ugsb5rCFjm+qm&J{ zkCDtJJlT^VbjmJ@hmG3vVV4!3Wv3j&+u2h57*fil^|=vx3Tmds&Is9%;-_sPjgbvcH)#698zz$ zTa&^Vbq5B%6RlH^ri^}BRP>yna{?0WlGIThW5Nf3Xi7H)WXPgH(`|fQ4?wb;y)2$` z?J(Ft?u(mKGZI}C#Y;2@@%@^8+C-Uc1y_3Q`7Uf-uTMwE_j;>a&&(Gsk}V{!oJ7FW zuog*CutL330cWohgz(1lYiK=Jb_1BNjn(IySQThvMwt<0|FBazje3KmlvyTMWQ%N$ zg|3THg49*PHfJqn@|loAadJ2jW>L219-iQ4iv;1LmLa*mU(DyB=`ITP5lYDm`VvFB zhk$%PHrjAEW*OUF`WsaB)&{5dXZ>e!1Z~2gvYdHAtzmcUfR3-@KUBv-^<&(WiF5k_ z3mzLY{sU+=8Krs8mQyRF%e z?-M5T+}+upD}q4gb2=Gi>9az2hhSVmNPN2mEH6zEV}WGYg~|Cu!9(505b>eL55RhC zm?Qc+6#6z6e3L9r`OxatcR&xF55C>mnZhkXxxa|jM^$k*i%P3Y?+Ouh^>*rRP;*^SbMVI1STnrWk# zM0oXC_xv6}9LXWbCe0b1qCPTpgfl}lN&^(b>4}Z#Sl#{L?uXd_=O2K_6)mzhgx8q9 zwU%~?qZ6>0zXWtL&Ckd=Vb2QEkepi75KNfw8}=(W*2o=a2A=29n(5$*5HlW&R?PMw zWxA*iUm>?cK+$Su!pM2`;GpQua|+JsZ>{RJCR*rhKk06F?sxH(ArLmB0n2iO?{+bY z02sWsT*h;Q@@uub^LZZ`>8;h?{q-;LmAl - + ./tests/phpunit diff --git a/twinglecampaign.civix.php b/twinglecampaign.civix.php index 575f31e..31e9480 100644 --- a/twinglecampaign.civix.php +++ b/twinglecampaign.civix.php @@ -24,7 +24,7 @@ class CRM_TwingleCampaign_ExtensionUtil { * Translated text. * @see ts */ - public static function ts($text, $params = []) { + public static function ts($text, $params = []): string { if (!array_key_exists('domain', $params)) { $params['domain'] = [self::LONG_NAME, NULL]; } @@ -41,7 +41,7 @@ class CRM_TwingleCampaign_ExtensionUtil { * 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) { + public static function url($file = NULL): string { if ($file === NULL) { return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/'); } @@ -75,49 +75,62 @@ class CRM_TwingleCampaign_ExtensionUtil { return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix); } + /** + * @return \CiviMix\Schema\SchemaHelperInterface + */ + public static function schema() { + if (!isset($GLOBALS['CiviMixSchema'])) { + pathload()->loadPackage('civimix-schema@5', TRUE); + } + return $GLOBALS['CiviMixSchema']->getHelper(static::LONG_NAME); + } + } use CRM_TwingleCampaign_ExtensionUtil as E; +pathload()->addSearchDir(__DIR__ . '/mixin/lib'); +spl_autoload_register('_twinglecampaign_civix_class_loader', TRUE, TRUE); + +function _twinglecampaign_civix_class_loader($class) { + if ($class === 'CRM_TwingleCampaign_DAO_Base') { + if (version_compare(CRM_Utils_System::version(), '5.74.beta', '>=')) { + class_alias('CRM_Core_DAO_Base', 'CRM_TwingleCampaign_DAO_Base'); + // ^^ Materialize concrete names -- encourage IDE's to pick up on this association. + } + else { + $realClass = 'CiviMix\\Schema\\Twinglecampaign\\DAO'; + class_alias($realClass, $class); + // ^^ Abstract names -- discourage IDE's from picking up on this association. + } + return; + } + + // This allows us to tap-in to the installation process (without incurring real file-reads on typical requests). + if (strpos($class, 'CiviMix\\Schema\\Twinglecampaign\\') === 0) { + // civimix-schema@5 is designed for backported use in download/activation workflows, + // where new revisions may become dynamically available. + pathload()->loadPackage('civimix-schema@5', TRUE); + CiviMix\Schema\loadClass($class); + } +} + /** * (Delegated) Implements hook_civicrm_config(). * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config */ -function _twinglecampaign_civix_civicrm_config(&$config = NULL) { +function _twinglecampaign_civix_civicrm_config($config = NULL) { static $configured = FALSE; if ($configured) { return; } $configured = TRUE; - $template =& CRM_Core_Smarty::singleton(); - - $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; - $extDir = $extRoot . 'templates'; - - if (is_array($template->template_dir)) { - array_unshift($template->template_dir, $extDir); - } - else { - $template->template_dir = [$extDir, $template->template_dir]; - } - + $extRoot = __DIR__ . DIRECTORY_SEPARATOR; $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); set_include_path($include_path); -} - -/** - * (Delegated) Implements hook_civicrm_xmlMenu(). - * - * @param $files array(string) - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu - */ -function _twinglecampaign_civix_civicrm_xmlMenu(&$files) { - foreach (_twinglecampaign_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { - $files[] = $file; - } + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -127,35 +140,7 @@ function _twinglecampaign_civix_civicrm_xmlMenu(&$files) { */ function _twinglecampaign_civix_civicrm_install() { _twinglecampaign_civix_civicrm_config(); - if ($upgrader = _twinglecampaign_civix_upgrader()) { - $upgrader->onInstall(); - } -} - -/** - * Implements hook_civicrm_postInstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall - */ -function _twinglecampaign_civix_civicrm_postInstall() { - _twinglecampaign_civix_civicrm_config(); - if ($upgrader = _twinglecampaign_civix_upgrader()) { - if (is_callable([$upgrader, 'onPostInstall'])) { - $upgrader->onPostInstall(); - } - } -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall - */ -function _twinglecampaign_civix_civicrm_uninstall() { - _twinglecampaign_civix_civicrm_config(); - if ($upgrader = _twinglecampaign_civix_upgrader()) { - $upgrader->onUninstall(); - } + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -163,188 +148,9 @@ function _twinglecampaign_civix_civicrm_uninstall() { * * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable */ -function _twinglecampaign_civix_civicrm_enable() { +function _twinglecampaign_civix_civicrm_enable(): void { _twinglecampaign_civix_civicrm_config(); - if ($upgrader = _twinglecampaign_civix_upgrader()) { - if (is_callable([$upgrader, 'onEnable'])) { - $upgrader->onEnable(); - } - } -} - -/** - * (Delegated) Implements hook_civicrm_disable(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable - * @return mixed - */ -function _twinglecampaign_civix_civicrm_disable() { - _twinglecampaign_civix_civicrm_config(); - if ($upgrader = _twinglecampaign_civix_upgrader()) { - if (is_callable([$upgrader, 'onDisable'])) { - $upgrader->onDisable(); - } - } -} - -/** - * (Delegated) Implements hook_civicrm_upgrade(). - * - * @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 - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade - */ -function _twinglecampaign_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - if ($upgrader = _twinglecampaign_civix_upgrader()) { - return $upgrader->onUpgrade($op, $queue); - } -} - -/** - * @return CRM_TwingleCampaign_Upgrader - */ -function _twinglecampaign_civix_upgrader() { - if (!file_exists(__DIR__ . '/CRM/TwingleCampaign/Upgrader.php')) { - return NULL; - } - else { - return CRM_TwingleCampaign_Upgrader_Base::instance(); - } -} - -/** - * Search directory tree for files which match a glob pattern. - * - * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. - * Note: Delegate to CRM_Utils_File::findFiles(), this function kept only - * for backward compatibility of extension code that uses it. - * - * @param string $dir base dir - * @param string $pattern , glob pattern, eg "*.txt" - * - * @return array - */ -function _twinglecampaign_civix_find_files($dir, $pattern) { - return CRM_Utils_File::findFiles($dir, $pattern); -} - -/** - * (Delegated) Implements hook_civicrm_managed(). - * - * Find any *.mgd.php files, merge their content, and return. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed - */ -function _twinglecampaign_civix_civicrm_managed(&$entities) { - $mgdFiles = _twinglecampaign_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'] = E::LONG_NAME; - } - if (empty($e['params']['version'])) { - $e['params']['version'] = '3'; - } - $entities[] = $e; - } - } -} - -/** - * (Delegated) Implements hook_civicrm_caseTypes(). - * - * Find any and return any files matching "xml/case/*.xml" - * - * Note: This hook only runs in CiviCRM 4.4+. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes - */ -function _twinglecampaign_civix_civicrm_caseTypes(&$caseTypes) { - if (!is_dir(__DIR__ . '/xml/case')) { - return; - } - - foreach (_twinglecampaign_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { - $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)); - throw new CRM_Core_Exception($errorMessage); - } - $caseTypes[$name] = [ - 'module' => E::LONG_NAME, - 'name' => $name, - 'file' => $file, - ]; - } -} - -/** - * (Delegated) Implements hook_civicrm_angularModules(). - * - * Find any and return any files matching "ang/*.ang.php" - * - * Note: This hook only runs in CiviCRM 4.5+. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules - */ -function _twinglecampaign_civix_civicrm_angularModules(&$angularModules) { - if (!is_dir(__DIR__ . '/ang')) { - return; - } - - $files = _twinglecampaign_civix_glob(__DIR__ . '/ang/*.ang.php'); - foreach ($files as $file) { - $name = preg_replace(':\.ang\.php$:', '', basename($file)); - $module = include $file; - if (empty($module['ext'])) { - $module['ext'] = E::LONG_NAME; - } - $angularModules[$name] = $module; - } -} - -/** - * (Delegated) Implements hook_civicrm_themes(). - * - * Find any and return any files matching "*.theme.php" - */ -function _twinglecampaign_civix_civicrm_themes(&$themes) { - $files = _twinglecampaign_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. - * - * The documentation for glob() says, "On some systems it is impossible to - * distinguish between empty match and an error." Anecdotally, the return - * result for an empty match is sometimes array() and sometimes FALSE. - * This wrapper provides consistency. - * - * @link http://php.net/glob - * @param string $pattern - * - * @return array - */ -function _twinglecampaign_civix_glob($pattern) { - $result = glob($pattern); - return is_array($result) ? $result : []; + // Based on , this does not currently require mixin/polyfill.php. } /** @@ -363,8 +169,8 @@ function _twinglecampaign_civix_insert_navigation_menu(&$menu, $path, $item) { if (empty($path)) { $menu[] = [ 'attributes' => array_merge([ - 'label' => CRM_Utils_Array::value('name', $item), - 'active' => 1, + 'label' => $item['name'] ?? NULL, + 'active' => 1, ], $item), ]; return TRUE; @@ -428,26 +234,3 @@ function _twinglecampaign_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $par } } } - -/** - * (Delegated) Implements hook_civicrm_alterSettingsFolders(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders - */ -function _twinglecampaign_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; - 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 _twinglecampaign_civix_civicrm_entityTypes(&$entityTypes) { - $entityTypes = array_merge($entityTypes, []); -} diff --git a/twinglecampaign.php b/twinglecampaign.php index 04ff8ca..282f7cb 100644 --- a/twinglecampaign.php +++ b/twinglecampaign.php @@ -422,7 +422,6 @@ function _validateAndSendInput($id, $campaign_type_id): bool { return TRUE; } - ///** // * ## Implements hook_civicrm_post(). // * @@ -458,14 +457,7 @@ function _validateAndSendInput($id, $campaign_type_id): bool { // } //} -/** - * Implements hook_civicrm_xmlMenu(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu - */ -function twinglecampaign_civicrm_xmlMenu(&$files) { - _twinglecampaign_civix_civicrm_xmlMenu($files); -} + /** * Implements hook_civicrm_install(). @@ -476,24 +468,6 @@ function twinglecampaign_civicrm_install() { _twinglecampaign_civix_civicrm_install(); } -/** - * Implements hook_civicrm_postInstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall - */ -function twinglecampaign_civicrm_postInstall() { - _twinglecampaign_civix_civicrm_postInstall(); -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall - */ -function twinglecampaign_civicrm_uninstall() { - _twinglecampaign_civix_civicrm_uninstall(); -} - /** * Implements hook_civicrm_enable(). * @@ -503,90 +477,6 @@ function twinglecampaign_civicrm_enable() { _twinglecampaign_civix_civicrm_enable(); } -/** - * Implements hook_civicrm_disable(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable - */ -function twinglecampaign_civicrm_disable() { - _twinglecampaign_civix_civicrm_disable(); -} - -/** - * Implements hook_civicrm_upgrade(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade - */ -function twinglecampaign_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - return _twinglecampaign_civix_civicrm_upgrade($op, $queue); -} - -/** - * Implements hook_civicrm_managed(). - * - * Generate a list of entities to create/deactivate/delete when this module - * is installed, disabled, uninstalled. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed - */ -function twinglecampaign_civicrm_managed(&$entities) { - _twinglecampaign_civix_civicrm_managed($entities); -} - -/** - * Implements hook_civicrm_caseTypes(). - * - * Generate a list of case-types. - * - * Note: This hook only runs in CiviCRM 4.4+. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes - */ -function twinglecampaign_civicrm_caseTypes(&$caseTypes) { - _twinglecampaign_civix_civicrm_caseTypes($caseTypes); -} - -/** - * Implements hook_civicrm_angularModules(). - * - * Generate a list of Angular modules. - * - * Note: This hook only runs in CiviCRM 4.5+. It may - * use features only available in v4.6+. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules - */ -function twinglecampaign_civicrm_angularModules(&$angularModules) { - _twinglecampaign_civix_civicrm_angularModules($angularModules); -} - -/** - * Implements hook_civicrm_alterSettingsFolders(). - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders - */ -function twinglecampaign_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - _twinglecampaign_civix_civicrm_alterSettingsFolders($metaDataFolders); -} - -/** - * Implements hook_civicrm_entityTypes(). - * - * Declare entity types provided by this module. - * - * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes - */ -function twinglecampaign_civicrm_entityTypes(&$entityTypes) { - _twinglecampaign_civix_civicrm_entityTypes($entityTypes); -} - -/** - * Implements hook_civicrm_thems(). - */ -function twinglecampaign_civicrm_themes(&$themes) { - _twinglecampaign_civix_civicrm_themes($themes); -} - // --- Functions below this ship commented out. Uncomment as required. --- /**