TYPO3 Extension Development电子书

TYPO3 Extension Development

Table of Contents

TYPO3 Extension Development

Credits

About the Author

About the Reviewer

Preface

What This Book Covers

What You Need for This Book

Who is This Book For

Conventions

Reader Feedback

Customer Support

Downloading the Example Code for the Book

Errata

Piracy

Questions

1. About TYPO3 API

Overview of TYPO3 API

PHP Classes and Files

t3lib_

tslib_

tx_

ux_

user_

How Data Is Stored in TYPO3

Common TYPO3 API

Database API

Extension Management

Helper Functions (t3lib_div)

GET/POST Functions

String Functions

Array Functions

XML Processing

File, Directory, and URL Functions

Debug Functions

System Functions

TYPO3-Specific Functions

TYPO3 File References

Language Support

Reference Index

Hooks

Backend API

TCEforms

TCEmain

Record Manipulation

Clearing Cache

Frontend API

TSFE

Content Objects

Plugin API

Summary

2. Anatomy of TYPO3 Extension

TYPO3 Extension Categories

Category: Frontend

Category: Frontend plugins

Category: Backend

Category: Backend module

Category: Services

Category: Examples

Category: Templates

Category: Documentation

Category: Miscellaneous

Extension Files

Common Files

ext_emconf.php

ext_conf_template.txt

ext_tables.php

ext_tables.sql

ext_tables_static+adt.sql

ext_localconf.php

ext_icon.gif

tca.php

class.ext_update.php

Frontend Plugin Files

pi Files

TypoScript Templates

Backend Module and its Files

Module Function Files

Documentation Files

Summary

3. Planning Extensions

Why is Planning Important?

How to Plan

Gathering Requirements

Implementation Planning

Documentation Planning

TYPO3-Specific Planning

Extension Keys

Database Structure

Field Names

Indexes

Database Relations

Planning Our Extension

Requirements

Functionality

Usability and Expandability

Technical

Extension key

Frontend Plugins

Backend Module

Other Classes

Extension Database Structure

Documentation

Summary

4. Generating Extensions

Why Generation?

Preparing for Generation

Generation Steps

Entering an Extension key

Entering Extension Information

Set Up Languages

Creating New Database Tables

Extending Existing Tables

Creating Frontend Plugins

Creating Backend Modules

Integrating into Existing Modules

Adding Clickmenu Items

Creating Services

Static TypoScript Code

Adding TSConfig

Generating the Extension

Adjusting Extensions

Clean Up

Changing Fields

Hide Tables

Summary

5. Frontend Plugin: An In-Depth Study

Frontend Plugins: The Basics

Concepts

Plugin Configuration

TypoScript Configuration

Flexform Configuration

Templating

Localization

Being Localization-Aware

Localizing Strings

Fetching Localized Records

Character Set Handling

Caching

Caching in TYPO3

Cached and Non-Cached Output

Using cHash

Two Things to Avoid

no_cache=1

set_no_cache()

Advanced: Embedding USER_INT into USER

Summary

6. Programming Frontend Plugins

Review and Update Generated Files

Frontend Plugin Files

class.tx_feuserlist_pi1.php

locallang.xml

Other Related Files

TypoScript Files

ext_localconf.php

ext_tables.php

Non-Reviewed Files

Clean Up Extension

Programming the Plugin

General Workflow

Adding Files

Templates

Flexform Configuration

eID

Defining Functions

Initializing an Extension

Checking the Environment

Loading Configuration

Modifying the Flexform Data Source

Dispatching Calls

Using Templates

Template Basics

Using Templates

Creating a Single view

Creating a Template

Adding stdWrap for Fields

Programming Single View

Creating a List View

Creating a Template

Modifying the TypoScript Template

Programming List View

What is Missing in the List View

Creating Search

Including Styles and Scripts

Adding a Search Box to the Template

Adding a Search Condition

What About Cache?

Creating JavaScript for Autocomplete

Creating PHP Code for Autocomplete

Adding Hooks

What Can Be Optimized?

Summary

7. Programming Backend Modules

Planning a Backend Module

Functionality of a Backend Module

Frontend Classes

Database Structure

Adjusting the Database

ext_tables.sql

ext_tables.php

tca.php

Columns

Types

Palettes

Implementing a Frontend Hook

Backend Modules: The Basics

What Is a Backend Module?

Module Functions

Backend Module Files

Backend API

t3lib_BEfunc

t3lib_TCEmain

t3lib_TCEforms

t3lib_htmlmail

t3lib_refindex

$BE_USER

Implementing a Backend Module

Files and Classes

A Note about Backend HTML

Implementing the Main Class

Implementing the List of Last Logins

Implementing Monthly View

Implementing a List of Active Users

Implementing Page Statistics

Summary

8. Finalizing Extensions

Overview

Updating Code Files

Checking the Code

Using extdeveval to Beautify your Code

Script Documentation

Adding a Function Index

Reformatting the Code

Writing Documentation (Extension Manual)

Documentation Template

Template Structure

Styles in the Template

Images in the Documentation

Writing Documentation

Making Documentation Available

Uploading Extensions to TER

Summary

Index