T3CON09 Dallas: Hitchhikersguide

Hidee guesss!
T3CON09 – Big D, USA

Samstag, 18. April 2009

The History of FLOW3
(short version)


The TYPO3 Family

Hitchhiker's Guide to TYPO3 v5 Inspiring people to
share

share

TYPO3 and FLOW3
FLOW3 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

share

FLOW3 sub packages
AOP Log Reﬂection

Component Monitor Resource

Conﬁguration MVC Session

Cache Object SignalSlot

Error Package Validation

Locale Persistence ... and more

share

The FLOW3 experience
Flow [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 ﬁelds.

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

share

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

Comes with ready-to-go default conﬁguration

Package based

Runs with PHP 5.3 or later

Comes with a powerful JSR-283 based Content Repository

share

Get the FLOW experience
Intuitive 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

share

Getting Started

share

Getting Started

Requirements
Some webserver (tested with Apache and IIS)

PHP 5.3RC1 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)

share

Getting Started

Download
Currently 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

share

Getting Started

Grant File Permissions
The webserver needs

read access for all ﬁles of the distribution and

write access in the Public and Data directory

On Linux / Mac just call sudo ./ﬁxpermissions.sh

On legacy operating systems: ask your system administrator

share

DEMO

share

Model - View - Controller

share

The MVC Pattern

Model
an object which contains data and business logic of a
certain domain

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

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

share

The MVC Pattern

View
represents the display of the model on the web or another
output channel

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

share

The MVC Pattern

Controller
reacts on user input, selects and manipulates the model as
accordingly

selects a view and passes it the prepared model for
rendering

share

MVC

Action Controller
An action controller

accepts a request

evaluates arguments

calls the action deﬁned in the request

and adds output to the response

share

MVC

Action Controller: Important Methods
Actions - methods just need an "Action" sufﬁx:
public function indexAction() { … }
public function deleteAction() { … }

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

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

share

MVC

Action Arguments
Arguments are deﬁned by declaring them in the action method

Argument data types are deﬁned by type hint and documentation
/**
* Action that displays one single post
*
* @param F3BlogDomainModelPost $post The post to display
* @return void
* @author Robert Lemke <robert@typo3.org>
*/
public function showAction(F3BlogDomainModelPost $post) {

share

Domain Driven Design
A 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

share


Ubiquitous language
The common vocabulary is an important prerequisite
for successful collaboration

Use the same words for discussion, modeling, development
and documentation

share


Phone Book Domain Model

share


More phone book actions
show phone book entries

check if user may delete phone book entry

export phone book entries

log phone book actions

share

!

More phone book actions
show phone book entries
notentryn
check if user may delete phone book i the
export phone book entries of a p domain
hone b
log phone book actions ook

share


Layered Architecture

View
Presentation Controller

Application Logic (Service Layer)
Domain Domain Model (Domain Layer)

Data Mapper (part of Content Repository)
Data source Data Source Abstraction

share

Validation

share

Validating Arguments
All arguments passed to an Action 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

share

Validating Arguments
FLOW3 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)

share

Validation Rules Definition
All validation rules are defined by annotations in place

Additional rules may be defined programmatically
class Blog {

/**
* The blog's name. Also acts as the identifier.
*
* @var string
* @validate Alphanumeric, Length(minimum = 3, maximum = 50)
* @identity
*/
protected $name = '';

/**
* A short description of the blog
*
* @var string
* @validate Text, Length(maximum = 150)

Hitchhiker's Guide to TYPO3 v5
*/ Inspiring people to
protected $description = '';
share

Validation Rules Definition

/**
* Create action for this controller.
*
* @param string $emailAddress
* @return string The rendered view
* @validate $emailAddress EmailAddress
*/
public function createAction($emailAddress) {
}

share

Security

share

Objects

share

Objects

Managed Objects
The lifecycle of an object and the combination of active
objects is managed by the Object Manager

The behavior of objects in FLOW3 is conﬁgurable

share

Objects

Playing with building blocks
The combination of objects used is conﬁgurable
(orchestration)

The less classes 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 classes!

share

Objects

Class Dependencies
Classes seldomly come alone

Classes depend on other classes which depend on other
classes which ...

Problem:

Classes explicitly refer to other classes:
$phoneBookManager = new PhoneBookManager

share

Objects

Dependency Injection
A class doesn't ask for the instance of another class 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

share

Objects

Constructor without Dependency Injection
/**
* @var F3MyPackageModelCustomerRepository
*/
protected $customerRepository;

/**
* Constructor
*
*/
public function __construct() {
$this->customerRepository = F3MyPackageModelCustomerRepository::getInstance();
}

share

Objects

Class with Constructor Injection
/**
*/

/**
* Constructor
*
*/
public function __construct(F3MyPackageModelCustomerRepository $customerRepository) {
$this->customerRepository = $customerRepository;
}

share

Objects

Class with Setter Injection
/**
*/

/**
* Injects the customer repository
*
*/
public function injectCustomerRepository(F3MyPackageModelCustomerRepository $customerRepository) {
$this->customerRepository = $customerRepository;
}

share

Objects

Class with Property Injection

/**
* @inject
*/

share

Objects

Autowiring
FLOW3's framework tries to autowire constructor arguments,
arguments of inject* methods and annotated properties

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

share

Objects

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

Use the getComponent() method in these cases.

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

share

Objects

Object Scope
Objects always live in a certain scope

Currently supported scopes are:

Singleton - Only one instance exists during one script run

Prototype - Multiple instances exist

share

Objects

Object Scope
The scope can be defined through

a @scope annotation in the class (recommended)

through the object configuration in a
Objects.yaml file

The default scope is "Singleton"

share

Objects

Creating Prototypes
Dependency Injection can be used in almost any case,
there's no need to call getObject()

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

share

Objects

Creating Prototypes
Solution: Call the Object Factory's createObject() method
/**
* Create action for this controller.
*
* @param string $emailAddress
* @return string The rendered view
* @validate $emailAddress EmailAddress
*/
public function createAction($emailAddress) {
$customer = $this->objectFactory->create('F3DemoCustomer', $emailAddress);
$this->customerRepository->add($customer);
}

share

REST Services

share

Representational State Transfer
Style of network architecture principles

Mostly for building web services

Introduced in 2000 by Roy Fielding

share

RESTful Principles
Resource-Oriented

Uniform Interface

Stateless

Accessible through a uniform interface

share

Progress

Developing TYPO3 5.0 ...

Development with FLOW3 Inspiring people to
share

Playground

share

Things to play with

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

share

Things to play with

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

share

Things to play with

Testrunner
Experiment with Test-Driven Development and watch the tests in
FLOW3's test runner

share

Links
FLOW3 Website
http://flow3.typo3.org

TYPO3 Forge
http://forge.typo3.org

Coding Guidelines
http://flow3.typo3.org/documentation/coding-guidelines/

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

share

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

Beat
http://beat.typo3.org

share

Questions

share

T3CON09 Dallas: Hitchhikersguide

Recommended

Recommended

More Related Content

Similar to T3CON09 Dallas: Hitchhikersguide

Similar to T3CON09 Dallas: Hitchhikersguide (20)

More from Robert Lemke

More from Robert Lemke (20)

T3CON09 Dallas: Hitchhikersguide