1. Christian Salazar
  2. YiiFileManagerRemote

Commits

Christian Salazar  committed e90a248

readme 3

  • Participants
  • Parent commits 6d294f5
  • Branches master

Comments (0)

Files changed (1)

File README.md

View file
  • Ignore whitespace
 
 #Dependencies
 
-1. You are required to install and get working the "Yiifilemanager extension".
+1. (required) Install and get working "Yiifilemanager extension".
 
-2. You must install the provided SQL script. (see package)
+2. (required) Install the provided SQL script. (see package, mysql)
 
-#Benefits
+3. (optional) To manage file online install "Yiifilemanagerfilepicker extension".
 
-Because all the incoming messages are saved into the Yiifilemanager managed 
-domain the you can use: "Yiifilemanagerfilepicker" to manage files online.
 
 #Usage
 
 1.	clone it from bitbucket into your 'protected/extensions' directory.
 
+
 2.	Register this extension in your imports:
 
 		'import'=>array(
 		to
 		'protected/components/MyIncomingDataAction.php'
 	
-4.	Edit the class method to feet your needs, pay attention to:
+4.	Edit the 'application/components/MyIncomingDataAction.php' class to feet your needs, pay attention to:
 
 		class MyIncomingDataAction 
 			extends YiiFileManagerAbstractAction 
 		}
 
 
-6.	Now you are required to create a URL for a given CLASSNAME and IDENTITY,
-	you can do so by using the provided API:
+6.	You are required to create a URL for a given CLASSNAME and IDENTITY 
+(this will be the Listener in your app, per instance), you can do so by using the provided API:
 
-		// suppose you want to receive data for this object instance:
+		// suppose you want to receive data for a given object instance, so all
+		// incoming data received using from this remote interface will be 
+		// stored in the model's file space. (see yiifilemanager extension)
+		// 
 		$model = SomeClassName::model()->findByPk('123');
-
+		//
 		$api = new YiiFileManagerRemoteApi();
 		$CRC32_UID = $api->newListener("SomeClassName","123");
 		$URL = CHtml::normalizeUrl(array('/site/incoming','uid'=>$CRC32_UID));
 		// it will say:
 		//	http://mysite.com/index.php?r=site/incoming&uid=ac92cf3ca
-		//
 		echo "Dear user, send a POST['content']='hello world' to this URL: ".$URL;
+		// please note we are not using the $model instance here, it is
+		// in this document only as a reference in help to clarify the idea.
+		// in place of it we are using the model primarykey and the model class
 
 7.	When some one uses this URL to send messages to you then it will be
 received in the "SomeClassName" only if: