Update to 1.3

README.md

@@ -1,10 +1,34 @@
 nz.co.fuzion.civitoken
 ======================
 
-Fuzion Token extension for CiviCRM, that provides its users extra tokens
-that can be used on a CiviCRM installation. These include tokens to access
-membership data, like membership type, start and end dates, and status. These
-are particularly useful to use on your "fees due" automatic notices.
+Fuzion Token extension for CiviCRM, that provides its users extra tokens. 
+
+These include tokens to access membership data, like membership type, start and end dates, and status. These are particularly useful to use on your "fees due" automatic notices.
+
+By default all tokens are enabled. If you just want some there is a setting page
+(screenshot below).
+
+*A note about country-specific address formatting*
+CiviCRM has a data structure to support country-specific address formatting but
+no inbuilt functionality to support this. 
+
+The data format is that the country table has an address_format_id field. That can
+be used to link to a row in civicrm_address_format which you create with
+a specific format. Currently the only way to create such formats is directly
+in the DB. If, however, you do create those formats, this
+extension will respect them in the address blocks.
+
+*A note about country in the address block*
+
+Several countries postal codes require that the country be excluded if it is a
+domestic posting (if you wish to get bulk postal rates), I am not aware
+of any where the country IS required for domestic. This extension does not
+include the country in the address block if it matches that configured for
+the domain organisation.
+
+
+![list of tokens](docs/token_listing.png)
+![list of tokens2](docs/token_listing_2.png)
 
 
 Installation

ang/civitoken.ang.php

@@ -0,0 +1,24 @@
+<?php
+// This file declares an Angular module which can be autoloaded
+// in CiviCRM. See also:
+// http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules
+
+return array (
+  'js' => 
+  array (
+    0 => 'ang/civitoken.js',
+    1 => 'ang/civitoken/*.js',
+    2 => 'ang/civitoken/*/*.js',
+  ),
+  'css' => 
+  array (
+    0 => 'ang/civitoken.css',
+  ),
+  'partials' => 
+  array (
+    0 => 'ang/civitoken',
+  ),
+  'settings' => 
+  array (
+  ),
+);

ang/civitoken.css

@@ -0,0 +1 @@
+/* Add any CSS rules for Angular module "civitoken" */

ang/civitoken.js

@@ -0,0 +1,6 @@
+(function(angular, $, _) {
+  // Declare a list of dependencies.
+  angular.module('civitoken', [
+    'crmUi', 'crmUtil', 'ngRoute'
+  ]);
+})(angular, CRM.$, CRM._);

ang/civitoken/Setting.html

@@ -0,0 +1,32 @@
+<div class="crm-container">
+  <h1 crm-page-title>{{ts('Enabled CiviTokens')}}</h1>
+
+  <form name="civiTokenForm" crm-ui-id-scope>
+
+    <div>
+      <button class="crm-button" ng-click="save()">{{ts('Save')}}</button>
+    </div>
+
+    <div class="help">
+      <p>{{ts('Select the tokens you wish to enable on this site.')}}</p>
+
+      <p>{{ts('If no tokens are disabled it is considered to be unrestricted (if  you really want none uninstall civitoken).')}}</p>
+    </div>
+
+    <div>
+      <div ng-repeat="(index, setting) in settingOptions">
+        <input
+            type="checkbox"
+            name="selectedTokens"
+            value="{{setting.name}}"
+            ng-model="setting.selected"
+        >
+        <label >{{setting.title}}</label>
+      </div>
+    </div>
+    <div>
+      <button class="crm-button" ng-click="save()">{{ts('Save')}}</button>
+    </div>
+  </form>
+
+</div>

ang/civitoken/Setting.js

@@ -0,0 +1,81 @@
+(function(angular, $, _) {
+
+  angular.module('civitoken').config(function($routeProvider) {
+      $routeProvider.when('/civitoken/settings', {
+        controller: 'CivitokenSetting',
+        templateUrl: '~/civitoken/Setting.html',
+
+        // If you need to look up data when opening the page, list it out
+        // under "resolve".
+        resolve: {
+          existingSettings: function(crmApi) {
+            return crmApi('Setting', 'get', {
+              return: ['civitoken_enabled_tokens'],
+              sequential: true
+            });
+          },
+
+          settingMetaData: function(crmApi) {
+            return crmApi('Setting', 'getfields', {
+            });
+          },
+
+          settingOptions: function(crmApi) {
+            return crmApi('Setting', 'getoptions', {
+              'field' : 'civitoken_enabled_tokens',
+            });
+          }
+
+        }
+      });
+    }
+  );
+
+  // The controller uses *injection*. This default injects a few things:
+  //   $scope -- This is the set of variables shared between JS and HTML.
+  //   crmApi, crmStatus, crmUiHelp -- These are services provided by civicrm-core.
+  //   existingSetting -- The current contact, defined above in config().
+  angular.module('civitoken').controller('CivitokenSetting', function($scope, crmApi, crmStatus, crmUiHelp, existingSettings, settingMetaData, settingOptions) {
+    // The ts() and hs() functions help load strings for this module.
+    var ts = $scope.ts = CRM.ts('civitoken');
+    var hs = $scope.hs = crmUiHelp({file: 'CRM/civitoken/Setting'}); // See: templates/CRM/civitoken/Setting.hlp
+
+    // We don't really use the metadata array very fully yet but my intent
+    // was to make this form fully metadata driven & hence I have not removed the
+    // bits that would help move that way.
+    settingMetaData = settingMetaData['values']['civitoken_enabled_tokens'];
+    settingOptions = settingOptions['values'];
+    existingSettings = existingSettings['values'][0]['civitoken_enabled_tokens'];
+    settingMetaData['options'] = {};
+
+    var optionValues = Object.keys(settingOptions);
+    optionValues.forEach(function(keyName) {
+      settingMetaData['options'][keyName] = {};
+      settingMetaData['options'][keyName]['name'] = keyName;
+      settingMetaData['options'][keyName]['title'] = settingOptions[keyName];
+      settingMetaData['options'][keyName]['selected'] = ($.inArray(keyName, existingSettings) >= 0);
+    });
+    settingOptions = settingMetaData.options;
+
+    // We have existingSetting available in JS. We also want to reference it in HTML.
+    $scope.settingOptions = settingOptions;
+
+    $scope.save = function save() {
+      var selected = {'civitoken_enabled_tokens' : []};
+      optionValues.forEach(function(keyName) {
+        console.log(keyName + settingOptions[keyName]['selected']);
+        if (settingOptions[keyName]['selected']) {
+          selected['civitoken_enabled_tokens'].push(keyName);
+        }
+      });
+      console.log(selected);
+      return crmStatus(
+        // Status messages. For defaults, just use "{}"
+        {start: ts('Saving...'), success: ts('Saved')},
+        // The save action. Note that crmApi() returns a promise.
+        crmApi('Setting', 'create', selected)
+      );
+    };
+  });
+
+})(angular, CRM.$, CRM._);