hook_civicrm_alterAPIPermissions - clean up after content import

Fixes #79

docs/hooks/hook_civicrm_alterAPIPermissions.md

@@ -3,28 +3,31 @@
 ## Description
 
 This hook is called when API 3 permissions are checked and can alter the
-$permissions structure from CRM/Core/DAO/.permissions.php (as well as
-the API $params array) based on the $entity and $action (or
+`$permissions` structure from `CRM/Core/DAO/permissions.php` (as well as
+the API `$params` array) based on the `$entity` and `$action` (or
 unconditionally).
 
-Note that if a given entity/action permissions are unset, the default
-‘access CiviCRM’ permission is enforced.
+!!! Note
+    If a given entity/action permissions are unset, the default
+    "access CiviCRM" permission is enforced.
 
-Note also that the entity in $permissions array use the camel case
-syntax (e.g. $permissions['option_group']['get'] = ... and not
-$permissions['OptionGroup']['get'] = ...)
 
 ## Definition
 
-    hook_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions)
+```php
+hook_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions)
+```
 
 ## Parameters
 
--   string $entity the API entity (like contact)
--   string $action the API action (like get)
--   array &$params the API parameters
--   array &$permisisons the associative permissions array (probably to
+-   string `$entity` - the API entity (like contact)
+-   string `$action` - the API action (like get)
+-   array `&$params` - the API parameters
+-   array `&$permisisons` - the associative permissions array (probably to
     be altered by this hook)
+    -   Note: the entity in `$permissions` array use the camel case
+        syntax (e.g. `$permissions['option_group']['get'] = ...` and not
+        `$permissions['OptionGroup']['get'] = ...`)
 
 ## Returns
 
@@ -36,39 +39,31 @@ $permissions['OptionGroup']['get'] = ...)
 
 ## Example
 
-    /**
-     *  alterAPIPermissions() hook allows you to change the permissions checked when doing API 3 calls.
-     */
-    function civitest_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions)
-    {
-        // skip permission checks for contact/create calls
-        // (but keep the ones for email, address, etc./create calls)
-        // note: unsetting the below would require the default ‘access CiviCRM’ permission
-        $permissions['contact']['create'] = array();
+```php
+function civitest_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions)
+{
+  // skip permission checks for contact/create calls
+  // (but keep the ones for email, address, etc./create calls)
+  // note: unsetting the below would require the default ‘access CiviCRM’ permission
+  $permissions['contact']['create'] = array();
 
-        // enforce ‘view all contacts’ check for contact/get, but do not test ‘access CiviCRM’
-        $permissions['contact']['get'] = array('view all contacts');
+  // enforce ‘view all contacts’ check for contact/get, but do not test ‘access CiviCRM’
+  $permissions['contact']['get'] = array('view all contacts');
 
-        // add a new permission requirement for your own custom API call
-        // (if all you want to enforce is ‘access CiviCRM’ you can skip the below altogether)
-        $permissions['foo']['get'] = array('access CiviCRM', 'get all foos');
+  // add a new permission requirement for your own custom API call
+  // (if all you want to enforce is ‘access CiviCRM’ you can skip the below altogether)
+  $permissions['foo']['get'] = array('access CiviCRM', 'get all foos');
 
-        // allow everyone to get info for a given event; also – another way to skip permissions
-        if ($entity == 'event' and $action == 'get' and $params['title'] == 'CiviCon 2038') {
-            $params['check_permissions'] = false;
-        }
-    }
-
-## Notes on Example
+  // allow everyone to get info for a given event; also – another way to skip permissions
+  if ($entity == 'event' and $action == 'get' and $params['title'] == 'CiviCon 2038') {
+      $params['check_permissions'] = false;
+  }
+}
+```
 
 When developing an extension with custom API, this code is placed
 directly in the API php file that you have created. In this case the
 extension would be named CiviTest. The API function for the GET would be
-: function civicrm_api3_civi_test_get(); The alterAPIPermissions
+`function civicrm_api3_civi_test_get();`. The `alterAPIPermissions`
 function is prefixed with the full extension name, all lowercase,
-followed by "_civicrm_alterAPIPermissions".
-
-There seems to be a bit of inconsistency between civiCRM 4.2.6 and
-civiCRM 4.2.13.  See attached screen.\
-
-![](https://wiki.civicrm.org/confluence/download/attachments/86213391/IMG_26112013_110442.png?version=1&modificationDate=1385467332000&api=v2)
+followed by `_civicrm_alterAPIPermissions`.
\ No newline at end of file