Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Akeeba Subscription

Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Publication date December 2011 Abstract This book covers the use of the Akeeba Subscriptions component and its bundled modules and plugins for selling and managing subscriptions on your Joomla!™-powered web sites. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found on-line at http://www.gnu.org/licenses/fdl.html. iii Table of Contents 1. Introduction and installation .............................................................................................................. 1 1. Introducing Akeeba Subscriptions .............................................................................................. 1 2. Requirements and compatibility ................................................................................................. 2 3. Installation ............................................................................................................................. 2 3.1. Installation .................................................................................................................. 2 3.2. Installation troubleshooting ............................................................................................ 2 3.3. Updating to the latest release .......................................................................................... 5 4. Uninstallation ......................................................................................................................... 6 2. Initial set-up and usage .................................................................................................................... 7 1. How subscriptions work ........................................................................................................... 7 2. Configuration options .............................................................................................................. 8 3. Subscription Levels ................................................................................................................. 9 4. Tax Rules ............................................................................................................................ 12 5. Upgrade Rules ...................................................................................................................... 13 6. Coupons .............................................................................................................................. 14 7. Subscriptions management ...................................................................................................... 15 8. Affiliates management ........................................................................................................... 17 9. Front-end items ..................................................................................................................... 17 10. Importing from other components ........................................................................................... 18 3. Payment methods, integrations and plugins ........................................................................................ 19 1. Payment methods .................................................................................................................. 19 1.1. Paypal ...................................................................................................................... 19 1.2. None ........................................................................................................................ 20 1.3. WorldPay .................................................................................................................. 20 1.4. Off-line ..................................................................................................................... 21 1.5. 2Checkout Standard Purchase Routine ............................................................................ 21 1.6. ccAvenue .................................................................................................................. 22 1.7. eWay ........................................................................................................................ 22 1.8. uPay ......................................................................................................................... 23 1.9. MoIP ........................................................................................................................ 24 1.10. DeltaPay (Alpha Bank, Greece) ................................................................................... 24 2. Integration with third party software ......................................................................................... 25 2.1. Community Builder integration ..................................................................................... 25 2.2. ccInvoices integration .................................................................................................. 26 2.3. Community ACL integration ......................................................................................... 26 2.4. DOCman Integration ................................................................................................... 27 2.5. JCE Integration .......................................................................................................... 28 2.6. JomSocial integration .................................................................................................. 29 2.7. Joomla! 1.6 User Groups Integration .............................................................................. 30 2.8. JUGA Integration ....................................................................................................... 31 2.9. JoomlaXI JomSocial User Profile Types integration .......................................................... 32 2.10. K2 Integration .......................................................................................................... 33 2.11. NinjaBoard Integration ............................................................................................... 34 2.12. Tienda Integration ..................................................................................................... 35 2.13. Delete users on subscription expiration ......................................................................... 36 2.14. VirtueMart Integration ............................................................................................... 36 2.15. VirtueMart 2 Integration ............................................................................................. 37 2.16. RedShop Integration .................................................................................................. 38 2.17. Sample Fields ........................................................................................................... 39 2.18. Automatic Country and City fill .................................................................................. 39 2.19. Custom SQL scripts .................................................................................................. 39 Akeeba Subscriptions User's Guide iv 2.20. RedShop User Synchronisation .................................................................................... 39 3. Other plugins ........................................................................................................................ 40 3.1. Subscription expiration control ...................................................................................... 40 3.2. Subscription emails ..................................................................................................... 40 3.3. Administrator emails ................................................................................................... 41 3.4. Affiliate emails .......................................................................................................... 41 3.5. Subscription expiration notification ................................................................................ 42 3.6. Content restriction ...................................................................................................... 42 3.7. The Akeeba Subscriptions Link (aslink) plugin ................................................................ 43 4. Akeeba Subscriptions' modules ........................................................................................................ 45 1. List of active subscriptions ..................................................................................................... 45 2. List subscription levels ........................................................................................................... 45 5. Developers' information .................................................................................................................. 46 1. The "akeebasubs" plugin events ............................................................................................... 46 1.1. onAKSubscriptionChange ............................................................................................. 46 1.2. onAKUserRefresh ....................................................................................................... 46 1.3. onSubscriptionFormRender ........................................................................................... 47 1.4. onValidate ................................................................................................................. 48 1.5. onAKUserGetData ...................................................................................................... 48 1.6. onAKUserSaveData ..................................................................................................... 49 2. The "akpayment" plugin events ............................................................................................... 49 2.1. onAKPaymentGetIdentity ............................................................................................. 49 2.2. onAKPaymentNew ...................................................................................................... 49 2.3. onAKPaymentCallback ................................................................................................ 49 1 Chapter 1. Introduction and installation 1. Introducing Akeeba Subscriptions At a glance Akeeba Subscriptions is a subscriptions management component for Joomla!™ 1.5/1.6/1.7 and compatible distribu- tions. It is built using our renowned Framework on Framework architecture which extends the standard Joomla! API, ensuring greater stability and compatibility across different Joomla! releases. It is licensed under the GNU General Public License (GPL) version 3 [http://www.gnu.org/licenses/gpl.html] or –at your option– any later version published by the Free Software Foundation. It licensing scheme means that you are free (and, in fact, more than welcome) to install it on as many sites as you want, whenever you want and use it for as long as you want, no strings attached. There are no secret per-domain licensing fees and you can use it to sell one or several millions of subscriptions without any hidden costs. We love Freedom of choice as much as you do! The killer features Its feature list is nothing short of amazing. Out of the box, Akeeba Subscriptions supports these features: • Streamlined administrator interface which can even present you an interactive sales graph and sales report as soon as you launch the component • Rich subscription levels (subscription packages) editor which allows you to choose different images for each of your subscriptions and even a different order confirmation and order cancellation text to show to your users. • The easiest subscription management interface you've seen on a component. It will even show you your users' faces, powered by Gravatar. • Users can upgrade or expand (renew) their subscriptions. Renewing a subscription will create a new subscription which becomes valid the very second their old one expires. Users do not lose any of their subscription time when renewing, unlike most other subscription systems out there. • Full support for delayed payments, e.g. when using e-checks with PayPal. • Discount coupon codes which allow you to set an absolute money value or percentage discount for all or a specific subscription level and user, have publish up/publish down dates or a usage limit (e.g. the coupon code is valid only for the first 100 people to use it) – or a combination of any and all of the above! • Automatic discounts for upgrading or renewing subscriptions based on the subscription level and days of presence in the subscription package. This allows you to easily create rules like: 30% discount if you renew up to 30 days before the end of your subscription, 15% discount if you renew within the last 30 days, no discount otherwise. • Full support for complex tax calculations based on country, state and ZIP code. It fully integrates with the European Union's VIES system so that you can charge no VAT tax for intra-EU B2B transactions. • The subscription form can work with or without Javascript. With Javascript it becomes a fully fledged, auto-vali- dating subscription form. Without Javascript it works as a standard web form, accessible to users who do not wish / cannot use Javascript on their browser. • Integration with Joomla! 1.6/1.7 and later user group mapping • Integration with third party components: JUGA, K2, DOCman, JCE, NinjaBoard, VirtueMart, Tienda, JomSocial, Community Builder, ccInvoices and much more! Check out our documentation for more information. Introduction and installation 2 • Content restriction: a content plugin to show parts of your content only to registered subscribers, without the need of any external tool. • Payment methods: PayPal (for personal, verified and business accounts) is supported out of the box. Other payment methods (ccAvenue, WorldPay, 2Checkout and more) are being added continuously. Check out our documentation for more information. • Send emails to subscribers upon subscription, when their subscription/payment status changes and when their sub- scription is about to expire Support policy Please note that the software is provided free of charge, but support is not. You need to have an AKEEBADELUXE, SUPPORT or FORUMSUPPORT subscription on AkeebaBackup.com to seek support regarding setting up, using and customizing Akeeba Subscriptions. 2. Requirements and compatibility Akeeba Subscriptions 1.0.b4 and later will attempt to detect if your server meets the minimum requirements. If it does not, it will only do a partial installation (no plugins and modules will be installed) and you will be presented with an error message. In any case, Akeeba Subscriptions requires the following server-side configuration: • PHP 5.2.7 or later. Running it on earlier versions will either be problematic or it won't work at all. • MySQL 5.0.41 or later. Earlier database server versions will not be supported. Do note that earlier releases of MySQL are obsolete and not supported any more by Oracle (the company who controls the development of MySQL). • Joomla! 1.5.14 or later (fully supported) or Joomla! 1.6.0 or later. Since version 2.0.a1, Akeeba Subscriptions no longer uses the Nooku Framework which extends its compatibility with more server environments and third-party software. Important If you installed Akeeba Subscriptions 1.0.b4 or earlier on your site and your site displays a blank page, please remove the index.html files from your site's root and your site's administrator directories. 3. Installation 3.1. Installation Installing the package is the same as with any other Joomla! component. Go to your site's back-end, Extensions, Install/Uninstall (Joomla! 1.5) or Extensions, Manage (Joomla! 1.6) and click on Browse. Locate the ZIP package and click on Upload and Install. If the installation fails, please refer to the installation troubleshooting section of this guide. 3.2. Installation troubleshooting Joomla! 1.6/1.7 is logging you out during installation The first thing you might observe is that Joomla! 1.6 is logging you out when trying to install Akee- ba Subscriptions. This is due to a bug in Joomla! 1.6. Please follow these instructions [http://docs.joomla.org/ Why_does_the_administrator_logoff_all_of_the_sudden] to fix the database table that causes this issue. After doing Introduction and installation 3 that you will have to log in again to your site. You will see that everything is missing from the back-end interface. Don't uploads/s3/ akeebasubs-guide.pdf