Estas en: Home > esquema

Entradas etiquetadas con esquema

Cron Job WordPress

WordPress 3.x para desarrolladores: Temas y plantillas, theme-options.php

0

Nuestro tema va tomando poco a poco forma. Hoy vamos a crear el archivo theme-options.php que contendrá toda la lógica de las opciones de administración.

 

THEME-OPTIONS.PHP

Creamos el archivo theme-options.php y añadimos el siguiente código:

  1. <?php
  2.  
  3. /**
  4.  * Properly enqueue styles and scripts for our theme options page.
  5.  *
  6.  * This function is attached to the admin_enqueue_scripts action hook.
  7.  */
  8. function newtheme_admin_enqueue_scripts( $hook_suffix ) {
  9. wp_enqueue_style( 'newtheme-theme-options', get_template_directory_uri() . '/inc/theme-options.css', false, '2011-04-28' );
  10. wp_enqueue_script( 'newtheme-theme-options', get_template_directory_uri() . '/inc/theme-options.js', array( 'farbtastic' ), '2011-06-10' );
  11. wp_enqueue_style( 'farbtastic' );
  12. }
  13. add_action( 'admin_print_styles-appearance_page_theme_options', 'newtheme_admin_enqueue_scripts' );

Esta función añade un archivo css y un archivo javascript a la cabecera al apartado apariencia de la administración de WordPress.

  1. <?php
  2.  
  3. /**
  4.  * Register the form setting for our newtheme_options array.
  5.  *
  6.  * This function is attached to the admin_init action hook.
  7.  *
  8.  * This call to register_setting() registers a validation callback, newtheme_theme_options_validate(),
  9.  * which is used when the option is saved, to ensure that our option values are complete, properly
  10.  * formatted, and safe.
  11.  */
  12. function newtheme_theme_options_init() {
  13.  
  14. register_setting(
  15. 'newtheme_options', // Options group, see settings_fields() call in newtheme_theme_options_render_page()
  16. 'newtheme_theme_options', // Database option, see newtheme_get_theme_options()
  17. 'newtheme_theme_options_validate' // The sanitization callback, see newtheme_theme_options_validate()
  18. );
  19.  
  20. // Register our settings field group
  21. add_settings_section(
  22. 'general', // Unique identifier for the settings section
  23. '', // Section title (we don't want one)
  24. '__return_false', // Section callback (we don't want anything)
  25. 'theme_options' // Menu slug, used to uniquely identify the page; see newtheme_theme_options_add_page()
  26. );
  27.  
  28. // Register our individual settings fields
  29. add_settings_field(
  30. 'color_scheme', // Unique identifier for the field for this section
  31. __( 'Color Scheme', 'newtheme' ), // Setting field label
  32. 'newtheme_settings_field_color_scheme', // Function that renders the settings field
  33. 'theme_options', // Menu slug, used to uniquely identify the page; see newtheme_theme_options_add_page()
  34. 'general' // Settings section. Same as the first argument in the add_settings_section() above
  35. );
  36.  
  37. add_settings_field( 'link_color', __( 'Link Color', 'newtheme' ), 'newtheme_settings_field_link_color', 'theme_options', 'general' );
  38. add_settings_field( 'layout', __( 'Default Layout', 'newtheme' ), 'newtheme_settings_field_layout', 'theme_options', 'general' );
  39. }
  40. add_action( 'admin_init', 'newtheme_theme_options_init' );

Esta función registra la configuración por defecto del tema y añade varios apartados para la administración.

  1. <?php
  2.  
  3. /**
  4.  * Change the capability required to save the 'newtheme_options' options group.
  5.  *
  6.  * @see newtheme_theme_options_init() First parameter to register_setting() is the name of the options group.
  7.  * @see newtheme_theme_options_add_page() The edit_theme_options capability is used for viewing the page.
  8.  *
  9.  * By default, the options groups for all registered settings require the manage_options capability.
  10.  * This filter is required to change our theme options page to edit_theme_options instead.
  11.  * By default, only administrators have either of these capabilities, but the desire here is
  12.  * to allow for finer-grained control for roles and users.
  13.  *
  14.  * @param string $capability The capability used for the page, which is manage_options by default.
  15.  * @return string The capability to actually use.
  16.  */
  17. function newtheme_option_page_capability( $capability ) {
  18. return 'edit_theme_options';
  19. }
  20. add_filter( 'option_page_capability_newtheme_options', 'newtheme_option_page_capability' );

Esta función permite cambiar las opciones del tema. Es obligatorio para controlar los diversos usuarios y roles que tengan acceso.

  1. <?php
  2.  
  3. /**
  4.  * Add our theme options page to the admin menu, including some help documentation.
  5.  *
  6.  * This function is attached to the admin_menu action hook.
  7.  */
  8. function newtheme_theme_options_add_page() {
  9. $theme_page = add_theme_page(
  10. __( 'Theme Options', 'newtheme' ), // Name of page
  11. __( 'Theme Options', 'newtheme' ), // Label in menu
  12. 'edit_theme_options', // Capability required
  13. 'theme_options', // Menu slug, used to uniquely identify the page
  14. 'newtheme_theme_options_render_page' // Function that renders the options page
  15. );
  16.  
  17. if ( ! $theme_page )
  18. return;
  19.  
  20. add_action( "load-$theme_page", 'newtheme_theme_options_help' );
  21. }
  22. add_action( 'admin_menu', 'newtheme_theme_options_add_page' );

