Changeset 8065

Timestamp:

03/24/08 22:20:29 (5 years ago)

Author:

naholyr

Message:

[sfPropelActAsSignableBehaviorPlugin]
- refactoring (better use of getPeer() method)
- check isModifiedColumn() and added options to customize this behavior

Files:

• plugins/sfPropelActAsSignableBehaviorPlugin/trunk/README (modified) (3 diffs)
• plugins/sfPropelActAsSignableBehaviorPlugin/trunk/lib/sfPropelActAsSignableBehavior.class.php (modified) (13 diffs)
• plugins/sfPropelActAsSignableBehaviorPlugin/trunk/package.xml (modified) (1 diff)

plugins/sfPropelActAsSignableBehaviorPlugin/trunk/README

@@ -15 +15 @@
-      symfony plugin-install http://plugins.symfony-project.com/sfPropelActAsSignableBehaviorPlugin
-    }}}
+    
+    Like any other plugin, you can either extract one of the attached archives, or use Subversion.
-  
-  * Add the desired columns to your schema.yml for the tables you want to be signed. You can use a string or 
@@ -66 +68 @@
-        
-        sfPropelBehavior::add('ForumPost', array(
-lugg
+ign
-            'columns' => $columns_map
-          )
-        ); 
-    }}}
-    
-    The `columns map` is used by the behavior to know which columns hold information it needs :
-
-      * created : Model column holding the creator of the object, default is `created_by`.
-      * updated : Model column holding the last user who updated the object, default is `updated_by`.
-      * deleted : Model column holding the user who deleted the object, default is `deleted_by`.
-
-    The `user methods` is used by the behavior to know what method of the `myUser` class must be called
-    to retrieve the wanted information.
-    
-      * id :     Method called to retrieve the user's ID, to fill integer `*_by` columns, default is `getId()`.
-      * string : Method called to retrieve the string representation of the user, to fill string `*_by` columns, default is `__toString()`.
-    
-  * Add the needed methods to your `myUser` class (file located in `apps/myApp/lib/myUser.class.php`) :
@@ -98 +88 @@
-      }
-    }}}
+    
+    You can use different names for those methods, you can even use different methods for each
+    of your "signable" tables : See next section (options).
+
+=== Options ===
+
+The generic way to add the behavior to your table is 
+
+{{{
+  sfPropelBehavior::add('MyClass', array(
+    'sfPropelActAsSignableBehavior' => $options
+  ); 
+}}}
+    
+The `$options` array represents the options passed to customize the behavior to your needs. 
+
+The __`columns`__ index represents the columns mapping, which is used by the behavior to know which columns 
+hold information it needs :
+
+  * __`created`__ : Model column holding the creator of the object, default is `created_by`.
+  * __`updated`__ : Model column holding the last user who updated the object, default is `updated_by`.
+  * __`deleted`__ : Model column holding the user who deleted the object, default is `deleted_by`.
+
+The __`userMethods`__ index is used by the behavior to know what method of the `myUser` class must be called
+to retrieve the wanted information.
+
+  * __`id`__ :     Method called to retrieve the user's ID, to fill integer `*_by` columns, default is `getId()`.
+  * __`string`__ : Method called to retrieve the string representation of the user, to fill string `*_by` columns, default is `__toString()`.
+
+The __`updateModifiedColumn`__ is set to true if you want the behavior to overwrite the value of columns
+even if they are already marked as modified (i.e. if you set this option to true, you will not be able to
+customize the value of those columns in your auto-generated admin modules). Default value is false.
+
+The __`updateEmptyColumn`__ is set to true if you want the behavior to set the value of empty columns, even
+if they are already marked sas modified (i.e. if you set this option to true, your username will be stored
+if you let the field empty in your auto-generated admin modules). Default value is true.
+
+The full options are represented here with their default values :
+
+{{{
+  array(
+    'columns' => array(
+      'created' => 'created_by',
+      'updated' => 'updated_by',
+      'deleted' => 'deleted_by',
+    ),
+    'userMethods' => array(
+      'string' => '__toString',
+      'id'     => 'getId',
+    ),
+    'updateModifiedColumn' => false,
+    'updateEmptyColumn' => true,
+  )
+}}}
+
-
-== Dependencies ==

plugins/sfPropelActAsSignableBehaviorPlugin/trunk/lib/sfPropelActAsSignableBehavior.class.php

@@ -12 +12 @@
-/**
- * This behavior automates the handling of "created_by" and "updated_by" columns
+ * 
+ * Full options array (every option is optional) :
+ * 
+ * sfPropelBehavior::add('Dummy', array(
+ *   'sfPropelActAsSignableBehavior' => array(
+ *     'columns' => array( // columns map
+ *       'created' => DummyPeer::CREATED_BY,
+ *       'updated' => DummyPeer::UPDATED_BY,
+ *       'deleted' => DummyPeer::DELETED_BY,
+ *     ),
+ *     'userMethods' => array( // user's methods to get string or int representation
+ *       'string' => '__toString',
+ *       'id'     => 'getId',
+ *     ),
+ *     'updateModifiedColumn' => false,
+ *     'updateEmptyColumn' => true,
+ *   )
+ * ));
+ * 
- *
- * @author  Nicolas Chambrier <naholyr@yahoo.fr>
@@ -18 +37 @@
-class sfPropelActAsSignableBehavior
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  /**
-   * Is behavior enabled ?
@@ -42 +81 @@
-   * @var array
-   */
-_m
+M
-    'id'     => 'getId', 
-    'string' => '__toString'
@@ -82 +121 @@
-  public function preSave(BaseObject $object)
-  {
+    // Automaticaly re-enable behavior
-    if (!self::enabled()) {
-      self::enable();
@@ -87 +127 @@
-    }
-    
+    // Get user from context, if available
-    $user = sfContext::getInstance()->getUser();
-    
+    // Created by...
-    if ($object->isNew()) {
-      self::setSomethingBy($object, 'created', $user);
-    }
-    
+    // Updated by...
-    if ($object->isModified()) {
-      self::setSomethingBy($object, 'updated', $user);
@@ -105 +148 @@
-  public function preDelete(BaseObject $object)
-  {
+    // Automaticaly re-enable behavior
-    if (!self::enabled()) {
-      self::enable();
@@ -110 +154 @@
-    }
-    
+    // Get user from context
-    $user = sfContext::getInstance()->getUser();
-    
+    // Deleted by...
-    self::setSomethingBy($object, 'deleted', $user);
-  }
@@ -126 +172 @@
-    $class = get_class($object);
-    
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      case null:       // Column not found : ignore
-        return false;
@@ -139 +205 @@
-    }
-    
+    // Set the value
-    $setter = self::forgeMethodName($object, 'set', $what);
-    
@@ -155 +222 @@
-  private static function getUserInfo($class, myUser $user, $info)
-  {
-
-
+
+
+
+
+
+
+
-    
-    return call_user_func(array($user, $method));
@@ -164 +236 @@
-   * Returns the appropriate column name.
-   * 
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    
-    // Check that the column is prefixed, if not, prefix it with table name
-constant($class . 'Peer::TABLE_NAME'
+$object->getPeer()->getTableMap()->getName(
-    if (substr($column, 0, strlen($table_name)+1) != $table_name . '.') {
-      $column = $table_name . '.' . strtoupper($column);
@@ -187 +265 @@
-   * Returns type for one column of the given class
-   *
-string       $class                 Propel model class
+BaseObject   $object                Propel object
-   * @param string       $column                Column name
-   * 
-   * @return string
-   */
-
-
-
-
-
-
-
-
-
+
+
+
-    
-    try {
-class
+object
-      $type = $column->getType();
-    } catch (PropelException $e) {
@@ -221 +293 @@
-  private static function forgeMethodName(BaseObject $object, $prefix, $column)
-  {
-get_class($object)
+$object
-    $method_name = $prefix . $object->getPeer()->translateFieldName($column_constant, BasePeer::TYPE_COLNAME, BasePeer::TYPE_PHPNAME);
-    

plugins/sfPropelActAsSignableBehaviorPlugin/trunk/package.xml

@@ -14 +14 @@
-  <active>yes</active>
- </lead>
-3
+4
- <version>
-1
-1
+2
+2
- </version>
- <stability>