Anotaciones en Symfony. DeSymfony 2013. Ariel Ferrandini

NO HABLARÉ DE COMIDA
#deSymfony @aferrandini

¿QUIÉN SOY?
•Ariel Ferrandini Price (11-11-85)
•Programador PHP
•Symfony lover (0.9.8beta)
•DeSymfony early adopter
•¡Me encanta viajar!

ORIGEN DE LAS ANOTACIONES
anotación
1. nota crítica o explicatoria agregados a un texto.
Java 1.5, especiﬁcación JSR-175 en 2002 y aprobadas en septiembre de 2004.
Las anotaciones no afectan directamente a la semántica del programa, pero afectan a
la forma en que los programas son tratados por herramientas y bibliotecas, que a su vez
pueden afectar a la semántica del programa en ejecución. Las anotaciones se pueden leer
en clases mediante reﬂexión en tiempo de ejecución.

¿Qué dice
este loco?

Request
¿Cómo funcionan las anotaciones?
FrontController
Symfony Kernel
Eventos

ReaderDriver Semántica
@AnnotationControllerFoo()
@AnnotationActionFoo()
<?php
namespace NamespaceFoo;
use AnnotationFoo;
/**
* @AnnotationControllerFoo()
*/
class Controller
{
/**
* @AnnotationActionFoo()
*/
public function fooAction()
{
// ...
}
}

Response

ANOTACIONES
EN

FRAMEWORK EXTRA BUNDLE
# app/config/config.yml
sensio_framework_extra:
router: { annotations: true }
request: { converters: true }
view: { annotations: true }
cache: { annotations: true }
Habilitar las anotaciones

FRAMEWORK EXTRA BUNDLE
Agregar las anotaciones con use
use SensioBundleFrameworkExtraBundleConfigurationRoute;
use SensioBundleFrameworkExtraBundleConfigurationMethod;
use SensioBundleFrameworkExtraBundleConfigurationParamConverter;
use SensioBundleFrameworkExtraBundleConfigurationCache;
use SensioBundleFrameworkExtraBundleConfigurationTemplate;

ENRUTAMIENTO
# app/config/routing.yml
# importar rutas de una clase Controller
agenda:
resource: "@DeSymfonyWebBundle/Controller/AgendaController.php"
type: annotation
# importar todas las clases Controller de un directorio
web:
resource: "@DeSymfonyWebBundle/Controller"
type: annotation
Activar rutas con anotaciones

ENRUTAMIENTO
@Route @Method

@ROUTE
// DeSymfony/Bundle/WebBundle/Controller/AgendaController.php
/**
* @Route(“/agenda”)
*/
class AgendaController extends Controller
{
/**
* @Route(“/”, name=”agenda”)
*/
public function agendaAction()
{
}
}
Conﬁgurar rutas con anotaciones

@ROUTE
Conﬁgurar rutas con anotaciones
/**
*/
{
/**
* @Route(“/{dia}”, name=”agenda”)
*/
public function agendaAction($dia)
{
}
}

@ROUTE
/**
*/
{
/**
* @Route(“/{dia}”, name=”agenda”,
requirements={“dia”=”d+”}, defaults={“dia”=21})
*/
public function agendaAction($dia)
{
}
}

ROUTING
@Route @Method

@METHOD
/**
*/
{
/**
* @Route(“/editar/{id}”, name=”editar_agenda”)
* @Method({“GET”, “POST”})
*/
public function editarAction($id)
{
}
}
Conﬁgurar método con anotaciones

CONVERSORES
@ParamConverter

@PARAMCONVERTER
/**
*/
{
/**
* @Route(“/{id}”, name=”agenda”)
* @ParamConverter(“agenda”, class=”DeSymfonyWebBundle:Agenda”)
*/
public function agendaAction(Agenda $agenda)
{
}
}
Convierte parámetros en objetos