Añade la página de opciones de nuestro tema al menú de administración, incluyendo algo de documentación a la ayuda.

  1. <?php
  2.  
  3. function newtheme_theme_options_help() {
  4.  
  5. $help = '<p>' . __( 'Some themes provide customization options that are grouped together on a Theme Options screen. If you change themes, options may change or disappear, as they are theme-specific. Your current theme, Twenty Eleven, provides the following Theme Options:', 'newtheme' ) . '</p>' .
  6. '<ol>' .
  7. '<li>' . __( '<strong>Color Scheme</strong>: You can choose a color palette of "Light" (light background with dark text) or "Dark" (dark background with light text) for your site.', 'newtheme' ) . '</li>' .
  8. '<li>' . __( '<strong>Link Color</strong>: You can choose the color used for text links on your site. You can enter the HTML color or hex code, or you can choose visually by clicking the "Select a Color" button to pick from a color wheel.', 'newtheme' ) . '</li>' .
  9. '<li>' . __( '<strong>Default Layout</strong>: You can choose if you want your site&#8217;s default layout to have a sidebar on the left, the right, or not at all.', 'newtheme' ) . '</li>' .
  10. '</ol>' .
  11. '<p>' . __( 'Remember to click "Save Changes" to save any changes you have made to the theme options.', 'newtheme' ) . '</p>';
  12.  
  13. $sidebar = '<p><strong>' . __( 'For more information:', 'newtheme' ) . '</strong></p>' .
  14. '<p>' . __( '<a href="http://codex.wordpress.org/Appearance_Theme_Options_Screen" target="_blank">Documentation on Theme Options</a>', 'newtheme' ) . '</p>' .
  15. '<p>' . __( '<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>', 'newtheme' ) . '</p>';
  16.  
  17. $screen = get_current_screen();
  18.  
  19. if ( method_exists( $screen, 'add_help_tab' ) ) {
  20. // WordPress 3.3
  21. $screen->add_help_tab( array(
  22. 'title' => __( 'Overview', 'newtheme' ),
  23. 'id' => 'theme-options-help',
  24. 'content' => $help,
  25. )
  26. );
  27.  
  28. $screen->set_help_sidebar( $sidebar );
  29. } else {
  30. // WordPress 3.2
  31. add_contextual_help( $screen, $help . $sidebar );
  32. }
  33. }

Esta es la función que añade la ayuda que comentaba en la función anterior. Aquí además podemos ver como se añade un condicional para añadir retrocompatibilidad con versiones anteriores a la 3.3 y la 3.2.

  1. <?php
  2.  
  3. /**
  4.  * Returns an array of color schemes registered for New Theme.
  5.  */
  6. function newtheme_color_schemes() {
  7. $color_scheme_options = array(
  8. 'light' => array(
  9. 'value' => 'light',
  10. 'label' => __( 'Light', 'newtheme' ),
  11. 'thumbnail' => get_template_directory_uri() . '/inc/images/light.png',
  12. 'default_link_color' => '#1b8be0',
  13. ),
  14. 'dark' => array(
  15. 'value' => 'dark',
  16. 'label' => __( 'Dark', 'newtheme' ),
  17. 'thumbnail' => get_template_directory_uri() . '/inc/images/dark.png',
  18. 'default_link_color' => '#e4741f',
  19. ),
  20. );
  21.  
  22. return apply_filters( 'newtheme_color_schemes', $color_scheme_options );
  23. }

Esta función devuelve un array con los esquemas de color para cada versión del tema.

  1. <?php
  2.  
  3. /**
  4.  * Returns an array of layout options registered for New Theme.
  5.  */
  6. function newtheme_layouts() {
  7. $layout_options = array(
  8. 'content-sidebar' => array(
  9. 'value' => 'content-sidebar',
  10. 'label' => __( 'Content on left', 'newtheme' ),
  11. 'thumbnail' => get_template_directory_uri() . '/inc/images/content-sidebar.png',
  12. ),
  13. 'sidebar-content' => array(
  14. 'value' => 'sidebar-content',
  15. 'label' => __( 'Content on right', 'newtheme' ),
  16. 'thumbnail' => get_template_directory_uri() . '/inc/images/sidebar-content.png',
  17. ),
  18. 'content' => array(
  19. 'value' => 'content',
  20. 'label' => __( 'One-column, no sidebar', 'newtheme' ),
  21. 'thumbnail' => get_template_directory_uri() . '/inc/images/content.png',
  22. ),
  23. );
  24.  
  25. return apply_filters( 'newtheme_layouts', $layout_options );
  26. }

