Rubicon or Delaware Building Software Which Crosses Rivers

Size: px

Start display at page:

Download "Rubicon or Delaware Building Software Which Crosses Rivers"

Hilda Gilbert
5 years ago
Views:

1 Rubicon or Delaware Building Software Which Crosses Rivers Tim Otten IRC: totten

2 Good Morning

3 Agenda Background & example Notable APIs and Services Extension development - demo Core development - demo

4 Background: Geopolitics Munroe, Randall. Online Communities 2. (

5 Background: Geopolitics joomla.org wordpress.com drupal.org

6 Example: Add tags to the <HEAD> joomla.org "JFactory::getDocument() ->addcustomtag" wordpress.com "add_action( 'wp_head', 'my_callback'');" drupal.org "drupal_add_html_head"

7 Background: Nomads and the Plains Uncredited. Kyrgyz Nomads via wikipedia.org

8 Example: Add to <HEAD> (Polyglot) CiviCRM'ish: $system->addhtmlhead("<script type='text/javascript' src='/civicrm/goodstuff.js'></script>");

9 Example: Add to <HEAD> (Polyglot) CiviCRM'ish: $system->addhtmlhead("<script type='text/javascript' src='/civicrm/goodstuff.js'></script>"); CiviCRM'ish (How it works): class CRM_Utils_System { abstract function addhtmlhead($head); } class CRM_Utils_System_Joomla extends... { function addhtmlhead($head) { $document = JFactory::getDocument(); $document->addcustomtag($string); } }

10 Example: Add to <HEAD> (Polyglot) class CRM_Utils_System_WordPress... { protected $htmlheadbuffer = ''; function addhtmlhead($head) { $this->registered = FALSE; if (!$this->registered) { add_action('wp_head', array($this, '_showhtmlhead')); // front-end views add_action('admin_head', array($this, '_showhtmlhead')); // back-end views } $this->htmlheadbuffer.= $head; } function _showhtmlhead() { return $this->htmlheadbuffer; } }

11 Background: Julius and the Rubicon Ridpath, John Clark Cyclopedia of Universal History(Cincinnati, OH: The Jones Brothers Publishing CO., 1885). Via etc.usf.edu.

12 Example: Add to <HEAD> (Breaking the Rules) Drupal Joomla WordPress What Civi Does drupal_add_html_head( "<script src=..." ) JFactory::getDocument() ->addcustomtag( "<script src=..." ) add_action( 'wp_head', 'my_callback'); function my_callback() { return "<script src=..."; } What CMS Says You Should Do drupal_add_js(...) JFactory::getDocument() ->addscript(...) add_action( 'wp_enqueue_scripts', 'my_callback''); function my_callback() { wp_register_script(...); wp_enqueue_script(...); } Benefits of Doing It the CMS Way Aggregate JS/CSS files Compress CSS files Cache Compiled JS/CSS files Internationalization Weights Aggregate JS (inline) (Plugin) Minimize JS (Plugin) Minimize JS files (Plugin) Aggregate JS/CSS files [No caching] Dependencies Unregistration Source: Coleman Watts, Donald Lobo

13 Background: George and the Delaware Leutze, Emanuel. Washington Crossing the Delaware (1851). Via wikipedia.org

14 Example: Add to <HEAD> (Freedom, etal) $system->addhtmlhead( Any CMS Any page of any CMS (Frontend, Backend; Civibased or CMS-based) Any package type Same ordering Localization "<script type='text/javascript'>...</script>"); CRM_Core_Resources::singleton() ->addscriptfile('civicrm', 'js/my-script.js') ->addstylefile('civicrm', 'css/my-style.css') ;

15 Next: Key APIs

16 Notable APIs Bridges Initialize, Invoke, Bootstrap URLs Resources, Titles Users, Permissions Hooks (et al) Shared Code Pages, Forms, Templates API v3 DAOs, BAOs DB Upgrades Profiles Scheduler/Cron (et al)

17 Notable APIs: CRM_Core_Resources Add Javascript CRM_Core_Resources::singleton()->addScriptFile(' com.example.foo ', 'bar.js'); CRM_Core_Resources::singleton()->addScript('alert("Hello")'); {crmscript ext= com.example.foo file=bar.js} Add stylesheets CRM_Core_Resources::singleton()->addStyleFile(' com.example.foo ', 'bar.css'); CRM_Core_Resources::singleton()->addStyle(' body { background: black; } '); {crmstyle ext= com.example.foo file=bar.css} Add images, sounds, etc CRM_Core_Resources::singleton()->getUrl(' com.example.foo ', 'bar.png'); {crmresurl ext= com.example.foo file=bar.png}

18 Notable APIs: CRM_Core_Region CRM_Core_Region::instance('page-header')->add(array( 'markup' => '<p class="example">hello!</p>', )); CRM_Core_Region::instance('page-header')->add(array( 'markup' => '<p class="example">hello!</p>', 'weight' => -5, )); CRM_Core_Region::instance('page-header')->add(array( 'template' => 'CRM/Myextension/mytemplatefile.tpl', )); CRM_Core_Region::instance('page-header')->update('default', array( 'disabled' => TRUE, ));

19 Notable APIs: hook_civicrm_managed /** * Declare a report which should be activated whenever this module is enabled */ function modulename_civicrm_managed(&$entities) { $entities[] = array( 'module' => 'com.example.modulename', 'name' => 'myreport', 'entity' => 'ReportTemplate', 'params' => array( 'version' => 3, 'label' => 'Example Report', 'description' => 'Longish description of the example report', 'class_name' => 'CRM_Modulename_Report_Form_Sybunt', 'report_url' => 'mymodule/mysbunt', 'component' => 'CiviContribute', ), ); }

20 Next: Extension development

21 Extension: In-App UI

22 Extension: Directory

23 Extension: Evolution Version Themes 1.x API v1/v2 Custom Template Dir / Custom PHP Dir Drupal Modules

24 Extension: Evolution Version Themes 1.x API v1/v2 Custom Template Dir, Custom PHP Dir Drupal Modules 2.x Custom Searches, Custom Reports 3.x CiviCRM Payment, Report, and Search Extensions API v3 Joomla Plugins

25 Extension: Evolution Version Themes 1.x API v1/v2 Custom Template Dir / Custom PHP Dir Drupal Modules 2.x Custom Searches / Custom Reports 3.x CiviCRM Payment, Report, and Search Extensions API v3 Joomla Plugins 4.x CiviCRM Module Extension Civix Extension Directory

26 Extension: The Big Matrix

27 Extension: The Medium Matrix Platform Package Type CiviCRM APIs CMS APIs Civix Distribution CiviCRM (Any CMS) Extension (Module) APIv3, Hooks, BaseClasses, Templates None Yes civicrm.org (browse) Drupal Module APIv3, Hooks, BaseClasses*, Templates* CRUD, Hooks, etc No drupal.org (upload / url) Joomla Extension (Plugin) APIv3, Hooks, BaseClasses*, Templates* CRUD, Events, etc No joomla.org (upload / url) WordPress Plugin APIv3 [More IP?] CRUD, Actions, Filters, etc No wordpress.org (browse)

28 Extension: Quickstart Configure paths Administer => System Settings => Directories Administer => System Settings => Resource URLs Install civix Generate a page civix generate:module -h civix generate:page -h See Also: Tutorial on creating & publishing extensions

29 Extension: Log IP for Every Change Description: Record and display the IP address submitting every database change Init module Record log data Create SQL table Insert into SQL table during hook_civicrm_post Display log data Create page Add page as tab

30 Next: Core development

31 Core development Github Jenkins

32 Core development: Quickstart Setup repos Install CiviCRM from tarball Gitify Fork Create branch / pull-request Make branch Code Submit pull request Tutorial on using Github & CiviCRM

33 Core development: Remove old REST code

34 Further Reading Tutorial on creating & publishing extensions Reference on APIs, hooks, etc (Alt) CiviCRM developer tools Tutorial on using Github & CiviCRM

35 eof Tim Otten IRC: totten

Manually Using Cpanel

How To Install Plugin Joomla 2.5 Template Manually Using Cpanel From here you can install your Templates, Plugins, Modules, Components and Simply select the template folder on your PC and upload it to