From 110277ad51c7df12d87cdb121845867a63e90a00 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sat, 27 Nov 2004 16:24:46 +0000 Subject: [PATCH] added baseModule --- lam/docs/devel/base_module.htm | 74 +++++++++++++++++++++++ lam/docs/devel/images/lam_baseModule.png | Bin 0 -> 5477 bytes lam/docs/devel/index.htm | 2 +- 3 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 lam/docs/devel/base_module.htm create mode 100644 lam/docs/devel/images/lam_baseModule.png diff --git a/lam/docs/devel/base_module.htm b/lam/docs/devel/base_module.htm new file mode 100644 index 00000000..dbb490d4 --- /dev/null +++ b/lam/docs/devel/base_module.htm @@ -0,0 +1,74 @@ + + + + + Base module + + + +

Base module
+

+
base module
+
+

+
The baseModule +is the parent class of all account modules.
+It implements most functions of the module interface and provides +the possibility to use meta data +for the module functions.
+There are also some class variables which are useful for the child +classes.
+
+
+

Meta data

+The baseModule allows you to +not implement the module +interface directly but to provide meta +data which is interpreted by the baseModule.
+If you do not use certain functions of the interface the baseModule also provides dummy +functions. E.g. if your module needs no configuration option you can +just skip this function in your code and the baseModule will tell the +configuration part that there is no option.
+
+To define meta data you have +to implement the function get_metaData(). +This function must return a hash array with the meta options as array +keys.
+Please refer to the module +interface for details about the format of meta data.
+
+
+

Functions
+

+get_scope(): This function +returns the account type ("user", "group", ...) of the module.
+
+For a list of meta data +functions please refer to the module +interface.
+
+
+

Class variables