Devuelve un array con las opciones para cada tipo de estructura del diseño.

  1. <?php
  2.  
  3. /**
  4.  * Returns the default options for New Theme.
  5.  */
  6. function newtheme_get_default_theme_options() {
  7. $default_theme_options = array(
  8. 'color_scheme' => 'light',
  9. 'link_color' => newtheme_get_default_link_color( 'light' ),
  10. 'theme_layout' => 'content-sidebar',
  11. );
  12.  
  13. if ( is_rtl() )
  14. $default_theme_options['theme_layout'] = 'sidebar-content';
  15.  
  16. return apply_filters( 'newtheme_default_theme_options', $default_theme_options );
  17. }

Devuelve las opciones por defecto del tema.

  1. <?php
  2.  
  3. /**
  4.  * Returns the default link color for New Theme, based on color scheme.
  5.  *
  6.  *
  7.  * @param $string $color_scheme Color scheme. Defaults to the active color scheme.
  8.  * @return $string Color.
  9. */
  10. function newtheme_get_default_link_color( $color_scheme = null ) {
  11. if ( null === $color_scheme ) {
  12. $options = newtheme_get_theme_options();
  13. $color_scheme = $options['color_scheme'];
  14. }
  15.  
  16. $color_schemes = newtheme_color_schemes();
  17. if ( ! isset( $color_schemes[ $color_scheme ] ) )
  18. return false;
  19.  
  20. return $color_schemes[ $color_scheme ]['default_link_color'];
  21. }

Devuelve el color por defecto para los vínculos.

  1. <?php
  2.  
  3. /**
  4.  * Returns the options array for New Theme.
  5.  */
  6. function newtheme_get_theme_options() {
  7. return get_option( 'newtheme_theme_options', newtheme_get_default_theme_options() );
  8. }

Devuelve un array con todas las opciones del tema.

  1. <?php
  2.  
  3. /**
  4.  * Renders the Color Scheme setting field.
  5.  */
  6. function newtheme_settings_field_color_scheme() {
  7. $options = newtheme_get_theme_options();
  8.  
  9. foreach ( newtheme_color_schemes() as $scheme ) {
  10. ?>
  11. <div class="layout image-radio-option color-scheme">
  12. <label class="description">
  13. <input type="radio" name="newtheme_theme_options[color_scheme]" value="<?php echo esc_attr( $scheme['value'] ); ?>" <?php checked( $options['color_scheme'], $scheme['value'] ); ?> />
  14. <input type="hidden" id="default-color-<?php echo esc_attr( $scheme['value'] ); ?>" value="<?php echo esc_attr( $scheme['default_link_color'] ); ?>" />
  15. <span>
  16. <img src="<?php echo esc_url( $scheme['thumbnail'] ); ?>" width="136" height="122" alt="" />
  17. <?php echo $scheme['label']; ?>
  18. </span>
  19. </label>
  20. </div>
  21. <?php
  22. }
  23. }

Esta función genera el grupo de radio buttons que permitirá elegir entre un esquema de color u otro.

  1. <?php
  2.  
  3. /**
  4.  * Renders the Link Color setting field.
  5.  */
  6. function newtheme_settings_field_link_color() {
  7. $options = newtheme_get_theme_options();
  8. ?>
  9. <input type="text" name="newtheme_theme_options[link_color]" id="link-color" value="<?php echo esc_attr( $options['link_color'] ); ?>" />
  10. <a href="#" class="pickcolor hide-if-no-js" id="link-color-example"></a>
  11. <input type="button" class="pickcolor button hide-if-no-js" value="<?php esc_attr_e( 'Select a Color', 'newtheme' ); ?>" />
  12. <div id="colorPickerDiv" style="z-index: 100; background:#eee; border:1px solid #ccc; position:absolute; display:none;"></div>
  13. <br />
  14. <span><?php printf( __( 'Default color: %s', 'newtheme' ), '<span id="default-color">' . newtheme_get_default_link_color( $options['color_scheme'] ) . '</span>' ); ?></span>
  15. <?php
  16. }

Esta función genera el formulario para poder elegir el color de los vínculos.

  1. <?php
  2.  
  3. /**
  4.  * Renders the Layout setting field.
  5.  */
  6. function newtheme_settings_field_layout() {
  7. $options = newtheme_get_theme_options();
  8. foreach ( newtheme_layouts() as $layout ) {
  9. ?>
  10. <div class="layout image-radio-option theme-layout">
  11. <label class="description">
  12. <input type="radio" name="newtheme_theme_options[theme_layout]" value="<?php echo esc_attr( $layout['value'] ); ?>" <?php checked( $options['theme_layout'], $layout['value'] ); ?> />
  13. <span>
  14. <img src="<?php echo esc_url( $layout['thumbnail'] ); ?>" width="136" height="122" alt="" />
  15. <?php echo $layout['label']; ?>
  16. </span>
  17. </label>
  18. </div>
  19. <?php
  20. }
  21. }

