forked from Open-Web-Analytics/Open-Web-Analytics
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathowa_module.php
1215 lines (971 loc) · 33.3 KB
/
owa_module.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
//
// Open Web Analytics - An Open Source Web Analytics Framework
//
// Copyright 2006 Peter Adams. All rights reserved.
//
// Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// $Id$
//
/**
* Abstract Module Class
*
* @author Peter Adams <[email protected]>
* @copyright Copyright © 2006 Peter Adams <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GPL v2.0
* @category owa
* @package owa
* @version $Revision$
* @since owa 1.0.0
*/
abstract class owa_module {
/**
* Name of module
*
* @var string
*/
var $name;
/**
* Description of Module
*
* @var string
*/
var $description;
/**
* Version of Module
*
* @var string
*/
var $version;
/**
* Schema Version of Module
*
* @var string
*/
//var $schema_version = 1;
/**
* Name of author of module
*
* @var string
*/
var $author;
/**
* URL for author of module
*
* @var unknown_type
*/
var $author_url;
/**
* Wiki Page title. Used to generate link to OWA wiki for this module.
*
* Must be unique or else it will could clobber another wiki page.
*
* @var string
*/
var $wiki_title;
/**
* name used in display situations
*
* @var unknown_type
*/
var $display_name;
/**
* Array of event names that this module has handlers for
*
* @var array
*/
var $subscribed_events;
/**
* Array of link information for admin panels that this module implements.
*
* @var array
*/
var $admin_panels;
/**
* Array of navigation links that this module implements
*
* @var unknown_type
*/
var $nav_links;
/**
* Array of metric names that this module implements
*
* @var unknown_type
*/
var $metrics;
/**
* Array of graphs that are implemented by this module
*
* @var array
*/
var $graphs;
/**
* The Module Group that the module belongs to.
*
* This is used often to group a module's features or functions together in the UI
*
* @var string
*/
var $group;
/**
* Array of Entities that are implmented by the module
*
* @var array
*/
var $entities = array();
/**
* Required Schema Version
*
* @var array
*/
var $required_schema_version;
/**
* Available Updates
*
* @var array
*/
var $updates = array();
/**
* Event Processors Map
*
* @var array
*/
var $event_processors = array();
/**
* Dimensions
*
* @var array
*/
var $dimensions = array();
/**
* Dimensions
*
* @var array
*/
var $denormalizedDimensions = array();
/**
*
* @var array
*/
var $formatters = array();
/**
* cli_commands
*
* @var array
*/
var $cli_commands = array();
/**
* API Methods
*
* @var array
*/
var $api_methods = array();
/**
* Controllers
*
* @var array
*/
var $actionControllers = array();
/**
* Update from CLI Required flag
*
* Used by controllers to see if an update error was becuase it needs
* to be applied from the command line instead of via the browser.
*
* @var boolean
*/
var $update_from_cli_required;
/**
* Filesystem path of the module's directory
*/
var $path;
/**
* Constructor
*
*
*/
function __construct() {
$this->path = OWA_MODULES_DIR . $this->name . '/';
//parent::__construct();
/**
* Initial registration calls
*/
$this->init();
/**
* Register Filters
*/
//$this->registerFilters();
/**
* Register Metrics
*/
$this->registerMetrics();
/**
* Register Dimensions
*/
$this->registerDimensions();
/**
* Register CLI Commands
*/
$this->registerCliCommands();
/**
* Register API Methods
*/
$this->registerApiMethods();
/**
* Register Build Packages
*/
$this->registerBuildPackages();
$this->_registerEventHandlers();
$this->_registerEventProcessors();
$this->_registerEntities();
$this->registerActions();
}
function init() {
return false;
}
/**
* Method for registering event processors
*
*/
function _registerEventProcessors() {
return false;
}
/**
* Returns array of admin Links for this module to be used in navigation
*
* @access public
* @return array
*/
function getAdminPanels() {
return $this->admin_panels;
}
/**
* Returns array of report links for this module that will be
* used in report navigation
*
* @access public
* @return array
*/
function getNavigationLinks() {
return $this->nav_links;
}
/**
* Abstract method for registering event handlers
*
* Must be defined by a concrete module class for any event handlers to be registered
*
* @access public
* @return array
*/
function _registerEventHandlers() {
return;
}
/**
* Attaches an event handler to the event queue
*
* @param array $event_name
* @param string $handler_name
* @return boolean
*/
function registerEventHandler($event_name, $handler_name, $method = 'notify', $dir = 'handlers') {
if (!is_object($handler_name)) {
//$handler = &owa_lib::factory($handler_dir,'owa_', $handler_name);
$handler_name = owa_coreAPI::moduleGenericFactory($this->name, $dir, $handler_name, $class_suffix = null, $params = '', $class_ns = 'owa_');
}
$eq = owa_coreAPI::getEventDispatch();
$eq->attach($event_name, array($handler_name, $method));
}
/**
* Hooks a function to a filter
*
* @param array $event_name
* @param string $handler_name
* @return boolean
*/
function registerFilter($filter_name, $handler_name, $method = '', $priority = 10, $dir = 'filters') {
// if it's an object
if ( is_object( $handler_name ) ) {
owa_coreAPI::registerFilter($filter_name, array($handler_name, $method), $priority);
// if it's a static method name
} elseif ( strpos( $handler_name, '::') ) {
owa_coreAPI::registerFilter($filter_name, $handler_name, $priority);
// else try to create the class object
} else {
// create object
if ( ! class_exists( $handler_name ) ) {
//$handler = &owa_lib::factory($handler_dir,'owa_', $handler_name);
$class = owa_coreAPI::moduleGenericFactory($this->name, $dir, $handler_name, $class_suffix = null, $params = '', $class_ns = 'owa_');
}
// register
owa_coreAPI::registerFilter($filter_name, array($class, $method), $priority);
}
}
/**
* Attaches an event handler to the event queue
*
* @param array $event_name
* @param string $handler_name
* @return boolean
* @depricated
*/
function _addHandler($event_name, $handler_name) {
return $this->registerEventHandler($event_name, $handler_name);
}
/**
* Abstract method for registering administration/settings page
*
* @access public
* @return array
*/
function registerAdminPanels() {
return;
}
/**
* Registers an admin panel with this module
*
*/
function registerSettingsPanel($panel) {
$this->admin_panels[] = $panel;
return true;
}
/**
* Registers an admin panel with this module
* @depricated
*/
function addAdminPanel($panel) {
return $this->registerSettingsPanel($panel);
}
/**
* Registers Group Link with a particular View
* @DEPRICATED - use addNavigationSubGroup and addNavigationLinkInSubGroup
*/
function addNavigationLink($group, $subgroup = '', $ref, $anchortext, $order = 0, $priviledge = 'view_reports') {
if (!empty($subgroup)):
$this->addNavigationLinkInSubGroup($subgroup,$ref, $anchortext, $order = 0, $priviledge ,$group);
else:
$this->addNavigationSubGroup($anchortext,$ref, $anchortext, $order = 0, $priviledge ,$group);
endif;
return;
}
/**
* Adds a new Subgroup in the navigation
*
* @param string $subgroupName
* @param string $ref
* @param string $anchortext
* @param integer $order
* @param string $priviledge
* @param string $groupName
*/
public function addNavigationSubGroup($subgroupName, $ref, $anchortext, $order = 0, $priviledge = 'view_reports', $groupName = 'Reports', $icon_class = '') {
$this->nav_links[$groupName][$subgroupName] = $this->getLinkStruct($ref, $anchortext, $order,$priviledge, $icon_class);
}
/**
* Adds a new Link to an existing Subgroup in the navigation
*
* @param string $subgroupName
* @param string $ref
* @param string $anchortext
* @param integer $order
* @param string $priviledge
* @param string $groupName
*/
public function addNavigationLinkInSubGroup($subgroupName, $ref, $anchortext, $order = 0, $priviledge = 'view_reports', $groupName = 'Reports') {
$this->nav_links[$groupName][$subgroupName]['subgroup'][] = $this->getLinkStruct($ref, $anchortext, $order,$priviledge);
}
/**
* Abstract method for registering a module's entities
*
* This method must be defined in concrete module classes in order for entities to be registered.
*/
function _registerEntities() {
return false;
}
function registerNavigation() {
return false;
}
/**
* Registers an Entity
*
* Can take an array of entities or just a single entity as a string.
* Will add an enetiy to the module's entity array. Required for entity installation, etc.
*
* @param $entity_name array or string
*/
function registerEntity($entity_name) {
if (is_array($entity_name)) {
$this->entities = array_merge($this->entities, $entity_name);
} else {
$this->entities[] = $entity_name;
}
}
/**
* Registers Entity
*
* Depreicated see registerEntity
*
* @depricated
*/
function _addEntity($entity_name) {
return $this->registerEntity($entity_name);
}
function getEntities() {
return $this->entities;
}
/**
* Installation method
*
* Creates database tables and sets schema version
*
*/
function install() {
owa_coreAPI::notice('Starting installation of module: '.$this->name);
$errors = '';
// Install schema
if (!empty($this->entities)) {
foreach ($this->entities as $k => $v) {
$entity = owa_coreAPI::entityFactory($this->name.'.'.$v);
//owa_coreAPI::debug("about to execute createtable");
$status = $entity->createTable();
if ($status != true) {
owa_coreAPI::notice("Entity Installation Failed.");
$errors = true;
//return false;
}
}
}
// activate module and persist configuration changes
if ($errors != true) {
// run post install hook
$ret = $this->postInstall();
if ($ret == true) {
owa_coreAPI::notice("Post install procedure was a success.");
} else {
owa_coreAPI::notice("Post install procedure failed.");
}
// save schema version to configuration
owa_coreAPI::persistSetting( $this->name, 'schema_version', $this->getRequiredSchemaVersion() );
//activate the module and save the configuration
$this->activate();
owa_coreAPI::notice("Installation complete.");
return true;
} else {
owa_coreAPI::notice("Installation failed.");
return false;
}
}
/**
* Post installation hook
*
*/
function postInstall() {
return true;
}
function isCliUpdateModeRequired() {
return $this->update_from_cli_required;
}
/**
* Checks for and applies schema upgrades for the module
*
*/
function update() {
// list files in a directory
$files = owa_lib::listDir(OWA_DIR.'modules'.'/'.$this->name.'/'.'updates', false);
//print_r($files);
$current_schema_version = owa_coreAPI::getSetting($this->name, 'schema_version');
// extract sequence
foreach ($files as $k => $v) {
// the use of %d casts the sequence number as an int which is critical for maintaining the
// order of the keys in the array that we are going ot create that holds the update objs
//$n = sscanf($v['name'], '%d_%s', $seq, $classname);
$seq = substr($v['name'], 0, -4);
settype($seq, "integer");
if ($seq > $current_schema_version) {
if ($seq <= $this->required_schema_version) {
$this->updates[$seq] = owa_coreAPI::updateFactory($this->name, substr($v['name'], 0, -4));
// if the cli update mode is required and we are not running via cli then return an error.
owa_coreAPI::debug('cli update mode required: '.$this->updates[$seq]->isCliModeRequired());
if ($this->updates[$seq]->isCliModeRequired() === true && !defined('OWA_CLI')) {
//set flag in module
$this->update_from_cli_required = true;
owa_coreAPI::notice("Aborting update $seq. This update must be applied using the command line interface.");
return false;
}
// set schema version from sequence number in file name. This ensures that only one update
// class can ever be in use for a particular schema version
$this->updates[$seq]->schema_version = $seq;
}
}
}
// sort the array
ksort($this->updates, SORT_NUMERIC);
//print_r(array_keys($this->updates));
foreach ($this->updates as $k => $obj) {
owa_coreAPI::notice(sprintf("Applying Update %d (%s)", $k, get_class($obj)));
$ret = $obj->apply();
if ($ret == true) {
owa_coreAPI::notice("Update Succeeded");
} else {
owa_coreAPI::notice("Update Failed");
return false;
}
}
return true;
}
/**
* Deactivates and removes schema for the module
*
*/
function uninstall() {
return;
}
/**
* Places the Module into the active module list in the global configuration
*
*/
function activate() {
$ret = owa_coreAPI::persistSetting( $this->name, 'is_active', true );
owa_coreAPI::notice("Module $this->name activated");
return $ret;
}
/**
* Deactivates the module by removing it from
* the active module list in the global configuration
*
*/
function deactivate() {
if ($this->name != 'base') {
owa_coreAPI::persistSetting( $this->name, 'is_active', false );
}
}
/**
* Checks to se if the schema is up to date
*
*/
function isSchemaCurrent() {
$current_schema = $this->getSchemaVersion();
$required_schema = $this->getRequiredSchemaVersion();
owa_coreAPI::debug("$this->name Schema version is $current_schema");
owa_coreAPI::debug("$this->name Required Schema version is $required_schema");
if ($current_schema >= $required_schema) {
return true;
} else {
return false;
}
}
function getSchemaVersion() {
$current_schema = owa_coreAPI::getSetting($this->name, 'schema_version');
if (empty($current_schema)) {
$current_schema = 1;
// if this is the base module then we need to let filters know to install the base schema
if ($this->name === 'base') {
// $s = owa_coreAPI::serviceSingleton();
// $s->setInstallRequired();
}
}
return $current_schema;
}
function getRequiredSchemaVersion() {
return $this->required_schema_version;
}
/**
* Registers updates
*
*/
function _registerUpdates() {
return;
}
/**
* Adds an update class into the update array.
* This should be used to within the _registerUpdates method or else
* it will not get called.
*
*/
function _addUpdate($sequence, $class) {
$this->updates[$sequence] = $class;
return true;
}
/**
* Adds an event processor class to the processor array. This is used to determin
* which class to use to process a particular event
*/
function addEventProcessor($event_type, $processor) {
$this->event_processors[$event_type] = $processor;
}
function registerMetric($metric_name, $classes, $params = array(), $label = '', $description = '', $group = '') {
if ( ! $label ) {
$label = $metric_name;
}
if ( ! $description ) {
$description = 'No description available.';
}
if ( ! is_array( $classes ) ) {
$classes = array($classes);
}
foreach ($classes as $class_name) {
$map = array('name' => $metric_name, 'class' => $class_name, 'params' => $params, 'label' => $label, 'description' => $description, 'group' => $group);
$this->metrics[$metric_name][] = $map;
}
}
/**
* Registers a metric definition which is used by the
* resultSetExplorer and getResultSet API methods
*
* This method dynamically creates an owa_metric class and
* properly configures it based on the properties passed in.
*
* Map properties include:
*
* 'name' => '', // the name of the metric as called via the API
* 'label' => '', // the label that will be displayed in result sets
* 'description' => '', // the descript displayed in the GUI
* 'group' => 'unknown', // the group that this metric will belong to in the UI
* 'entity' => '', // the entity to use when calculating this metric
* // you must register the same metric for each entity that
* // it can be calculated on.
* 'metric_type' => '', // 'count', 'distinct_count', 'sum', or 'calculated'
* 'data_type' => '', // 'integrer', 'currency', 'average'
* 'column' => '', // the column of the entity to use when calculating
* 'child_metrics' => array(), // if it's a clculated metric, the child metrics used in the formula.
* 'formula' => '' // if it's a calculated metric, the formula to use (e.g. pageViews / visits).
*
*
*/
function registerMetricDefinition( $params ) {
$map = array(
'name' => '',
'label' => '',
'description' => '',
'group' => 'unknown',
'entity' => '',
'metric_type' => '',
'data_type' => '',
'column' => '',
'child_metrics' => array(),
'formula' => ''
);
$map = array_intersect_key( array_merge( $map, $params ), $map );
if ( ! isset( $map['name'] ) ) {
// throw exception
}
if ( ! isset( $map['label'] ) ) {
$map['label'] = $map['name'];
}
if ( ! isset( $map['entity'] ) ) {
// throw exception
}
if ( ! isset( $map['metric_type'] ) ) {
// throw exception
}
if ( ! isset( $map['data_type'] ) ) {
// throw exception
}
if ( isset( $map['metric_type'] )
&& $map['metric_type'] != 'calculated'
&& ! isset( $map['column'] ) )
{
// throw exception
}
if ( isset( $map['metric_type'] )
&& $map['metric_type'] === 'calculated'
&& ! isset( $map['child_metrics'] ) )
{
// throw exception
}
if ( isset( $map['metric_type'] )
&& $map['metric_type'] === 'calculated'
&& ! isset( $map['formula'] ) )
{
// throw exception
}
$definition = array(
'name' => $map['name'],
'class' => 'base.configurableMetric',
'params' => $map,
'label' => $map['label'],
'description' => $map['description'],
'group' => $map['group']
);
//print_r($definition);
$this->metrics[ $map['name'] ][] = $definition;
}
/**
* Register a dimension
*
* registers a dimension for use by metrics in producing results sets.
*
* @param $dim_name string
* @param $entity_names string||array the names of entity housing the dimension. uses module.name format
* @param $column string the name of the column that represents the dimension
* @param $family string the name of the group or family that this dimension belongs to. optional.
* @param $description string a short description of this metric, used in various interfaces.
* @param $label string the lable of the dimension
* @param $foreign_key_name the name of the foreign key column that should
* be used to relate the metric entity to the dimension's entity.
* If one is not specfied, metrics will use any valid foreign key column they can find.
* Specifying this is important when the same column in a table is used by
* two different dimensions but the meaning of the column differs based on the value of the foreign key.
* a good example is the page_title column in the documents table. It is used by three dimensions:
* pageTitle, entryPageTitle, and existPageTitle.
* @param $denormalized boolean flag marks the dimension as being denormalized into a fact table
* as opposed to being housed in a related table.
*/
function registerDimension(
$dim_name, $entity_names, $column, $label = '', $family,
$description = '', $foreign_key_name = '',
$denormalized = false, $data_type = 'string') {
if ( ! is_array( $entity_names ) ) {
$entity_names = array($entity_names);
}
foreach ($entity_names as $entity) {
$dim = array(
'family' => $family,
'name' => $dim_name,
'entity' => $entity,
'column' => $column,
'label' => $label,
'description' => $description,
'foreign_key_name' => $foreign_key_name,
'data_type' => $data_type,
'denormalized' => $denormalized
);
if ($denormalized) {
$this->denormalizedDimensions[$dim_name][$entity] = $dim;
} else {
$this->dimensions[$dim_name] = $dim;
}
}
}
function registerActions() {
return false;
}
/**
* Registers a Web Action and ontroller Implementation
*
* @param $action_name string the name of the action used as the value in the 'do' url param
* @param $class_name string the name of the controller class
* @param $file string the path to the file housing the class
*
*/
protected function registerAction( $action_name, $class_name, $file ) {
$s = owa_coreAPI::serviceSingleton();
$s->setMapValue( 'actions', $action_name, ['class_name' => $class_name, 'file' => OWA_BASE_MODULE_DIR . $file ] );
}
/**
* Registers a REST API Action and Controller Implementation
*
* Routes are unique to the version/action/request_method combination
*
* @param $version string the version namespace of the route
* @param $route__name string the name of the action used as the value in the 'do' param of the request
* @param $request_method string the HTTP request method.
* @param $class_name string the class name of the controller
* @param $file string the module path to the file housing the class
*
*/
function registerRestApiRoute( $version, $route_name, $request_method, $class_name, $file, $params = [] ) {
if ( $file ) {
$file = $this->path . $file;
}
$s = owa_coreAPI::serviceSingleton();
$s->setRestApiRoute( $this->name, $version, $route_name, $request_method, array( 'class_name' => $class_name, 'file' => $file, 'conf' => $params ) );
}
function registerCliCommand($command, $class) {
$this->cli_commands[$command] = $class;
}
function registerFormatter($type, $formatter) {
$this->formatters[$type] = $formatter;
}
function registerApiMethod($api_method_name, $user_function, $argument_names, $file = '', $required_capability = '') {
$map = array('callback' => $user_function, 'args' => $argument_names, 'file' => $file);
if ($required_capability) {
$map['required_capability'] = $required_capability;
}
$this->api_methods[$api_method_name] = $map;
}
/**
* Registers a Component Implementation
*