Presentación de la quinta clase de un curso sobre el framework Symfony -- Slides used in the fith class of a symfony framework training

1. Frameworks de desarrollo
Symfony
Clase 5
Javier Eguíluz
javier.eguiluz@gmail.com

2. Esta obra dispone de una licencia de tipo Creative
Commons Reconocimiento‐No comercial‐ Compartir
bajo la misma licencia 3.0
Se prohíbe explícitamente el uso de este material en
actividades de formación comerciales
http://creativecommons.org/licenses/by‐nc‐sa/3.0/es/

3. This work is licensed under a Creative Commons
Attribution‐Noncommercial‐Share Alike 3.0
The use of these slides in commercial courses or
trainings is explicitly prohibited
http://creativecommons.org/licenses/by‐nc‐sa/3.0/es/

4. Capítulo 20
Plugins

5. Plugins
quot;forma de agrupar y distribuir un
subconjunto de archivos de tu proyecto quot;
• Clases • Tareas
• Helpers • Esquemas de datos
• Configuración • CSS
• Rutas • JavaScript

6. Estructura de
archivos

7. sfJobeetPlugin/
config/
• sfJobeetPluginConfiguration.class.php
• schema.yml
• routing.yml
modules/
job/
actions/
config/
templates/

8. sfJobeetPlugin/
lib/
Jobeet.class.php
helper/
filter/
form/
model/
task/
web/

10. $ mkdir plugins/sfJobeetPlugin/config/
$ mv config/schema.yml plugins/sfJobeetPlugin/config/schema.yml
plugins/sfJobeetPlugin/config/schema.yml
propel:
_attributes:
package: plugins.sfJobeetPlugin.lib.model

11. apps/frontend/config/routing.yml
...
change_language:
url: /change_language
param: { module: sfJobeetLanguage, action:
changeLanguage }
localized_homepage:
url: /:sf_culture/
param: { module: sfJobeetJob, action: index }
requirements:
sf_culture: (?:fr|en)
homepage:
url: /
param: { module: sfJobeetJob, action: index }

12. apps/frontend/config/settings.yml
all:
.settings:
enabled_modules:
‐ default
‐ sfJobeetAffiliate
‐ sfJobeetApi
‐ sfJobeetCategory
‐ sfJobeetJob
‐ sfJobeetLanguage

13. config/ProjectConfiguration.class.php
public function setup() {
$this‐>enableAllPluginsExcept(array(
'sfDoctrinePlugin',
'sfCompat10Plugin'
));
}
public function setup() {
$this‐>enablePlugins(array(
'sfPropelPlugin',
'sfGuardPlugin',
'sfFormExtraPlugin',
'sfJobeetPlugin'
));
}

14. Utilizando los plugins

15. 1. ./symfony plugin:install sfGuardPlugin
2. sfGuardPlugin‐3.1.3.tgz (plugins/)
3. svn:externals (plugins/)

16. Publicando tu plugin

17. http://www.symfony‐project.org/plugins

18. README
Instrucciones de instalación. Formato Markdown
LICENSE
La eliges tu. El sitio oficial sólo muestra los
plugins con licencias MIT, BSD, LGPL y PHP
package.xml
La definición del paquete. Sigue el formato PEAR

19. plugins/sfJobeetPlugin/package.xml
<?xml version=quot;1.0quot; encoding=quot;UTF‐8quot;?>
<package packagerversion=quot;1.4.1quot; version=quot;2.0quot;
xmlns=quot;http://pear.php.net/dtd/package‐2.0quot;
xmlns:tasks=quot;http://pear.php.net/dtd/tasks‐1.0quot;
xmlns:xsi=quot;http://www.w3.org/2001/XMLSchema‐instancequot;
xsi:schemaLocation=quot;http://pear.php.net/dtd/tasks‐1.0 http://pear.php.net/dtd/tasks‐1.0.xsd
http://pear.php.net/dtd/package‐2.0 http://pear.php.net/dtd/package‐2.0.xsdquot;
>
<name>sfJobeetPlugin</name>
<channel>plugins.symfony‐project.org</channel>
<summary>A job board plugin.</summary>
<description>A job board plugin.</description>
<lead>
<name>Fabien POTENCIER</name>
<user>fabpot</user>
<email>fabien.potencier@symfony‐project.com</email>
<active>yes</active>
</lead>
<date>2008‐12‐20</date>
...

20. plugins/sfJobeetPlugin/package.xml
...
<version>
<release>1.0.0</release>
<api>1.0.0</api>
</version>
<stability>
<release>stable</release>
<api>stable</api>
</stability>
<license uri=quot;http://www.symfony‐project.com/licensequot;>
MIT license
</license>
<notes />
...

21. plugins/sfJobeetPlugin/package.xml
...
<contents>
<!‐‐ CONTENT ‐‐>
</contents>
<dependencies>
<!‐‐ DEPENDENCIES ‐‐>
</dependencies>
<phprelease>
</phprelease>
<changelog>
<!‐‐ CHANGELOG ‐‐>
</changelog>
</package>

22. plugins/sfJobeetPlugin/package.xml
<contents>
<dir name=quot;/quot;>
<file role=quot;dataquot; name=quot;READMEquot; />
<file role=quot;dataquot; name=quot;LICENSEquot; />
<dir name=quot;configquot;>
<file role=quot;dataquot; name=quot;config.phpquot; />
<file role=quot;dataquot; name=quot;schema.ymlquot; />
</dir>
<!‐‐ ... ‐‐>
</dir>
</contents>

23. plugins/sfJobeetPlugin/package.xml
<dependencies>
<required>
<php>
<min>5.0.0</min>
</php>
<pearinstaller>
<min>1.4.1</min>
</pearinstaller>
<package>
<name>symfony</name>
<channel>pear.symfony‐project.com</channel>
<min>1.2.0</min>
<max>1.3.0</max>
<exclude>1.3.0</exclude>
</package>
</required>
</dependencies>

24. plugins/sfJobeetPlugin/package.xml
<dependencies>
<required>
<php>
<min>5.0.0</min>
</php>
<pearinstaller>
<min>1.4.1</min>
</pearinstaller>
<package>
<name>symfony</name>
<channel>pear.symfony‐project.com</channel>
<min>1.2.0</min>
<max>1.3.0</max>
<exclude>1.3.0</exclude>
</package>
<package>
<name>sfFooPlugin</name>
<channel>plugins.symfony‐project.org</channel>
<min>1.0.0</min>
<max>1.2.0</max>
<exclude>1.2.0</exclude>
</package>
</required>
</dependencies>

25. plugins/sfJobeetPlugin/package.xml
<changelog>
<release>
<version>
<release>1.0.0</release>
<api>1.0.0</api>
</version>
<stability>
<release>stable</release>
<api>stable</api>
</stability>
<license uri=quot;http://www.symfony‐project.com/licensequot;>
MIT license
</license>
<date>2008‐12‐20</date>
<license>MIT</license>
<notes>
* fabien: First release of the plugin
</notes>
</release>
</changelog>

26. Capítulo 21
El día del diseño

27. [1] Sensio

28. [2] P'unk Avenue

29. [3] centre{source}

30. [4] OrangeD

31. [5] Mathijs Beks / qube

32. [6] Eduardo Martinez Cobos

33. [7] Christophe Nguyen
Studio Mitsuné

34. [8] centre{source}

35. Capítulo 22
La cache

36. Creando un nuevo
entorno

37. apps/frontend/config/settings.yml
prod:
.settings:
cache: on
dev:
.settings:
cache: off
test:
.settings:
cache: off

38. dev
prod
cli
cache

39. web/frontend_cache.php
if (!in_array(@$_SERVER['REMOTE_ADDR'], array('127.0.0.1', '::1'))) {
die('Not allowed');
}
require_once(dirname(__FILE__).
'/../config/'.
'ProjectConfiguration.class.php');
$configuration = ProjectConfiguration::getApplicationConfiguration(
'frontend',
nombre del
'cache',
entorno
true);
sfContext::createInstance($configuration)‐>dispatch();