Esta función genera el campo para elegir la estructura del blog.

  1. <?php
  2.  
  3. /**
  4.  * Returns the options array for New Theme.
  5.  */
  6. function newtheme_theme_options_render_page() {
  7. ?>
  8. <div class="wrap">
  9. <?php screen_icon(); ?>
  10. <?php $theme_name = function_exists( 'wp_get_theme' ) ? wp_get_theme() : get_current_theme(); ?>
  11. <h2><?php printf( __( '%s Theme Options', 'newtheme' ), $theme_name ); ?></h2>
  12. <?php settings_errors(); ?>
  13.  
  14. <form method="post" action="options.php">
  15. <?php
  16. settings_fields( 'newtheme_options' );
  17. do_settings_sections( 'theme_options' );
  18. submit_button();
  19. ?>
  20. </form>
  21. </div>
  22. <?php
  23. }

Función que genera todo el formulario de opciones.

  1. <?php
  2.  
  3. /**
  4.  * Sanitize and validate form input. Accepts an array, return a sanitized array.
  5.  *
  6.  * @see newtheme_theme_options_init()
  7.  * @todo set up Reset Options action
  8.  */
  9. function newtheme_theme_options_validate( $input ) {
  10. $output = $defaults = newtheme_get_default_theme_options();
  11.  
  12. // Color scheme must be in our array of color scheme options
  13. if ( isset( $input['color_scheme'] ) && array_key_exists( $input['color_scheme'], newtheme_color_schemes() ) )
  14. $output['color_scheme'] = $input['color_scheme'];
  15.  
  16. // Our defaults for the link color may have changed, based on the color scheme.
  17. $output['link_color'] = $defaults['link_color'] = newtheme_get_default_link_color( $output['color_scheme'] );
  18.  
  19. // Link color must be 3 or 6 hexadecimal characters
  20. if ( isset( $input['link_color'] ) && preg_match( '/^#?([a-f0-9]{3}){1,2}$/i', $input['link_color'] ) )
  21. $output['link_color'] = '#' . strtolower( ltrim( $input['link_color'], '#' ) );
  22.  
  23. // Theme layout must be in our array of theme layout options
  24. if ( isset( $input['theme_layout'] ) && array_key_exists( $input['theme_layout'], newtheme_layouts() ) )
  25. $output['theme_layout'] = $input['theme_layout'];
  26.  
  27. return apply_filters( 'newtheme_theme_options_validate', $output, $input, $defaults );
  28. }

Esta función valida que los datos del formulario son correctos.

  1. <?php
  2.  
  3. /**
  4.  * Enqueue the styles for the current color scheme.
  5.  */
  6. function newtheme_enqueue_color_scheme() {
  7. $options = newtheme_get_theme_options();
  8. $color_scheme = $options['color_scheme'];
  9.  
  10. if ( 'dark' == $color_scheme )
  11. wp_enqueue_style( 'dark', get_template_directory_uri() . '/colors/dark.css', array(), null );
  12.  
  13. do_action( 'newtheme_enqueue_color_scheme', $color_scheme );
  14. }
  15. add_action( 'wp_enqueue_scripts', 'newtheme_enqueue_color_scheme' );

Función que cambiará el estilo actual de la página dependiendo del color de esquema elegido.

  1. <?php
  2.  
  3. /**
  4.  * Add a style block to the theme for the current link color.
  5.  *
  6.  * This function is attached to the wp_head action hook.
  7.  */
  8. function newtheme_print_link_color_style() {
  9. $options = newtheme_get_theme_options();
  10. $link_color = $options['link_color'];
  11.  
  12. $default_options = newtheme_get_default_theme_options();
  13.  
  14. // Don't do anything if the current link color is the default.
  15. if ( $default_options['link_color'] == $link_color )
  16. return;
  17. ?>
  18. <style>
  19. /* Link color */
  20. a,
  21. #site-title a:focus,
  22. #site-title a:hover,
  23. #site-title a:active,
  24. .entry-title a:hover,
  25. .entry-title a:focus,
  26. .entry-title a:active,
  27. .widget_newtheme_ephemera .comments-link a:hover,
  28. section.recent-posts .other-recent-posts a[rel="bookmark"]:hover,
  29. section.recent-posts .other-recent-posts .comments-link a:hover,
  30. .format-image footer.entry-meta a:hover,
  31. #site-generator a:hover {
  32. color: <?php echo $link_color; ?>;
  33. }
  34. section.recent-posts .other-recent-posts .comments-link a:hover {
  35. border-color: <?php echo $link_color; ?>;
  36. }
  37. article.feature-image.small .entry-summary p a:hover,
  38. .entry-header .comments-link a:hover,
  39. .entry-header .comments-link a:focus,
  40. .entry-header .comments-link a:active,
  41. .feature-slider a.active {
  42. background-color: <?php echo $link_color; ?>;
  43. }
  44. </style>
  45. <?php
  46. }
  47. add_action( 'wp_head', 'newtheme_print_link_color_style' );

