connect_to_limesurvey {ipanema}

connect_to_limesurvey

Description

Connect to 'LimeSurvey' instance via the RPC and a direct MySQL connection. Store the RPC session key in ‘options(’limesurvey_session_key')'. Store the MySQL connection object in ‘options(’limesurvey_mysql_connection')'. Store the RPC URL in ‘options(’limesurvey_api_url')'.

Usage

connect_to_limesurvey(
  api_url,
  limesurvey_username,
  limesurvey_password,
  mysql_host,
  mysql_port,
  mysql_dbname,
  mysql_username,
  mysql_password
)

Arguments

api_url

URL to the 'LimeSurvey' RPC, e.g. 'http://localhost/index.php/admin/remotecontrol'

limesurvey_username

Username for the 'LimeSurvey' API

limesurvey_password

Password for the 'LimeSurvey' API

mysql_host

Hostname of the MySQL server used by 'LimeSurvey'

mysql_port

Port on which the MySQL server listens for connections

mysql_dbname

Name of the database on the MySQL server which is used by 'LimeSurvey'

mysql_username

Username for the MySQL server

mysql_password

Password for the MySQL server

Value

No return value, called for side effects

Examples

# This example assumes a locally hosted `LimeSurvey` instance using a locally
# hosted MySQL server
## Not run: 
connect_to_limesurvey(
  api_url = 'https://localhost/index.php/admin/remotecontrol',
  limesurvey_username = 'admin',
  limesurvey_password = '1234admin',
  mysql_host = '127.0.0.1',
  mysql_port = 3306,
  mysql_dbname = 'limesurvey',
  mysql_username = 'lime',
  mysql_password = '1234lime'
)

## End(Not run)