Cuyahoga平台相关资料

Cuyahoga Module Development Guide

Table of Contents

Introduction................................................................................................................................................1

Requirements............................................................................................................................................. 1

Setting up the project................................................................................................................................. 2

The simplest module possible.................................................................................................................... 3

The module controller........................................................................................................................... 3

The display user control........................................................................................................................ 4

The cuyahoga_moduletype table...........................................................................................................5

Displaying objects................................................................................................................................. 9

Using the PathInfo parameters to pass variables......................................................................................10

Custom module settings........................................................................................................................... 10

Module administration............................................................................................................................. 10

Make the module searchable....................................................................................................................11

Create an RSS feed for the module.......................................................................................................... 11

Language resources..................................................................................................................................11

Deployment..............................................................................................................................................12

Copy the files to the server..................................................................................................................12

Database scripts for the module installer............................................................................................ 12

http://www.cuyahoga-project.org/home/forum.aspx?g=topics&f=4.

The important thing: building custom modules for Cuyahoga is fun! It is not difficult to get results fast

and it's a great opportunity to learn about web frameworks and tools like NHibernate or dotLucene.

Requirements

We're assuming that Visual Studio .NET 2003 is used to create the modules. Of course, NAnt users can

also build modules, but the majority of .NET developers use VS.NET and it makes development a little

bit easier. Module developers need to have some experience developing ASP.NET pages and user

controls.

To get things started, you'll need a working version of Cuyahoga. This guide is based on the 0.9

release. It doesn't matter which database platform you choose. Modules that are developed with these

modules to the core modules project (StaticHtml, Articles etc) because this will get you in trouble with

upgrading to a new Cuyahoga version.

Choose 'Class Library' as the project type. By default, there is no option to add web components like

.aspx pages or .ascx user controls to a class library. It is possible however to change some VS.NET

templates that allow you to add web components to a class library. See

http://pluralsight.com/wiki/default.aspx/Fritz/AspNetWithoutWebProjects.html for a detailed

explanation.

The initial directory structure for a module should look something like this:

There are no restrictions for a specific directory structure. If the module is going to be very small, you

may as well put everything in one directory.

• Create a class that serves as a module controller, usually called ModuleNameModule.cs.

• Create an .ascx user control that displays module content.

• Add a record to the cuyahoga_moduletype table so that Cuyahoga knows how to create the

module instance.

The module controller

This is the central class of the module. It's not a controller like in a pure MVC sense but merely a class

that contains or delegates functionality that doesn't belong in the .ascx controls or .aspx pages that are

in the module. The module controller is a subclass of Cuyahoga.Core.Domain.ModuleBase and

requires a constructor with one argument of the 'Section' type.

using System;

public class SampleModule : ModuleBase

{

public SampleModule(Section section) : base(section)

{

//

// TODO: Add constructor logic here

//

}

}

}

and add the line.

The code behind class of the display control has to inherit from

Cuyahoga.Web.UI.BaseModuleControl:

namespace Cuyahoga.Modules.Sample.Web

{

using System;

using System.Data;

using System.Drawing;

using System.Web;

using System.Web.UI.WebControls;

using System.Web.UI.HtmlControls;

using Cuyahoga.Web.UI;

/// <summary>

/// The sample display control.

/// </summary>

public class Sample : BaseModuleControl

override protected void OnInit(EventArgs e)

{

//

// CODEGEN: This call is required by the ASP.NET Web Form Designer.

//

InitializeComponent();

base.OnInit(e);

}

/// <summary>

/// Required method for Designer support - do not modify

#endregion

}

}

Note: to use the Cuyahoga.Web.UI.BaseModuleControl class you have to add a reference to the

Cuyahoga.Web project.

The cuyahoga_moduletype table

All installed modules are registered in the cuyahoga_moduletype table. Enter the following values:

Column Value

moduletypeid auto-generated

name Sample