Función que añadirá el color a los vínculos a través de los estilos si este no es el mismo que el de defecto.

  1. <?php
  2.  
  3. /**
  4.  * Adds New Theme layout classes to the array of body classes.
  5.  */
  6. function newtheme_layout_classes( $existing_classes ) {
  7. $options = newtheme_get_theme_options();
  8. $current_layout = $options['theme_layout'];
  9.  
  10. if ( in_array( $current_layout, array( 'content-sidebar', 'sidebar-content' ) ) )
  11. $classes = array( 'two-column' );
  12. else
  13. $classes = array( 'one-column' );
  14.  
  15. if ( 'content-sidebar' == $current_layout )
  16. $classes[] = 'right-sidebar';
  17. elseif ( 'sidebar-content' == $current_layout )
  18. $classes[] = 'left-sidebar';
  19. else
  20. $classes[] = $current_layout;
  21.  
  22. $classes = apply_filters( 'newtheme_layout_classes', $classes, $current_layout );
  23.  
  24. return array_merge( $existing_classes, $classes );
  25. }
  26. add_filter( 'body_class', 'newtheme_layout_classes' );

Esta función añade las clases correspondientes a la etiqueta body dependiendo de la estructura de blog elegida.

  1. <?php
  2.  
  3. /**
  4.  * Implements New Theme theme options into Theme Customizer
  5.  *
  6.  * @param $wp_customize Theme Customizer object
  7.  * @return void
  8.  */
  9. function newtheme_customize_register( $wp_customize ) {
  10. $wp_customize->get_setting( 'blogname' )->transport = 'postMessage';
  11. $wp_customize->get_setting( 'blogdescription' )->transport = 'postMessage';
  12.  
  13. $options = newtheme_get_theme_options();
  14. $defaults = newtheme_get_default_theme_options();
  15.  
  16. $wp_customize->add_setting( 'newtheme_theme_options[color_scheme]', array(
  17. 'default' => $defaults['color_scheme'],
  18. 'type' => 'option',
  19. 'capability' => 'edit_theme_options',
  20. ) );
  21.  
  22. $schemes = newtheme_color_schemes();
  23. $choices = array();
  24. foreach ( $schemes as $scheme ) {
  25. $choices[ $scheme['value'] ] = $scheme['label'];
  26. }
  27.  
  28. $wp_customize->add_control( 'newtheme_color_scheme', array(
  29. 'label' => __( 'Color Scheme', 'newtheme' ),
  30. 'section' => 'colors',
  31. 'settings' => 'newtheme_theme_options[color_scheme]',
  32. 'type' => 'radio',
  33. 'choices' => $choices,
  34. 'priority' => 5,
  35. ) );
  36.  
  37. // Link Color (added to Color Scheme section in Theme Customizer)
  38. $wp_customize->add_setting( 'newtheme_theme_options[link_color]', array(
  39. 'default' => newtheme_get_default_link_color( $options['color_scheme'] ),
  40. 'type' => 'option',
  41. 'sanitize_callback' => 'sanitize_hex_color',
  42. 'capability' => 'edit_theme_options',
  43. ) );
  44.  
  45. $wp_customize->add_control( new WP_Customize_Color_Control( $wp_customize, 'link_color', array(
  46. 'label' => __( 'Link Color', 'newtheme' ),
  47. 'section' => 'colors',
  48. 'settings' => 'newtheme_theme_options[link_color]',
  49. ) ) );
  50.  
  51. // Default Layout
  52. $wp_customize->add_section( 'newtheme_layout', array(
  53. 'title' => __( 'Layout', 'newtheme' ),
  54. 'priority' => 50,
  55. ) );
  56.  
  57. $wp_customize->add_setting( 'newtheme_theme_options[theme_layout]', array(
  58. 'type' => 'option',
  59. 'default' => $defaults['theme_layout'],
  60. 'sanitize_callback' => 'sanitize_key',
  61. ) );
  62.  
  63. $layouts = newtheme_layouts();
  64. $choices = array();
  65. foreach ( $layouts as $layout ) {
  66. $choices[$layout['value']] = $layout['label'];
  67. }
  68.  
  69. $wp_customize->add_control( 'newtheme_theme_options[theme_layout]', array(
  70. 'section' => 'newtheme_layout',
  71. 'type' => 'radio',
  72. 'choices' => $choices,
  73. ) );
  74. }
  75. add_action( 'customize_register', 'newtheme_customize_register' );

Esta función añade todas las opciones al personalizador de temas.

  1. <?php
  2.  
  3. /**
  4.  * Bind JS handlers to make Theme Customizer preview reload changes asynchronously.
  5.  * Used with blogname and blogdescription.
  6.  */
  7. function newtheme_customize_preview_js() {
  8. wp_enqueue_script( 'newtheme-customizer', get_template_directory_uri() . '/inc/theme-customizer.js', array( 'customize-preview' ), '20120523', true );
  9. }
  10. add_action( 'customize_preview_init', 'newtheme_customize_preview_js' );