+$moduleSettings: This variable +contains the configuration settings of all modules.
+$base: This is the name of the +parent accountContainer +($_SESSION[$base]).
+
+
+
+
+
+
+
+
+ + diff --git a/lam/docs/devel/images/lam_baseModule.png b/lam/docs/devel/images/lam_baseModule.png new file mode 100644 index 0000000000000000000000000000000000000000..3ddeee0a6e3bac46d30bcdf99c5149d2df9b6554 GIT binary patch literal 5477 zcmeHL`8U*m`$kittXWF7QqfpHDU5AMQB>A3c1f~~F@`WRL@CB(Ye7Orb`2vtW#6)t z$<`PKjh(S%G#dMNdcJ?b_dLHn-{+V2xnI}0&w1VV^*-lyUH6T%xMRY{E5Xab!NGU) z#x*Mr4z3gIn8eM+{x)Z~^K)>BD&4$hXoGTDp@zPYye`#@{NuOr$y557ZmnR#V_lIO z$sR(0Tc_0S8Cpfh@H&`!3$_R=Gy~7gaUEtUT|9roa7$LqRAK0K@2U8+UPT7aUqNjY z8lb`kXU;u)k$RLmyL=n#<}>dXf~gM8|2+RW!s2tN-gwjgE@rbvuj0L$uI?_sG`H+y z4leF?vBKE#SJD4_NCFf}79Ro#8gOu4;RIsS#7l(O;a`yR-vFNr%4PvA6hv$Ux&uS^ zHTlqejirGF0jxCpijAp3wR}~G#s!gYRNiwii$H(n{}EASbiM7*W8hW$CoCfZe4%6L9;-oSd(V9A! zJbvhG_WUPX4N*Eh_BLbI;7`wB%D8f=T*D_Mvpz>4U2QQHV(xeB9@wJ;sxcAp21N-Z zZ^!y!%zrg%S^SpcKOS;^0<_+Gr$3)ayt8?#;nS5Vg&!6|+*}$wF?{+0fFwZsHpB<) z;NDM~R$X4DFBK9HBJf}VDU?qy@#pN&MY!Up?U^!hl9v;6WMeGTdGOMX!&X8Ztz0fm zhFZ2p_|kL`e+WAvgwXgw4wBSWTQF^`$nk8@1;#Wj-+Y)fT2R#cVe`fUCucktM#XN- zh8NdS`0?p?fmI81zD^Va0+%mGx5j2R&hofk6%j zlyLdpKyupS5#E?%*4cMs^srh16DA1I5(693Kvm6b($La{Iqkt38tCC+$td*d3=aX1 zvJ6}3Ef>-qRkdT5ii)e$(N@eLQ|9H4>*p5i8!HG0hUmMCv!ji-6H642g;ZJ&J-7}7 zFl4ik2UnpWA;I~ml()|bH>Zr8lHz|(S;02G!fe5H{>F3)l&WaFSdVGk9sI#pgV(J< zGmsnkc-AR&-A(=WjnCp4a;lKSYh8XFz5b;5j;UROv@oJtQs42i7u=h^FyVv&!SDF{ zQWPBK3VTh>)E-7YR^cSt&eG^l=0E|5FX$`Su9tW%zF>DPX)5;qEc=k!S|95#1DT#@cbvmIS!b^<0RnIM(bvuhK3&kbs+E-<-Kk;V@_uADb9h69L z!5V==e1e5a&6!U{r&0~amR06s6hI}49k0-o~TawFzOG6}XXj8I(xuB`V6n!|r@w|us4%VII7LlM7|9vO1 zm$mw1f*%Kt>QSyM$u=8E4<89cz3xf6a1Y+nHk9B4_`T(?gl-htV7C%tm!?44g#e*3XM zr%=)u{cbrU(oF?!dO&swbhDdKzuv(B;C`{mn^(x=UTKm}7QO~-tKAu#ut6D1owK*> zUMaZ{*gd6>1vwtYYftvpIdr8gHiwPysReXA|WhNkObUCcEx(?&h5x=5XNFRNE@ z+gp>i$Uk)cOPCy`w2(lkgjwurIU)5XuJ?OSYKai!D0Hy)@}Q zEPO9;FDoF`RrY~#*B18ra77gn~nF)^3 z?5;$&S&mLQO5-)@S)Diwwd}_Z;Z!Skmkh0p_?UOz5=hR^j3>8dZy+p-Tw>;*m8PBE zck_p2`#)`0G!0q=UQZtDT-`qh&5a{KE|!dGkuQ5F_^SGt;}l(~KKLRlfhwooY?OlK z7sT>{g9k|n+|ljWxkWT-xiLroodTvLF{L3vG|=9#U8!ipVXkFRoN6@h=XfpA4pi6# z-_M0NwZ)9A?FenRjhB%8Vu?3;Sjxj|z0q2h7f)jPx2$~oDtzmX9J0)0rs*O{7TUt4}3S+KPDNr>o}!BYQ>Edw!h8AiDvSAKL6AT6n8H2 zbq}}VJBJI++BHgN7Ne#&hk;_m0n>iwxMc81GT@STF|5i{xPI@c_Q4o1os5N$W0>L8 zv9Er^_VbrRXMe(74q+%I4wfl^>9E<4?Z|eu>;kc4qjOVLWE897I02R1? zpdPnP=jg4{0OJ$q`0Gd%4?nh3eayqQgglV#Yiw^CCYBYz%5a{GW_#IGLH5tI$TR=z z8a>%5|3A}Bl!gzl$P|9}TdUqV7S*~fwd2mbo`d3ITSCzfkg-VDw}p%Wsg;o@tI4-J zFf>CkM>8U1UU%PUR%XjpOr4AzKL+mxD#6{;6+n_cKb0KP@h!oX#wDMlWwoo|2$Sf$fcr;@gtZ9LUIrpW|6- z0e{XcoB&K}lo?90-lXeaa=T^yWi-6s=wLLVb9-QuKy3U6!@LDB8lxuhe)0>3f@PD5VwP8i|2Se zUG@zoRf#&;b?emL#xw3N5qovhvDg8d;H(oYo?>G&>quf`-f3scF?`+5(B{Qy`M$ap z9JEKw?xE~f-%D%L-T->%j=2`Ys6|5M-IWg8x5YoHLfxWkNqm;UsE^Xwp01Z2hV#;! zO@m@GYRH@3uW;^D%rpF9_XqnLiTri#9Y^g=pm>yUy?T)8*z>1rU06x4F|ZD}%)dL$ zHJmnNh6trG_Za2}TXgw+d~hNvVDhcHDr-8H@y%>Bt@L1}Y120}%w^|d|C@eVB<>l$ zcn^jk9g^w?pU=7DD=MX82z4Wk8y(FYEmzD+sTc4&IZ}sqc1Bu}<@Oq!u@96dB6g$3 z4SN@!Y);F69IyjL<|*QzL5DijC7^nnyVaiL%CC(Y^<8b)q>_lO0@0=jLtRk#KyApQ zMRW5>WZy`BT?-8nv8Rn%jnjIjt6MLfU0}p+`AX?a=b(j*N)lq08?Q_Yx`0PeG;870 zE3vA3_LQ5>{Yc60Hp)ko)M?lU>_{NyO->4B?g{Vf~vJozf37 z>Q};Abq~4{Q=HL(2WAn{gZ|V<5tG3EO81}rC(;Uhse92V{aVCbTeF?$+dAzViMQdk zj1UAq)I&9=O=@>^Sm)P5>2%VI)FNeA%9e@UPc&-;vmO*g?%g|^D}_i|qI*@OSQuLM z@IT}N2X6NJg0-vMm?yB+T^DT+9s zqc;V1A1a{;~cR#kG^wjmTVy4wjm6EyzWIS@ z^`-JIX%eJ7fOC|d*=u+v`rDGcc%PTv&ht={jN&lst5Jg@lBmuC{aHXb7op!OBa2X; zrx^MI;WzHT)2*H^FQbXr#^GPeMT^@##2q>6@^D*eeV1YF87s5$JbY;>-H&_ES5q>K zA{gL=Mo};^nUBhms6EA!U4X6W9u!^=+mO+3TKL_4d%9CoCb)CTOlGv6uyjUF<6{Y4 z_J(43x`^}SKa)3ik3DZc+IjqI>jQ~`;xff!?|(<<_M5sxt4K&cNBYk#*a32E7u&=l zMuDmNwFh~lJ3}Kz)wZE7OPM;J-lR;;r>Ek*wW=!)7B}*f!_!Y3xH*DpT^p=5&|Jo`#}XMJw&l7JnOpWn;1dtn zny-xOaXAtBuUm%Xc^i9QI=1J1n&GG%dl*9=mheCfz-gPWp8CagHccZh;;(Ka z*t$Kr=EK=>xHaal%jI1zjH#Ane%~$7Vs+LO3hnBmduB9bkw(^7yz^8nZ*T h1^Rg8KMQ1m)j&vNtH;9v?DZ+f&Fgor5wG5j{2y8YtHS^Q literal 0 HcmV?d00001 diff --git a/lam/docs/devel/index.htm b/lam/docs/devel/index.htm index 1be5d5c4..0a6cee3e 100644 --- a/lam/docs/devel/index.htm +++ b/lam/docs/devel/index.htm @@ -71,7 +71,7 @@ lists

Configuration files:

    -
  • Base module
    +
  • Base module
  • Account modules
  • PDF templates