Merge pull request #150 from AlexeyDsov/primitiveIdentifierUp

PrimitiveIdentifier now can export/import objects by custom methods

Author: AlexeyDsov

core/Form/Primitives/IdentifiablePrimitive.class.php

@@ -16,6 +16,7 @@ abstract class IdentifiablePrimitive
 		extends PrimitiveInteger // parent class doesn't really matter here
 	{
 		protected $className = null;
+		private $extractMethod = 'getId';
 
 		/**
 		 * due to historical reasons, by default we're dealing only with
@@ -25,6 +26,29 @@ abstract class IdentifiablePrimitive
 
 		abstract public function of($className);
 
+		/**
+		 * @param mixed $extractMethod
+		 * @return IdentifiablePrimitive
+		 */
+		public function setExtractMethod($extractMethod)
+		{
+			if (is_callable($extractMethod)) {
+				/* all ok, call what you want */
+			} elseif (strpos($extractMethod, '::') === false) {
+				Assert::isTrue(
+					method_exists($this->className, $extractMethod),
+					"knows nothing about '".$this->className
+					."::{$extractMethod}' method"
+				);
+			} else {
+				ClassUtils::checkStaticMethod($extractMethod);
+			}
+			
+			$this->extractMethod = $extractMethod;
+			
+			return $this;
+		}
+		
 		/**
 		 * @return string
 		**/
@@ -77,7 +101,7 @@ public function exportValue()
 			if (!$this->value)
 				return null;
 
-			return $this->value->getId();
+			return $this->actualExportValue($this->value);
 		}
 
 		/* void */ protected function checkNumber($number)
@@ -95,5 +119,20 @@ protected function castNumber($number)
 
 			return $number;
 		}
+		
+		protected function actualExportValue($value)
+		{
+			if (!ClassUtils::isInstanceOf($value, $this->className)) {
+				return null;
+			}
+			
+			if (is_callable($this->extractMethod)) {
+				return call_user_func($this->extractMethod, $value);
+			} elseif (strpos($this->extractMethod, '::') === false) {
+				return $value->{$this->extractMethod}($value);
+			} else {
+				ClassUtils::callStaticMethod($this->extractMethod, $value);
+			}
+		}
 	}
 ?>

core/Form/Primitives/PrimitiveIdentifier.class.php

@@ -55,16 +55,19 @@ public function dao()
 		**/
 		public function setMethodName($methodName)
 		{
-			if (strpos($methodName, '::') === false) {
+			if (is_callable($methodName)) {
+				/* all ok, call what you want */
+			} elseif (strpos($methodName, '::') === false) {
 				$dao = $this->dao();
 
 				Assert::isTrue(
 					method_exists($dao, $methodName),
 					"knows nothing about '".get_class($dao)
 					."::{$methodName}' method"
 				);
-			} else
+			} else {
 				ClassUtils::checkStaticMethod($methodName);
+			}
 
 			$this->methodName = $methodName;
 
@@ -79,7 +82,7 @@ public function importValue($value)
 
 					return
 						$this->import(
-							array($this->getName() => $value->getId())
+							array($this->getName() => $this->actualExportValue($value))
 						);
 
 				} catch (WrongArgumentException $e) {
@@ -105,7 +108,7 @@ public function import($scope)
 			) {
 				$value = $scope[$this->name];
 
-				$this->raw = $value->getId();
+				$this->raw = $this->actualExportValue($value);
 				$this->setValue($value);
 
 				return $this->imported = true;
@@ -139,12 +142,13 @@ public function import($scope)
 
 		protected function actualImportValue($value)
 		{
-			return
-				(strpos($this->methodName, '::') === false)
-					? $this->dao()->{$this->methodName}($value)
-					: ClassUtils::callStaticMethod(
-						$this->methodName, $value
-					);
+			if (is_callable($this->methodName)) {
+				return call_user_func($this->methodName, $value);
+			} elseif (strpos($this->methodName, '::') === false) {
+				return $this->dao()->{$this->methodName}($value);
+			} else {
+				return ClassUtils::callStaticMethod($this->methodName, $value);
+			}
 		}
 	}
 ?>

doc/ChangeLog

@@ -1,4 +1,11 @@
+2012-11-25  Nikita V. Konstantinov
+
+	* core/Form/Primitives/PrimitiveIdentifier.class.php
+		core/Form/Primitives/PrimitiveIdentifier.class.php:
+			PrimitiveIdentifier now can export/import objects by custom methods
+
 2012-11-18  Nikita V. Konstantinov
+
 	* meta/types/ObjectType.class.php:
 		update for Business objects - now you can setSomeProperty(null)
 		for Objects properties if it's not required

test/core/PrimitiveIdentifierTest.class.php

@@ -1,7 +1,7 @@
 <?php
 	/* $Id$ */
 
-	final class PrimitiveIdentifierTest extends TestCase
+	final class PrimitiveIdentifierTest extends TestCaseDAO
 	{
 		public function testEmpty()
 		{
@@ -20,5 +20,66 @@ public function testEmpty()
 				$this->assertFalse($prm->importValue($value));
 			}
 		}
+		
+		/**
+		 * @group pi
+		 */
+		public function testCustomImportExport()
+		{
+			$dbs = DBTestPool::me()->getPool();
+			if (empty($dbs)) {
+				$this->fail('For test required at least one DB in config');
+			}
+			DBPool::me()->setDefault(reset($dbs));
+			
+			$moscow = TestCity::create()->setCapital(true)->setName('Moscow');
+			$moscow->dao()->add($moscow);
+
+			$stalingrad = TestCity::create()->setCapital(false)->setName('Stalingrad');
+			$stalingrad->dao()->add($stalingrad);
+
+			$prms = array();
+			$prms[] = Primitive::identifier('city')->
+				setScalar(true)->
+				of('TestCity')->
+				setMethodName('PrimitiveIdentifierTest::getCityByName')->
+				setExtractMethod('PrimitiveIdentifierTest::getCityName');
+			
+			$prms[] = Primitive::identifier('city')->
+				setScalar(true)->
+				of('TestCity')->
+				setMethodName(array(get_class($this), 'getCityByName'))->
+				setExtractMethod(function(TestCity $city) {return $city->getName();});
+			
+			foreach ($prms as $prm) {
+				$prm->import(array('city' => 'Moscow'));
+				$this->assertEquals($moscow, $prm->getValue());
+				$this->assertEquals('Moscow', $prm->exportValue());
+
+				$prm->importValue($stalingrad);
+				$this->assertequals($stalingrad, $prm->getValue());
+				$this->assertequals('Stalingrad', $prm->exportValue());
+
+				$prm->import(array('city' => $moscow));
+				$this->assertEquals($moscow, $prm->getValue());
+				$this->assertEquals('Moscow', $prm->exportValue());
+			}
+		}
+		
+		/**
+		 * @param string $name
+		 * @return TestCity
+		 */
+		public static function getCityByName($name)
+		{
+			return Criteria::create(TestCity::dao())->
+				add(Expression::eq('name', DBValue::create($name)))->
+				get();
+		}
+		
+		public static function getCityName(TestCity $city)
+		{
+			return $city->getName();
+		}
 	}
 ?>