40. apps/frontend/config/settings.yml
cache:
.settings:
error_reporting: <?php echo (E_ALL | E_STRICT).quot;nquot; ?>
web_debug: on
cache: on
etag: off
config/databases.yml
cache:
propel:
class: sfPropelDatabase
param:
classname: DebugPDO

41. Configurando la
cache

42. apps/frontend/config/cache.yml
default:
enabled: off
with_layout: false
lifetime: 86400

43. Guardando páginas
en la cache

44. plugins/sfJobeetJob/modules/sfJobeetJob/config/cache.yml
index:
enabled: on
with_layout: true

46. plugins/sfJobeetJob/modules/sfJobeetJob/config/cache.yml
new:
enabled: on
index:
enabled: on
all:
with_layout: true

47. Borrando la cache

48. $ ./symfony cc
$ ./symfony cc ‐‐type=template ‐‐env=cache

49. Guardando acciones
en la cache

50. plugins/sfJobeetJob/modules/sfJobeetJob/config/cache.yml
new: new:
enabled: on enabled: on
index: index:
enabled: on enabled: on
all: all:
with_layout: true with_layout: false

52. Guardando parciales
y componentes en la
cache

53. _language:
enabled:on
_list:
enabled:on

55. Guardando
formularios en la
cache

56. plugins/sfJobeetJob/lib/form/PluginJobeetJobForm.class.php
abstract class PluginJobeetJobForm extends BaseJobeetJobForm
{
public function __construct(BaseObject $object = null,
$options = array(),
$CSRFSecret = null) {
parent::__construct($object, $options, false);
}
// ...
}

57. plugins/sfJobeetJob/modules/sfJobeetLanguage/actions/components.class.php
class sfJobeetLanguageComponents extends sfComponents {
public function executeLanguage(sfWebRequest $request) {
$this‐>form = new sfFormLanguage(
$this‐>getUser(),
array('languages' => array('en', 'fr'))
);
unset($this‐>form[$this‐>form‐>getCSRFFieldName()]);
}
}
plugins/sfJobeetJob/modules/sfJobeetLanguage/actions/actions.class.php
class sfJobeetLanguageActions extends sfActions {
public function executeChangeLanguage(sfWebRequest $request) {
$form = new sfFormLanguage(
$this‐>getUser(),
array('languages' => array('en', 'fr'))
);
unset($form[$this‐>form‐>getCSRFFieldName()]);
}
}

58. plugins/sfJobeetJob/modules/sfJobeetJob/config/cache.yml
index:
enabled: on
lifetime: 600
plugins/sfJobeetJob/modules/sfJobeetJob/actions/actions.class.php
public function executePublish(sfWebRequest $request) {
...
if ($cache = $this‐>getContext()‐>getViewCacheManager())
{
$cache‐>remove('sfJobeetJob/index?sf_culture=*');
$cache‐>remove('sfJobeetCategory/show?id='.
$job‐>getJobeetCategory()‐>getId());
}
...
}

59. sfContext::getInstance()‐>
getRouting() getRequest()
getResponse() getController()
getStorage() getConfiguration()
getUser() getI18N()
getLogger() getDatabaseConnection()
http://www.symfony‐project.org/api/1_2/sfContext

60. Capítulo 23
Pasando a
producción

61. Preparando el
servidor de
producción

62. check_configuration.php

63. Aceleradores PHP

64. Guardan en una cache el quot;bytecodequot;
generado al compilar los scripts de PHP.
Así no se procesa ni compila el código
fuente del script en cada petición

65. Sin acelerador
código ejecutar
parsear compilar
fuente

66. bytecode
Con acelerador
cache
Primera ejecución
código ejecutar
parsear compilar
fuente
Siguientes ejecuciones
bytecode
cache

67. 1. Instalar ($ pecl install APC)
2. Configurar:
apc.enabled = 1
apc.shm_segments = 1
apc.shm_size = 30
apc.stat = 1
3. Reiniciar Apache