Esta función indica a WordPress que añada un archivo javascript para la previsualización de la página para poder ver los cambios del tema.

Symfony: El modelo (III)

0

CONEXIONES A LA BASE DE DATOS

  1. > php symfony configure:database "mysql://login:password@localhost/blog"
  1. > php symfony --env=prod configure:database "mysql://login:password@localhost/blog"
  1. > php symfony --app=frontend configure:database "mysql://login:password@localhost/blog"

 

  1. > php symfony --name=otraconexion configure:database "mysql://login:password@localhost/blog"

 

Las opciones de conexión con la base de datos también se pueden establecer manualmente en el archivo databases.yml que se encuentra en el directorio config/.

 

  1. all:
  2. propel:
  3. class: sfPropelDatabase
  4. param:
  5. dsn: mysql://login:password@localhost/blog
  1. prod:
  2. propel:
  3. param:
  4. hostspec: mi_servidor_datos
  5. usuarioname: mi_nombre_usuario
  6. password: xxxxxxxxxx
  7.  
  8. all:
  9. propel:
  10. class: sfPropelDatabase
  11. param:
  12. phptype: mysql # fabricante de la base de datos
  13. hostspec: localhost
  14. database: blog
  15. usuarioname: login
  16. password: passwd
  17. port: 80
  18. encoding: utf8 # Codificación utilizada para crear la tabla
  19. persistent: true # Utilizar conexiones persistentes

Los valores permitidos para el parámetro phptype corresponden a los tipos de bases de datos soportados por PDO:

  • mysql
  • mssql
  • pgsql
  • sqlite
  • oracle

Si se utiliza una base de datos de tipo SQLite, el parámetro hostspec debe indicar la ruta al archivo de base de datos.

  1. all:
  2. propel:
  3. class: sfPropelDatabase
  4. param:
  5. phptype: sqlite
  6. database: %SF_DATA_DIR%/blog.db

 

EXTENDER EL MODELO

Los métodos del modelo que se generan automáticamente están muy bien, pero no siempre son suficientes. Si se incluye lógica de negocio propia, es necesario extender el modelo añadiendo nuevos métodos o redefiniendo algunos de los existentes.

 

AÑADIR NUEVOS MÉTODOS

Los nuevos métodos se pueden añadir en las clases vacías del modelo que se generan en el directorio lib/model/. Se emplea $this para invocar a los métodos del objeto actual y self:: para invocar a los métodos estáticos de la clase actual. No se debe olvidar que las clases personalizadas heredan los métodos de las clases Base del directorio lib/model/om/.

  1. <?
  2.  
  3. class Articulo extends BaseArticulo
  4. {
  5. public function __toString()
  6. {
  7. return $this->getTitulo(); // getTitulo() se hereda de BaseArticulo
  8. }
  9. }

También se pueden extender las clases peer, como por ejemplo para obtener todos los artículos ordenados por fecha de creación:

  1. <?
  2.  
  3. class ArticuloPeer extends BaseArticuloPeer
  4. {
  5. public static function getTodosOrdenadosPorFecha()
  6. {
  7. $c = new Criteria();
  8. $c->addAscendingOrderByColumn(self::CREATED_AT);
  9. return self::doSelect($c);
  10. }
  11. }

 

  1. <?
  2.  
  3. foreach (ArticuloPeer::getTodosOrdenadosPorFecha() as $articulo)
  4. {
  5. echo $articulo; // Se llama al método mágico __toString()
  6. }

 

REDEFINIR MÉTODOS EXISTENTES

Si alguno de los métodos generados automáticamente en las clases Base no satisfacen las necesidades de la aplicación, se pueden redefinir en las clases personalizadas. Solamente es necesario mantener el mismo número de argumentos para cada método.

Por ejemplo, el método $articulo->getComentarios() devuelve un array de objetos Comentario, sin ningún tipo de ordenamiento. Si se necesitan los resultados ordenados por fecha de creación siendo el primero el comentario más reciente, se puede redefinir el método getComentarios(). Como el método getComentarios() original (guardado en lib/model/om/BaseArticulo.php) requiere como argumentos un objeto de tipo Criteria y una conexión, la nueva función debe contener esos mismos parámetros.

  1. <?
  2.  
  3. public function getComentarios($criteria = null, $con = null)
  4. {
  5. if (is_null($criteria))
  6. {
  7. $criteria = new Criteria();
  8. }
  9. else
  10. {
  11. // Los objetos se pasan por referencia en PHP5, por lo que se debe clonar
  12. // el objeto original para no modificarlo
  13. $criteria = clone $criteria;
  14. }
  15. $criteria->addDescendingOrderByColumn(ComentarioPeer::CREATED_AT);
  16.  
  17. return parent::getComentarios($criteria, $con);
  18. }

El método personalizado acaba llamando a su método padre en la clase Base, lo que se considera una buena práctica. No obstante, es posible saltarse completamente la clase Base y devolver el resultado directamente.

 

USO DE COMPORTAMIENTOS EN EL MODELO

