Information for 3rd Party Developers

[particthistle]

To enable 3rd Party Developers to incorporate Guided Tours into their components Documentation is required of the process required:

• SQL data definition is needed to allow developers to know what to include in their SQL for their installation
• should look at outlining how they can build their own tour in their development site both using the component as well as programmatically using the data definition
• define how to get the data from the database into their own installation script (if that's the best way to do it)

SQL statements for the installer need to take into account that:

• the tours and steps tables will already have data in them from the core installation
• the user may have installed tours and created steps that means the maximum ID for records in both tables is not known
• the user may have installed 3rd party extensions that created tours during their installation further incrementing the tour and steps IDs.

In a further enhancement to the project, the component should also have the ability to import/export tours and steps so that users can develop their own tours for their clients, and then export them to import on other websites.

So it's then important that the SQL query that 3rd party developers are provided with as an example to create their own tours and steps using INSERT statements needs to:

• INSERT a tour record into #__guidedtours
• Determine the ID created for the tour
• INSERT steps into #_guidedtour_steps, using the tour ID from the tour insert step to attach the steps to the correct tour.