Custom PHP Functions

Important: As of 8.01 SP2, the platforms/PHP folder is installed to the program files/Ektron/utilities folder. In order for PHP platform support to function, move the platforms/PHP folder to the Workarea folder and configure it.
Previously, the platforms folder was installed to the Workarea folder by default.

Ektron CMS400.NET maintains and displays content via custom Ektron PHP functions and ComObjects. For the custom PHP functions to work properly, do the following:

Make sure the php_soap.dll file is in the c:\php folder on the server where you installed PHP.

Add the following line to the php.ini file.

extension=php_soap.dll

The php.ini file is located in C:\Windows\php.ini.

In the ApplicationAPI.php file, set the WSDLpath. The applicationAPI.php file is located by default in:

http://localhost/siteroot/WorkArea/platforms/PHP/applicationAPI.php

Warning! ContentWS.asmx is the web services (WSDL) file that the custom PHP functions use to talk to Ektron CMS400.NET. The WSDLpath located in the applicationAPI.php file must be set to location of the WSDL file. The default WSDLpath is http://localhost/siteroot/WorkArea/WebServices/ContentWS.asmx. If you have changed the location of ContentWS.asmx you need to update the WSDLpath. For example, if your site is www.example.com, the WSDLpath would be http://www.example.com/WorkArea/WebServices/ContentWS.asmx.

Add the following line to the top of each template.

<?php include 'applicationAPI.php'; ?>

This file calls the Ektron custom functions file to allow the page to function properly. It must appear at the top of the template file.

If you have upgraded your Ektron CMS400.NET from an Ektron CMS300 version, add the following line between the head tags for each template.

Warning! This only needs to be done if you are upgrading from CMS300 to CMS400.NET

<meta http-equiv="Content-type" content="text/html; charset=utf-8" />

To customize you Ektron CMS400.NET application, you need to be familiar with these functions.

Function

Description

More Information

Calendar Functions

Event Calendar

Displays a month view event calendar

Event Calendar Function

Collection Functions

Collection

Displays links generated by collections

Collection Function

CollectionXML

Creates XML for a collection by wrapping tags around all of the collection items and their properties. This allows you to use an XSLT to define how the XML collection is displayed.

XML Collection Function

Random Content

Randomly displays the content of a collection item

Random Content Function

Random Summary

Randomly displays the summary of a collection item

Random Summary Function

RSS Collection

Creates an RSS feed out of the items in a collection.

RSS Collection Function

Content Functions

Add Content

Allows a user to add content to Ektron CMS400.NET programmatically.

Add Content

Content Block

Displays and manages a content block

Content Block Function

Form

Displays a content block associated with a form

Form Function

Multipurpose

Displays either a content block or a form

MultiPurpose Function

List Summary Functions

Archive

ListSummary

Displays summaries of archived content blocks

Archive List Summary Function

List Summary

Displays a list of content block summaries

List Summary Function

List Summary XML

Creates XML for a list summary by wrapping tags around all of the collection items and their properties. This allows you to use an XSLT to define how the XML collection is displayed.

XML List Summary Function

RSS List Summary

Creates an RSS feed out of the items in a list summary.

RSS List Summary Function

Single Summary

Displays the summary for a content block

Single Summary Function

Login Functions

Login

Adds the login or logout button

Login Function

Menu Functions

DropHTMLMenu

Used to display a DHTML menu

DHTML Menus

GenerateMenu

Works with DropHTML menu to display DHTML menus

DHTML Menus

XML Menu

Creates XML for a menu by wrapping tags around all of the menu items properties.

XML Menu Function

Metadata Functions

Metadata

Displays the metadata for the current Web page

Metadata Function

Search Functions

Search

Inserts a text box with a search button

Search Function

Search Display

Creates an area to display search results

Search Display Function

Language Functions

Language Select

Lets a site visitor select a language in which to view site.

Language Select Function

Previous TopicNext Topic|