Algunas de las modificaciones que se realizan en el modelo son genéricas y por tanto se pueden reutilizar. Por ejemplo, los métodos que hacen que un objeto del modelo sea reordenable o un bloqueo de tipo optimistic en la base de datos para evitar conflictos cuando se guardan de forma concurrente los objetos se pueden considerar extensiones genéricas que se pueden añadir a muchas clases.

Symfony encapsula estas extensiones en «comportamientos» (del inglés behaviors). Los comportamientos son clases externas que proporcionan métodos extras a las clases del modelo. Las clases del modelo están definidas de forma que se puedan enganchar estas clases externas y Symfony extiende las clases del modelo mediante sfMixer.

Para habilitar los comportamientos en las clases del modelo, se debe modificar una opción del archivo config/propel.ini:

propel.builder.AddBehaviors = true // El valor por defecto es false

Symfony no incluye por defecto ningún comportamiento, pero se pueden instalar mediante plugins. Una vez que el plugin se ha instalado, se puede asignar un comportamiento a una clase mediante una sola línea de código. Si por ejemplo se ha instalado el plugin sfPropelParanoidBehaviorPlugin en la aplicación, se puede extender la clase Articulo con este comportamiento añadiendo la siguiente línea de código al final del archivo Articulo.class.php:

  1. <?
  2.  
  3. sfPropelBehavior::add('Articulo', array(
  4. 'paranoid' => array('column' => 'deleted_at')
  5. ));

 

Después de volver a generar el modelo, los objetos de tipo Articulo que se borren permanecerán en la base de datos, aunque será invisibles a las consultas que hacen uso de los métodos del ORM, a no ser que se deshabilite temporalmente el comportamiento mediante sfPropelParanoidBehavior::disable().

Desde la versión 1.1 de Symfony también es posible declarar los comportamientos directamente en el archivo schema.yml, incluyéndolos bajo la clave _behaviors.

La lista de plugins de Symfony disponible en el wiki incluye numerosos comportamientos http://trac.symfony-project.org/wiki/SymfonyPlugins#Behaviors. Cada comportamiento tiene su propia documentación y su propia guía de instalación.

 

SINTAXIS EXTENDIDA DEL ESQUEMA

Atributos

Se pueden definir atributos específicos para las conexiones y las tablas. Estas opciones se establecen bajo la clave _attributes.

  1. propel:
  2. _attributes: { noXsd: false, defaultIdMethod: none, package: lib.model }
  3. blog_articulo:
  4. _attributes: { phpName: Articulo }

Si se quiere validar el esquema antes de que se genere el código asociado, se debe desactivar en la conexión el atributo noXSD. La conexión también permite que se le indique el atributo defaultIdMethod. Si no se indica, se utilizará el método nativo de generación de IDs –por ejemplo, autoincrement en MySQL o sequences en PostgreSQL. El otro valor permitido es none.

El atributo package es como un namespace; indica la ruta donde se guardan las clases generadas automáticamente. Su valor por defecto es lib/model/, pero se puede modificar para organizar el modelo en una estructura de subpaquetes. Si por ejemplo no se quieren mezclar en el mismo directorio las clases del núcleo de la aplicación con las clases de un sistema de estadísticas, se pueden definir dos esquemas diferentes con los paquetes lib.model.business y lib.model.stats.

Ya se ha visto el atributo de tabla phpName, que se utiliza para establecer el nombre de la clase generada automáticamente para manejar cada tabla de la base de datos.

Las tablas que guardan contenidos adaptados para diferentes idiomas (es decir, varias versiones del mismo contenido en una tabla relacionada, para conseguir la internacionalización) también pueden definir dos atributos adicionales.

  1. propel:
  2. blog_articulo:
  3. _attributes: { isI18N: true, i18nTable: db_group_i18n }

 

DETALLE DE LAS COLUMNAS

La sintaxis básica ofrece dos posibilidades: dejar que Symfony deduzca las características de una columna a partir de su nombre (indicando un valor vacío para esa columna) o definir el tipo de columna con uno de los tipos predefinidos.

  1. propel:
  2. blog_articulo:
  3. id: # Symfony se encarga de esta columna
  4. titulo: varchar(50) # Definir el tipo explícitamente

Se pueden definir muchos más aspectos de cada columna. Si se definen, se utiliza un array asociativo para indicar las opciones de la columna.

  1. propel:
  2. blog_articulo:
  3. id: { type: integer, required: true, primaryKey: true, autoIncrement: true }
  4. name: { type: varchar(50), default: foobar, index: true }
  5. group_id: { type: integer, foreignTable: db_group, foreignReference: id, onDelete: cascade }

