Skip to end of metadata
Go to start of metadata

This wiki page lists and briefly describes the role and function of external libraries used by CiviCRM.

amfphp

http://www.amfphp.org/

AMFPHP is a free open-source PHP implementation of the Action MessageFormat(AMF). AMF allows for binary serialization of Action Script (AS2, AS3) native types and objects to be sent to server side services.AMFPHPallows thin client applications built in languages such as Flash, Flex, and AIR to communicate directly with PHP class objectson the server. Client applications can also offload cpuintensive methods to PHP services and wait for the result set for presentation to the user.

In CiviCRM, this library is used by the Flash widget generated by the contribution pages.

Archive
Auth
Console
Contact
data
Date
DB
dompdf
eWAY
ezc
facebook

http://wiki.developers.facebook.com/index.php/API

With the API, you can add social context to your application by utilizing profile, friend, Page, group, photo, and event data.

Needs: where is this library used in CiviCRM?

fckeditor

The default WYSIWYG editor for CiviCRM. There are config options available for the keeners.

Google
HTML
html2text
HTTP
IDS

CiviCRM improves its security by using this intrusion detection system. You shouldn't need to do anything here, but the docs are at http://php-ids.org/. Oh, unless you move your site to a different directory or different machine, in which case you need to blow away a file as per the CiviCRM migration documentation.

jquery

http://www.jquery.com

jQuery is a simple and extensible javascript framework. CiviCRM uses its own jQuery namespace, named cj(). This means multple instances of jQuery library can be supported on the same page.

Log
Mail
Net
OS
Pager
PayJunction
PaymentExpress
pChart

Used by Report Component to do 2D charting. If you want to implement a different type of graph (there are lots), the documentation is available at http://pchart.sourceforge.net/documentation.php.

PEAR

PEAR is a framework and distribution system for reusable PHP components. See http://pear.php.net/

PHP
PHPgettext
recaptcha

Used on form inputs to prevent spambots from posting. You need to sign up for an account before you can enable it. Go to https://admin.recaptcha.net/accounts/login/?next=/recaptcha/sites/

Services
Smarty

http://www.smarty.net

Smarty is known as a "Template Engine", [but] it would be more accurately described as a "Template/Presentation Framework." That is, it provides the programmer and template designer with a wealth of tools to automate tasks commonly dealt with at the presentation layer of an application. I stress the word Framework because Smarty is not a simple tag-replacing template engine. Although it can be used for such a simple purpose, its focus is on quick and painless development and deployment of your application, while maintaining high-performance, scalability, security and future growth.

System
tinymce

An in-browser WYSIWYG editor. But see fckeditor above.

ufpdf
Validate
XML
Date.php
DB.php
Log.php
Mail.php
Multi.php
Pager.php
PEAR.php
pearcmd.php
peclcmd.php
remote-list.pear.php.net
System.php
Validate.php
VERSIONS
Labels:

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.