/**
*/
{
/**
* @ParamConverter(“agenda”, class=”DeSymfonyWebBundle:Agenda”,
options={“entity_manager” = “foo”)
*/
{
}
@PARAMCONVERTER

/**
*/
{
/**
* @Route(“/{id}/{agenda_id}”, name=”agenda”)
options={“id” = “agenda_id”)
*/
{
}
@PARAMCONVERTER

/**
*/
{
/**
* @Route(“/{slug}”, name=”agenda”)
options={“mapping”: {“slug”: “slug”}})
*/
{
}
@PARAMCONVERTER

/**
*/
{
/**
* @Route(“/{inicio}/{fin}”, name=”agenda”)
* @ParamConverter(“inicio”, options={“format”: “Y-m-d”})
* @ParamConverter(“fin”, options={“format”: “Y-m-d”})
*/
public function agendaAction(DateTime $inicio, DateTime $fin)
{
}
@PARAMCONVERTER

CACHE
@Cache

@CACHE
/**
* @Cache(expires=”tomorrow”)
*/
{
/**
* @Cache(expires=”+5 days”)
*/
public function indexAction()
{
}
}
Establece la cache de Response

@Cache(expires=”tomorrow”)
@Cache(smaxage=”15”)
@Cache(maxage=”15”)
@Cache(vary=[”Cookie”])
$response->setExpires()
$response->setSharedMaxAge()
$response->setMaxAge()
$response->setVary()
@CACHE
Establece la cache de Response

VISTA
@Template

@TEMPLATE
Asocia un método acción con una plantilla
/**
*/
{
/**
* @Template(“DeSymfonyWebBundle:Agenda:agenda.html.twig”)
*/
{
}
}

/**
*/
{
/**
* @Template
*/
{
}
}
@TEMPLATE

/**
*/
{
/**
* @Template(“DeSymfonyWebBundle:Agenda:agenda.html.twig”, vars={“agenda”})
*/
{
}
@TEMPLATE

/**
*/
{
/**
* @Template(vars={“agenda”})
*/
{
}
@TEMPLATE

/**
*/
{
/**
* @Template(engine=”php”)
*/
public function agendaAction($id)
{
}
}
@TEMPLATE

http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/annotations-reference.html
DOCTRINE
http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/annotations.html
http://docs.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/reference/annotations-reference.html
Doctrine Common
Doctrine ORM
Doctrine ODM

DOCTRINE ORM
@Column@Entity @Index @Id @OrderBy@Table
@HasLifecycleCallbacks
@ManyToOne @ManyToMany @OneToOne @OneToMany
@PostLoad @PostPersist @PostRemove@PostUpdate
@PrePersist @PreRemove@PreUpdate

DOCTRINE ORM
@ColumnResult
@ChangeTrackingPolicy
@DiscriminatorColumn
@DiscriminatorMap
@EntityResult
@FieldResult
@GeneratedValue @InheritanceType
@JoinColumns@JoinColumn@JoinTable
@MappedSuperclass
@NamedNativeQuery
@SequenceGenerator
@SqlResultSetMapping
@UniqueConstraint
@Version

SYMFONY2 ~VALIDATOR
use SymfonyComponentValidatorConstraints as Assert;
# app/config/config.yml
framework:
validation: { enable_annotations: true }
Habilitar la validación con anotaciones

SYMFONY2 ~VALIDATOR
@AssertNotBlank
@AssertBlank
@AssertNotNull
@AssertNull
@AssertTrue
@AssertFalse
@AssertType
Restricciones básicas
http://symfony.com/doc/current/book/validation.html

SYMFONY2 ~VALIDATOR
@AssertEmail
@AssertLength
@AssertUrl
@AssertRegex
@AssertIp
Restricciones cadenas de texto

SYMFONY2 ~VALIDATOR
@AssertRange @AssertDate
@AssertDateTime
@AssertTime
Restricciones numéricas Restricciones con fechas

SYMFONY2 ~VALIDATOR
@AssertEqualTo
@AssertNotEqualTo
@AssertIdenticalTo
@AssertNotIdenticalTo
@AssertLessThan
@AssertLessThanOrEqual
@AssertGreaterThan
@AssertGreaterThanOrEqual
Restricciones comparativas

SYMFONY2 ~VALIDATOR
@AssertChoice
@AssertCollection
@AssertCount
@AssertUniqueEntity
@AssertLanguage
@AssertLocale
@AssertCountry
Restricciones de colecciones

SYMFONY2 ~VALIDATOR
@AssertFile @AssertImage
Restricciones de archivos

SYMFONY2 ~VALIDATOR
@AssertCardScheme
@AssertLuhn
@AssertIban
@AssertIsbn
@AssertIssn
Restricciones bancarias y otras numéricas

SYMFONY2 ~VALIDATOR
@AssertCallback
@AssertAll
@AssertUserPassword
@AssertValid
Otras restricciones
@CustomAssert

Agregar las anotaciones con use
use JMSSecurityExtraBundleAnnotationSecure;
use JMSSecurityExtraBundleAnnotationSecureParam;
use JMSSecurityExtraBundleAnnotationSecureReturn;
use JMSSecurityExtraBundleAnnotationRunAs;
use JMSSecurityExtraBundleAnnotationSatisﬁesParentSecurityPolicy;
JMSSECURITYEXTRABUNDLE
Johannes Schmitt

@Secure @SecureParam
JMSSECURITYEXTRABUNDLE
@SecureReturn @RunAs
@SatisﬁesParentSecurityPolicy

@SECURE
/**
*/
{
/**
* @Route(“/editar/{id}”, name=”editar_agenda”)
* @Method({“GET”, “POST”})
* @Secure(roles=”ROLE_EDITOR, ROLE_ADMIN, ROLE_FOO”)
*/
public function editarAction($id)
{
}
Deﬁne quién puede invocar el método

@SECUREPARAM
/**
*/
{
/**
* @SecureParam(name="agenda", permissions="OWNER")
* @Secure(roles=”ROLE_EDITOR, ROLE_ADMIN, ROLE_FOO”)
*/
public function editarAction(Agenda $agenda)
{
}
}
Deﬁne restricciones para los parámetros

@SECURERETURN
// DeSymfony/Bundle/WebBundle/Services/AgendaService.php
class AgendaService
{
/**
* @SecureReturn(permissions=”VIEW”)
*/
public function agendaMethod()
{
return $objeto;
}
}
Deﬁne restricciones para el valor devuelto

@RUNAS
Cambia el ROL de ejecución de un método
class AgendaPublicService
{
protected $agendaPrivateService;
/**
* @Secure(roles=”ROLE_USER”)
* @RunAs(roles=”ROLE_PRIVATE”)
*/
public function agendaMethod()
{
return $this
->agendaPrivateService
->agendaPrivate();
}
}
class AgendaPrivateService
{
/**
* @Secure(role=”ROLE_PRIVATE”)
*/
public function agendaPrivate()
{
// ...
}
}

Ejemplo de @CustomAnnotation
DisableBundle
https://github.com/aferrandini/DisableBundle
Permite deshabilitar un Controlador o una Acción por tiempo y redireccionar a
otra ruta.
@

Mother of God
de las
Anotaciones

@IGNOREANNOTATION
¡Anotación para ignorar anotaciones!
/**
* @IgnoreAnnotation(“AnotacionQueNoExiste”)
*/
{
/**
* @Template(“DeSymfonyWebBundle:Agenda:agenda.html.twig”)
* @AnotacionQueNoExiste
*/
{
}

¿PREGUNTAS?

https://connect.sensiolabs.com/proﬁle/aferrandini
MUCHAS GRACIAS
#deSymfony
@aferrandini
https://joind.in/8849
http://es.linkedin.com/in/arielferrandini https://github.com/aferrandini http://twitter.com/aferrandini

Anotaciones en Symfony. DeSymfony 2013. Ariel Ferrandini

Recomendados

Recomendados

Más contenido relacionado

Similar a Anotaciones en Symfony. DeSymfony 2013. Ariel Ferrandini

Similar a Anotaciones en Symfony. DeSymfony 2013. Ariel Ferrandini (20)

Más de Paradigma Digital

Más de Paradigma Digital (20)

Último

Último (20)

Anotaciones en Symfony. DeSymfony 2013. Ariel Ferrandini