68. Las librerías de
Symfony

69. config/ProjectConfiguration.class.php
require_once dirname(__FILE__).
'/../lib/vendor/'.
'symfony/lib/autoload/'.
'sfCoreAutoload.class.php';

70. Archivo comprimido (symfony‐1.2.4.tgz)
Eliminar archivos anteriores de lib/vendor/
1.
Descomprimir el archivo en lib/vendor/
2.
Subversion
$ svn propedit svn:externals lib/vendor/
# symfony http://svn.symfony‐project.com/tags/RELEASE_1_2_1/
# symfony http://svn.symfony‐project.com/branches/1.2

71. lib/vendor/
symfony/
symfony_test/
config/ProjectConfiguration.class.php
require_once dirname(__FILE__).
'/../lib/vendor/'.
'symfony_test/lib/autoload/'.
'sfCoreAutoload.class.php';

72. Ajustando la
configuración

73. $ ./symfony configure:database quot;...quot; usuario pass
$ ./symfony plugin:publish‐assets
apps/frontend/config/settings.yml
all:
.actions:
error_404_module: default
error_404_action: error404

74. Modificando la
estructura de
directorios

75. config/ProjectConfiguration.class.php
class ProjectConfiguration extends sfProjectConfiguration {
public function setup() {
$this‐>setWebDir(
$this‐>getRootDir().'/public_html'
);
}
}
class ProjectConfiguration extends sfProjectConfiguration {
public function setup() {
$this‐>setCacheDir('/tmp/symfony_cache');
$this‐>setLogDir('/tmp/symfony_logs');
}
}

76. Las factorías

77. sfResponse
getResponse()
miRespuesta
factories.yml
otraRespuesta

78. apps/frontend/config/factories.yml
response:
class: sfWebResponse
param:
logging: %SF_LOGGING_ENABLED%
charset: %SF_CHARSET%
send_http_headers: true

79. apps/frontend/config/factories.yml
request:
class: sfWebRequest
param:
logging: %SF_LOGGING_ENABLED%
path_info_array: SERVER
path_info_key: PATH_INFO
relative_url_root: ~
formats:
txt: text/plain
js: [application/javascript,
application/x‐javascript,
text/javascript]
css: text/css
json: [application/json, application/x‐json]
xml: [text/xml, application/xml, application/x‐xml]
rdf: application/rdf+xml
atom: application/atom+xml

80. apps/frontend/config/factories.yml
storage:
class: sfSessionStorage
param:
session_name: symfony

81. apps/frontend/config/factories.yml
storage:
class: sfPDOSessionStorage
param:
session_name: jobeet
db_table: session
database: propel
db_id_col: id
db_data_col: data
db_time_col: time

82. apps/frontend/config/factories.yml
user:
class: myUser
param:
timeout: 1800

83. apps/frontend/config/factories.yml
prod:
logger:
class: sfNoLogger
param:
level: err
loggers: ~

84. apps/frontend/config/factories.yml
logger:
class: sfFileLogger
param:
level: error
file: %SF_LOG_DIR%/%SF_APP%_%SF_ENVIRONMENT%.log
%SF_APP% = sfConfig::get('sf_app')

85. Instalando
aplicaciones

86. Subir todo al servidor de producción
salvo los siguientes directorios:
cache/
log/
web/uploads/

87. config/properties.ini
[production]
host=www.jobeet.org
port=22
user=jobeet
dir=/var/www/jobeet/
type=rsync
pass=
$ ./symfony project:deploy production
SSH + rsync

88. $ ./symfony project:deploy production ‐‐go
config/rsync_exclude.txt
.svn
/web/uploads/*
/cache/*
/log/*
/web/*_dev.php

89. Capítulo 24
Un repaso a
Symfony

90. • ¿Qué es Symfony? • Seguridad
• El modelo • Formularios
• La vista • i18n y l10n
• El controlador • Pruebas
• Configuración • Plugins
• Depuración • Tareas
• Objetos