t3con08 flow3 tutorial

Inspiring people toshare

T3CON08Development with FLOW3

The History of FLOW3(short version)

Since 1998

33 core members

committed 500.000 lines of code

resulting in a code base of

300.000 lines today

The Long History of TYPO3

Inspiring people toshareDevelopment with FLOW3

TYPO3 todayTYPO3 v4 is nearly feature complete

Focus of the last releases were usbility improvements for the users

Grown architecture, no unit tests

Fundamental changes are risky / impossible

Often used as application framework - but it's a CMS


TYPO3 tomorrow?

Why start fromscratch?

Topictext

Source: The Secret Archives of TYPO3

”We need a new framework!“


Buy none get two for free.


TYPO3 tomorrowFLOW3 acts as a reliable basis for any kind of web application

TYPO3 v5 is a package based on FLOW3

Extensions are packages as well, all based on FLOW3

Packages can be used

as extensions for TYPO3

as libraries for standalone applications


The FLOW3 experienceFlow [fl!] The mental state of operation in which the person is fully immersed in what he or she is doing by a feeling of energized focus, full involvement, and success in the process of the activity. Proposed by positive psychologist Mihály Csíkszentmihályi, the concept has been widely referenced across a variety of fields.

FLOW3 [fl!'three] The application framework which takes care of all hassle and lets you play the fun part.

http://encarta.msn.com/encnet/features/dictionary/Pronounce.aspx?search=three

http://encarta.msn.com/encnet/features/dictionary/Pronounce.aspx?search=three


FLOW3 = Application FrameworkNot just a collection of components or code snippet library

Comes with ready-to-go default configuration

Package based

Runs with PHP 5.3 or later

Comes with a powerful JSR-283 based Content Repository


Get the FLOW experienceIntuitive APIs

Readable source code (like a book)

Consistent naming for classes, methods and properties

Focus on the essential, the framework takes care of the infrastructure


FLOW3 modulesAOP

Component

Configuration

Cache

Error

Event

Locale

Log

MVC

Package

Persistence

Property

Reflection

Resource

Session

Utility

Validation

... and more


Getting Started


Getting Started

RequirementsSome webserver (tested with Apache and IIS)

PHP 5.3 or higher (see http://snaps.php.net/)

PHP extensions: zlib, PDO and PDO SQLite and the usual stuff

Some database (tested with SQLite, MySQL and Postgres)


Getting Started

DownloadCurrently available through Subversion

Checkout the FLOW3 Distribution:svn co https://svn.typo3.org/FLOW3/distribution/trunk

or try the TYPO3 Distribution:svn co https://svn.typo3.org/TYPO3v5/distribution/trunk

Nightly builds will follow as soon as we've set up our release mechanism


Getting Started

Grant File PermissionsThe webserver needs

read access for all files of the distribution and

write access in the Public and Data directory

On Linux / Mac just call sudo ./fixpermissions.sh

On legacy operating systems: ask your system administrator


Getting Started

Create a packageIn order to create a new package, just createa new folder within the Packages directory.


Getting Started

Create a Default ControllerCreate a subfolder in your package: Classes/Controller/

Create the controller class file:


Bootstrap


Bootstrap

Public/


Bootstrap

Public/index.phpThis file is the default main script

It launches FLOW3 in the Production context

The webserver's web root should point to the Public directory

define('FLOW3_PATH_PUBLIC', str_replace('\\', '/', __DIR__) . '/');require(FLOW3_PATH_PUBLIC . '../Packages/FLOW3/Classes/F3_FLOW3.php');

$framework = new F3::FLOW3();$framework->run();


Bootstrap

Public/index_dev.phpThis script is used for development

It launches FLOW3 in the Development context

More scripts like this can be created for additional contexts

define('FLOW3_PATH_PUBLIC', str_replace('\\', '/', __DIR__) . '/');require(FLOW3_PATH_PUBLIC . '../Packages/FLOW3/Classes/F3_FLOW3.php');

$framework = new F3::FLOW3('Development');$framework->run();


Bootstrap

$FLOW3->run()run() is a convenience method which

initializes the FLOW3 framework

resolves a request handler

handles and responses to the request


Bootstrap

$FLOW3->initialize()The initialization process is divided into different stages:

Initialize FLOW3

Initialize the packages

Initialize the components

Initialize the settings

Initialize the resources

The configuration for each level can't be changed once the initialization level is reached


Bootstrap

Beware of CachingDon't forget to run FLOW3 in Development context while you're developing because

component configuration is cached in production mode, so new classes won't be recognized

resources are cached in production mode, so changes won't be detected

and many more things might be cached which lead to unexpected errors if you change some code in your package


Bootstrap

Just in CaseIf you need to clear the cache, just remove all files from the Data/Temporary/ directory

Yes, there will be a backend function and command line tool for this


Solving Beginner's Problems


Topictext


Model - View - Controller


The MVC Pattern

Modelan object which contains data and business logic of a certain domain

doesn't contain any information about the presentation of that data, but rather defines the behaviour

in the FLOW3 project we prefer a special kind of model, the Domain Model

http://martinfowler.com/eaaCatalog/domainModel.html

http://martinfowler.com/eaaCatalog/domainModel.html


The MVC Pattern

Viewrepresents the display of the model on the web or another output channel

views only display data, they don't build or modify it


The MVC Pattern

Controllerreacts on user input, selects and manipulates the model as accordingly

selects a view and passes it the prepared model for rendering


Action ControllerAn action controller

accepts a request

evaluates arguments

calls the action defined in the request

and adds output to the response

MVC


Action Controller: Important MethodsActions - methods just need an "Action" suffix:public function indexAction() { ... }public function deleteAction() { ... }

Initialization for the whole controller:public function initializeController() { ... }

Initialization of arguments:public function initializeArguments() { ... }

Initialization before any action is called:public function initializeAction() { ... }

MVC


DEMO


Validation


Validating ArgumentsAll arguments passed to an Action Controller (more precisely: Request Handling Controller) are automatically validated

White List policy: Only registered arguments are available

Accessing the $_GET and $_POST super globals is dangerous, dirty, deprecated and will probably be intercepted in the future


Validating ArgumentsFLOW3 comes with a bunch of built in validators:

AlphaNumeric, EmailAddress, Float, Integer, NotEmpty, Number, NumberRange, RegularExpression, UUID, Text

Custom validators can be created (especially for Domain Models)

All validators can be chained (and nested)


DEMO


Components


ComponentsComponents are re-usable, properly encapsulated objects

The lifecycle of a component and the combination of active components is managed by the Component Manager

All classes in the TYPO3 context are considered as components

Components are configurable

Components


Class ! ComponentClasses are automatically registered as components if

they reside in the Classes directory of a package and

their name follows the FLOW3 naming conventions

Components


ExampleComponents


Components

Playing with building blocksThe combination of components used is configurable(orchestration)

The less components know about each other the easier it is to reuse them in a variety of contexts

Create your own LEGO set by creating cleanly separated, decoupled components!


Components

Component DependenciesComponents seldomly come alone

Components depend on other components which depend on other components which ...

Problem:

Components explicitly refer to other components:$phoneBookManager = new PhoneBookManager


Components

Dependency InjectionA component doesn't ask for the instance of another component but gets it injected

This methodology is referred to as the "Hollywood Principle":"Don't call us, we'll call you"

Enforces loose coupling and high cohesion

Makes you a better programmer


Components

Constructor without Dependency Injection


Components

Component with Constructor Injection


Components

Component with Setter Injection


Components

AutowiringFLOW3's framework tries to autowire constructor arguments and arguments of inject* methods

The type of the component to be injected is determined by the argument type (type hinting)

Autowiring does not work with Setter Injection through regular setters (set* methods)

Dependencies are only autowired if no argument is passed explicitly


Components

Fetching components manuallyAlthough Dependency Injection is strongly recommended, there might be cases in which components need to be created or retrieved manually

Use the getComponent() method in these cases.

$component = $componentManager->getComponent($componentName, $arg1, $arg2, ...);


Components

Component scopeComponent objects always live in a certain scope

Currently supported scopes are:

Singleton - Only one instance exists during one script run

Prototype - Each getComponent() call returns a fresh instance


Components

Component scopeThe scope can be defined through

an annotation in the component class (recommended)

through the component configuration in a Components.php file

The default scope is "Singleton"


Components

Component scope


Components

Creating PrototypesDependency Injection can be used in almost any case, there's no need to call getComponent()

But what if you need to instantiate a component within a method?


Components

Creating PrototypesSolution A: Call getComponent()


Components

Creating PrototypesSolution B: Call a factory method


Components

Creating PrototypesPlanned feature: Automatically generated factory methods


Domain Driven DesignA domain is the activity or business of the user

Domain Driven Design is about

focussing on the domain and domain logic

accurately mapping the domain concepts to software

forming a ubiquitous language among the project members


Domain Driven Design

Ubiquitous languageThe common vocabulary is an important prerequisitefor successful collaboration

Use the same words for discussion, modeling, developmentand documentation


Domain Driven Design

Layered Architecture

Presentation

Domain

Data source

Application Logic (Service Layer)

Domain Model (Domain Layer)

View

Controller

Data Mapper (part of Content Repository)

Data Source Abstraction


Persistence


JSR-283 based Content RepositoryDefines a uniform API for accessing content repositories

A Content Repository

is a kind of object database for storage, search and retrieval of hierarchical data

provides methods for versioning, transactions and monitoring

TYPO3CR is the first working port of JSR-170 / JSR-283

Karsten Dambekalns is member of the JSR-283 expert group

Persistence


Transparent PersistenceExplicit support for Domain-Driven Design

Class Schemata are defined by the Domain Model class

No need to write an XML or YAML schema definition

No need to define the database model and object model multiple times at different places

Automatic persistence in the JSR-283 based Content Repository

Legacy data sources can be mounted

Persistence


DEMO

Inspiring people toshareDevelopment with FLOW3 Inspiring people toshareHitchhiker's Guide to FLOW3

Configuration


Configuration

Configuration FormatThe default configuration format is PHP

Configuration options reside in a configuration object

The configuration object provides array access and a fluent interface

Configuration options are self-documenting


Configuration

Configuration Format


Configuration

Configuration TypesFLOW3 distinguishes between different configuration types for different purposes:

FLOW3 - reserved for FLOW3 configuration

Package - package related configuration

Component - configuration for components, including Dependency Injection

Routes - special configuration for defining MVC routes


Configuration

Configuration Types


Configuration

The CascadeEach package defines possible configuration options by setting default values

Default configuration can be altered by user-defined configuration files

User configuration can only modify existing configuration options

Modifying non-existent configuration options results in an error


Configuration

Application ContextAn application context is a set of configuration for a specific context

FLOW3 is shipped with configuration for these contexts:

Production

Development

Testing

Staging

FLOW3 is always launched in one defined context


Configuration

Application ContextConfiguration defined in the top level of a Configuration directory is the base configuration

Specialized configuration for application contexts reside in subdirectories named after the context

Application context configuration overrides the base configuration


Configuration

Application Context


REST Services


Security


Playground


Things to play with

F3BLOGTry out the Blog Example:svn co https://svn.typo3.org/FLOW3/Distribution/branches/BlogExample/


Things to play with

TYPO3CR AdminPlay with persistence and watch your object in the TYPO3CR Admin


Things to play with

TestrunnerExperiment with Test-Driven Development and watch the tests inFLOW3's test runner


Progress

Developing TYPO3 5.0 ...


Current StateAOP

Component

Configuration

Cache

Error

Event

0 25 50 75 100


Current StateLocale

Log

MVC

Package

Persistence

Property

0 20 40 60 80


Current StateReflection

Resource

Session

Utility

Validation

0 25 50 75 100


Next StepsFirst FLOW3 beta release end of this year

First pilot projects based on FLOW3 in winter '08 / spring '09

Further development of the CMS package

Planned release of TYPO3 5.0 beta: end of 2009


LinksFLOW3 Websitehttp://flow3.typo3.org

TYPO3 Forgehttp://forge.typo3.org

Coding Guidelineshttp://flow3.typo3.org/documentation/coding-guidelines/

Further Readinghttp://flow3.typo3.org/about/principles/further-reading/


Further Readinghttp://flow3.typo3.org/about/principles/further-reading/


Questions

t3con08 flow3 tutorial

Documents

flow3 inspiring people

flow3 distribution

flow3 extensions

flow3 packages

flow3 fl

flow3 frameworkresolves

typo3 tomorrow flow3

flow3inspiring people