Module: CiviCrm

Includes:

Profiling

Defined in:

lib/civicrm.rb,
lib/civicrm/client.rb,
lib/civicrm/errors.rb,
lib/civicrm/version.rb,
lib/civicrm/resource.rb,
lib/civicrm/profiling.rb,
lib/civicrm/actions/find.rb,
lib/civicrm/actions/list.rb,
lib/civicrm/actions/create.rb,
lib/civicrm/actions/update.rb,
lib/civicrm/resources/base.rb,
lib/civicrm/resources/base.rb,
lib/civicrm/actions/destroy.rb,
lib/civicrm/resources/custom_field.rb,
lib/civicrm/resources/option_value.rb,
lib/civicrm/resources/financial_type.rb

Defined Under Namespace

Modules: Actions, Errors, Profiling Classes: Activity, ActivityType, Address, BaseResource, Batch, Campaign, Case, Client, Constant, Contact, ContactType, Contribution, ContributionPage, ContributionRecur, ContributionSoft, Country, CustomField, CustomGroup, CustomSearch, CustomValue, Domain, Email, Entity, EntityTag, Event, Extension, File, FinancialType, Grant, Group, GroupContact, GroupNesting, GroupOrganization, Im, Job, LineItem, LocBlock, Location, LocationType, MailSettings, Mailing, Membership, MembershipPayment, Note, OptionGroup, OptionValue, Phone, Profile, Relationship, RelationshipType, Resource, Setting, StateProvince, Survey, SurveyRespondant

Constant Summary

Error =

Class.new(Exception)

VERSION =

'1.3.6'

@@api_key =

nil

@@site_key =

nil

@@api_base =

'https://www.example.org/path/to/civi/codebase'

@@api_version =

'v3'

Class Method Summary

• .api_key=(key) ⇒ Object
• .api_url(path = '') ⇒ Object

Class Method Details

.api_key=(key) ⇒ Object

# File 'lib/civicrm.rb', line 48

def self.api_key=(key)
  @@api_key = key
end

.api_url(path = '') ⇒ Object

# File 'lib/civicrm.rb', line 41

def self.api_url(path = '')
  base = "#{api_base}/civicrm/extern/rest.php?#{path}"
  base += "&api_key=#{@@api_key}" if @@api_key
  base += "&key=#{@@site_key}" if @@site_key
  base
end