Los parámetros de las columnas son los siguientes:

  • type: Tipo de columna. Se puede elegir entre boolean, tinyint, smallint, integer, bigint, double, float, real, decimal, char, varchar(tamano), longvarchar, date, time, timestamp, bu_date, bu_timestamp, blob y clob
  • required: valor booleano. Si vale true la columna debe tener obligatoriamente un valor.
  • default: el valor por defecto.
  • primaryKey: valor booleano. Si vale true indica que es una clave primaria.
  • autoIncrement: valor booleano. Si se indica true para las columnas de tipo integer, su valor se auto-incrementará.
  • sequence: el nombre de la secuencia para las bases de datos que utilizan secuencias para las columnas autoIncrement (por ejemplo PostgreSQL y Oracle).
  • index: valor booleano. Si vale true, se construye un índice simple; si vale unique se construye un índice único para la columna.
  • foreignTable: el nombre de una tabla, se utiliza para crear una clave externa a otra tabla.
  • foreignReference: el nombre de la columna relacionada si las claves externas se definen mediante foreignTable.
  • onDelete: determina la acción que se ejecuta cuando se borra un registro en una tabla relacionada. Si su valor es setnull, la columna de la clave externa se establece a null. Si su valor es cascade, se borra el registro relacionado. Si el sistema gestor de bases de datos no soporta este comportamiento, el ORM lo emula. Esta opción solo tiene sentido para las columnas que definen una foreignTable y una foreignReference.
  • isCulture: valor booleano. Su valor es true para las columnas de tipo culture en las tablas de contenidos adaptados a otros idiomas.

 

CLAVES EXTERNAS

Además de los atributos de columna foreignTable y foreignReference, es posible añadir claves externas bajo la clave _foreignKeys: de cada tabla.

  1. propel:
  2. blog_articulo:
  3. id:
  4. titulo: varchar(50)
  5. usuario_id: { type: integer }
  6. _foreignKeys:
  7. -
  8. foreignTable: blog_usuario
  9. onDelete: cascade
  10. references:
  11. - { local: usuario_id, foreign: id }

La sintaxis alternativa es muy útil para las claves externas múltiples y para indicar un nombre a cada clave externa.

  1. _foreignKeys:
  2. mi_clave_externa:
  3. foreignTable: db_usuario
  4. onDelete: cascade
  5. references:
  6. - { local: usuario_id, foreign: id }
  7. - { local: post_id, foreign: id }

 

INDICES

Además del atributo de columna index, es posible añadir claves índices bajo la clave _indexes: de cada tabla. Si se quieren crean índices únicos, se debe utilizar la clave _uniques:. En las columnas que requieren un tamaño, por ejemplo por ser columnas de texto, el tamaño del índice se indica entre paréntesis, de la misma forma que se indica el tamaño de cualquier columna.

  1. propel:
  2. blog_articulo:
  3. id:
  4. titulo: varchar(50)
  5. created_at:
  6. _indexes:
  7. mi_indice: [titulo(10), usuario_id]
  8. _uniques:
  9. mi_otro_indice: [created_at]

 

COLUMNAS VACÍAS

Cuando Symfony se encuentra con una columna sin ningún valor, utiliza algo de magia para determinar su valor.

  1. // Las columnas vacías llamadas "id" se consideran claves primarias
  2. id: { type: integer, required: true, primaryKey: true, autoIncrement: true }
  3.  
  4. // Las columnas vacías llamadas "XXX_id" se consideran claves externas
  5. loquesea_id: { type: integer, foreignTable: db_loquesea, foreignReference: id }
  6.  
  7. // Las columnas vacías llamadas created_at, updated at, created_on y updated_on
  8. // se consideran fechas y automáticamente se les asigna el tipo "timestamp"
  9. created_at: { type: timestamp }
  10. updated_at: { type: timestamp }

Para las claves externas, Symfony busca una tabla cuyo phpName sea igual al principio del nombre de la columna; si se encuentra, se utiliza ese nombre de tabla como foreignTable.

 

TABLAS I18N

Symfony permite internacionalizar los contenidos mediante tablas relacionadas. De esta forma, cuando se dispone de contenido que debe ser internacionalizado, se guarda en 2 tablas distintas: una contiene las columnas invariantes y otra las columnas que permiten la internacionalización.

Todo lo anterior se considera de forma implícita cuando en el archivo schema.yml se dispone de una tabla con el nombre cualquiernombre_i18n.

  1. propel:
  2. db_group:
  3. id:
  4. created_at:
  5.  
  6. db_group_i18n:
  7. name: varchar(50)
  1. propel:
  2. db_group:
  3. _attributes: { isI18N: true, i18nTable: db_group_i18n }
  4. id:
  5. created_at:
  6.  
  7. db_group_i18n:
  8. id: { type: integer, required: true, primaryKey: true, foreignTable: db_group, foreignReference: id, onDelete: cascade }
  9. culture: { isCulture: true, type: varchar(7), required: true, primaryKey: true }
  10. name: varchar(50)

 

COMPORTAMIENTOS

Los comportamientos son plugins que modifican el modelo de datos para añadir nuevas funcionalidades a las clases de Propel.

  1. propel:
  2. blog_articulo:
  3. titulo: varchar(50)
  4. _behaviors:
  5. paranoid: { column: deleted_at }

 

Ir arriba