MinnPost / object-sync-for-salesforce

classes/admin-notice.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 	/**
 	* Constructor which sets up the admin_notices hook for rendering
 	*
-	* @param mixed $condition
+	* @param boolean $condition
 	* @param string $message
 	* @param bool $dismissible
 	* @param string $type

classes/admin.php

Doc Comments +1 added lines, -3 removed lines

@@ -527,7 +527,6 @@ 
 	*
 	* @param string $page
 	* @param string $section
-	* @param string $input_callback
 	*/
 	private function fields_settings( $page, $section, $callbacks ) {
 		add_settings_section( $page, ucwords( $page ), null, $page );
@@ -792,7 +791,6 @@ 
 	*
 	* @param string $page
 	* @param string $section
-	* @param string $input_callback
 	*/
 	private function fields_scheduling( $page, $section, $callbacks ) {
 
@@ -1287,7 +1285,7 @@ 
 	* This takes either the $_POST array via ajax, or can be directly called with $wordpress_object and $salesforce_object fields
 	*
 	* @param string $wordpress_object
-	* @param string $salesforce_object
+	* @param string $salesforce
 	* @return array $object_fields
 	*/
 	public function get_wp_sf_object_fields( $wordpress_object = '', $salesforce = '' ) {

classes/class-object-sync-sf-queue.php

Doc Comments +6 added lines, -1 removed lines

@@ -21,6 +21,11 @@ 
 	protected $option_prefix;
 	protected $schedulable_classes;
 
+	/**
+	 * @param string $version
+	 * @param string $slug
+	 * @param string $option_prefix
+	 */
 	public function __construct( $wpdb, $version, $slug, $option_prefix, $schedulable_classes ) {
 		$this->wpdb                = $wpdb;
 		$this->version             = $version;
@@ -219,7 +224,7 @@ 
 	 * @param string $hook Hook name.
 	 * @param array  $args Arguments.
 	 * @param string $group Group name.
-	 * @return time|null The date and time for the next occurrence, or null if there is no pending, scheduled action for the given hook.
+	 * @return integer|null The date and time for the next occurrence, or null if there is no pending, scheduled action for the given hook.
 	 */
 	public function get_next( $hook, $args = null, $group = '' ) {
 

classes/logging.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
 	 * Set terms for Salesforce logs
 	 *
 	 * @param array $terms An array of string log types in the WP_Logging class.
-	 * @return array $terms
+	 * @return string[] $terms
 	 */
 	public function set_log_types( $terms ) {
 		$terms[] = 'salesforce';

classes/salesforce.php

Doc Comments +2 added lines, -2 removed lines

@@ -1144,9 +1144,9 @@
 	*
 	* @param string $type
 	*   Object type name, E.g., Contact, Account.
-	* @param string $startDate
+	* @param string $start_date
 	*   Start date to check for deleted objects (in ISO 8601 format).
-	* @param string $endDate
+	* @param string $end_date
 	*   End date to check for deleted objects (in ISO 8601 format).
 	* @return GetDeletedResult
 	*/

classes/salesforce_pull.php

Doc Comments +2 added lines, -10 removed lines

@@ -500,7 +500,7 @@ 
 	* Executes a nextRecordsUrl SOQL query based on the previous result,
 	* and places each updated SF object into the queue for later processing.
 	*
-	* @param gmdate $last_sync
+	* @param string $last_sync
 	* @param array $salesforce_mapping
 	* @param array $map_sync_triggers
 	* @param string $type
@@ -566,8 +566,6 @@ 
 	* @param string $type the Salesforce object type
 	* @param array $salesforce_mapping the map between object types
 	* @param array $query_options the options for the SOQL query
-	* @param bool $check are we just checking?
-	* @return object|bool $soql|$does_next_offset_have_results
 	*
 	*/
 	private function check_offset_query( $type, $salesforce_mapping, $query_options ) {
@@ -753,7 +751,7 @@ 
 	* @param string $type
 	*   e.g. "Contact", "Account", etc.
 	*
-	* @return timestamp $pull_trigger_field_value
+	* @return string $pull_trigger_field_value
 	*
 	*/
 	private function get_pull_date_value( $type, $soql ) {
@@ -2046,12 +2044,6 @@ 
 	*   Array of the salesforce object's data
 	* @param string $sf_sync_trigger
 	*   The current operation's trigger
-	* @param array $mapping
-	*   the fieldmap that maps the two object types
-	* @param array $map_sync_triggers
-	*
-	* @return bool $pull_allowed
-	*   Whether all this stuff allows the $result to be pulled into WordPress
 	*
 	*/
 	private function is_pull_allowed( $object_type, $object, $sf_sync_trigger, $salesforce_mapping, $map_sync_triggers ) {

classes/salesforce_push.php

Doc Comments +1 added lines, -23 removed lines

@@ -315,9 +315,6 @@ 
 	* Callback method for deleting a term
 	*
 	* @param int $term (id)
-	* @param int $term_taxonomy_id
-	* @param string $taxonomy (slug)
-	* @param object $deleted_term
 	*/
 	public function delete_term( $term, $tt_id, $taxonomy, $deleted_term ) {
 		$deleted_term = (array) $deleted_term;
@@ -597,14 +594,6 @@ 
 	*
 	* @param string $object_type
 	*   Type of WordPress object.
-	* @param array|int $object|$wordpress_id
-	*   The WordPress object data or its ID value.
-	* @param array $mapping|$mapping_id
-	*   Salesforce field mapping data array or ID.
-	* @param int $sf_sync_trigger
-	*   Trigger for this sync.
-	*
-	* @return true or exit the method
 	*
 	*/
 	public function salesforce_push_sync_rest( $object_type, $object, $mapping, $sf_sync_trigger ) {
@@ -1276,19 +1265,8 @@ 
 	/**
 	* Find out if push is allowed for this record
 	*
-	* @param string $type
-	*   WordPress object type
-	* @param array $object
-	*   Array of the WordPress object's data
-	* @param string $sf_sync_trigger
-	*   The current operation's trigger
-	* @param array $mapping
-	*   the fieldmap that maps the two object types
-	* @param array $map_sync_triggers
-	*
-	* @return bool $push_allowed
-	*   Whether all this stuff allows the $api_result to be pushed to Salesforce
 	*
+	* @param string $object_type
 	*/
 	private function is_push_allowed( $object_type, $object, $sf_sync_trigger, $mapping, $map_sync_triggers ) {
 

classes/wordpress.php

Doc Comments +2 added lines, -2 removed lines

@@ -396,7 +396,7 @@ 
 	 * if it does, return the transient for that key
 	 *
 	 * @param string $url The API call we'd like to make.
-	 * @param array  $args The arguents of the API call.
+	 * @param string[]  $args The arguents of the API call.
 	 * @return $this->sfwp_transients->get $cachekey
 	 */
 	public function cache_get( $url, $args ) {
@@ -415,7 +415,7 @@ 
 	 * Create a cache entry for the current result, with the url and args as the key
 	 *
 	 * @param string $url The API query URL.
-	 * @param array  $args The arguments passed on the API query.
+	 * @param string[]  $args The arguments passed on the API query.
 	 * @param array  $data The data received.
 	 * @param string $cache_expiration How long to keep the cache result around for.
 	 * @return Bool whether or not the value was set

object-sync-for-salesforce.php

Doc Comments +28 added lines, -36 removed lines

@@ -247,7 +247,7 @@ 
 	 * @param string $slug
 	 * @param string $option_prefix
 	 *
-	 * @return object
+	 * @return Object_Sync_Sf_Logging
 	 *   Instance of Object_Sync_Sf_Logging
 	 */
 	private function logging( $wpdb, $version, $slug, $option_prefix ) {
@@ -263,9 +263,9 @@ 
 	 * @param string $version
 	 * @param string $slug
 	 * @param string $option_prefix
-	 * @param object $logging
+	 * @param Object_Sync_Sf_Logging $logging
 	 *
-	 * @return object
+	 * @return Object_Sync_Sf_Mapping
 	 *   Instance of Object_Sync_Sf_Mapping
 	 */
 	private function mappings( $wpdb, $version, $slug, $option_prefix, $logging ) {
@@ -281,10 +281,10 @@ 
 	* @param string $version
 	* @param string $slug
 	* @param string $option_prefix
-	* @param object $mappings
-	* @param object $logging
+	* @param Object_Sync_Sf_Mapping $mappings
+	* @param Object_Sync_Sf_Logging $logging
 	*
-	* @return object
+	* @return Object_Sync_Sf_WordPress
 	*   Instance of Object_Sync_Sf_WordPress
 	*/
 	private function wordpress( $wpdb, $version, $slug, $option_prefix, $mappings, $logging ) {
@@ -338,9 +338,9 @@ 
 	 * @param string $slug
 	 * @param string $option_prefix
 	 * @param array $schedulable_classes
-	 * @param object $queue
+	 * @param Object_Sync_Sf_Queue $queue
 	 *
-	 * @return object
+	 * @return Object_Sync_Sf_Activate
 	 *   Instance of Object_Sync_Sf_Activate
 	 */
 	private function activate( $wpdb, $version, $slug, $option_prefix, $schedulable_classes, $queue ) {
@@ -375,14 +375,14 @@ 
 	 * @param string $version
 	 * @param array $login_credentials
 	 * @param string $slug
-	 * @param string $object_prefix
-	 * @param object $wordpress
+	 * @param Object_Sync_Sf_WordPress $wordpress
 	 * @param object $salesforce
-	 * @param object $mappings
-	 * @param object $logging
+	 * @param Object_Sync_Sf_Mapping $mappings
+	 * @param Object_Sync_Sf_Logging $logging
 	 * @param array $schedulable_classes
+	 * @param string $option_prefix
 	 *
-	 * @return object
+	 * @return Object_Sync_Sf_Salesforce_Push
 	 *   Instance of Object_Sync_Sf_Salesforce_Push
 	 */
 	private function push( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes, $queue ) {
@@ -399,12 +399,12 @@ 
 	 * @param array $login_credentials
 	 * @param string $slug
 	 * @param string $option_prefix
-	 * @param object $wordpress
+	 * @param Object_Sync_Sf_WordPress $wordpress
 	 * @param object $salesforce
-	 * @param object $mappings
-	 * @param object $logging
+	 * @param Object_Sync_Sf_Mapping $mappings
+	 * @param Object_Sync_Sf_Logging $logging
 	 * @param array $schedulable_classes
-	 * @return object
+	 * @return Object_Sync_Sf_Salesforce_Pull
 	 *   Instance of Object_Sync_Sf_Salesforce_Pull
 	 */
 	private function pull( $wpdb, $version, $login_credentials, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $logging, $schedulable_classes, $queue ) {
@@ -419,20 +419,12 @@ 
 	*
 	* @param object $wpdb
 	* @param string $version
-	* @param array $login_credentials
-	* @param string $slug
-	* @param string $option_prefix
-	* @param object $wordpress
-	* @param object $salesforce
-	* @param object $mappings
-	* @param object $push
-	* @param object $pull
-	* @param object $logging
-	* @param array $schedulable_classes
-	* @param object $queue
-	* @return object $admin
-	*   Instance of Object_Sync_Sf_Rest
+	* @param Object_Sync_Sf_WordPress $wordpress
+	* @param Object_Sync_Sf_Mapping $mappings
+	* @param Object_Sync_Sf_Salesforce_Push $push
+	* @param Object_Sync_Sf_Salesforce_Pull $pull
 	*
+	* @return Object_Sync_Sf_Rest
 	*/
 	private function rest( $wpdb, $version, $slug, $option_prefix, $wordpress, $salesforce, $mappings, $push, $pull ) {
 		require_once( plugin_dir_path( __FILE__ ) . 'classes/class-object-sync-sf-rest.php' );
@@ -449,15 +441,15 @@ 
 	* @param array $login_credentials
 	* @param string $slug
 	* @param string $option_prefix
-	* @param object $wordpress
+	* @param Object_Sync_Sf_WordPress $wordpress
 	* @param object $salesforce
-	* @param object $mappings
-	* @param object $push
-	* @param object $pull
-	* @param object $logging
+	* @param Object_Sync_Sf_Mapping $mappings
+	* @param Object_Sync_Sf_Salesforce_Push $push
+	* @param Object_Sync_Sf_Salesforce_Pull $pull
+	* @param Object_Sync_Sf_Logging $logging
 	* @param array $schedulable_classes
 	* @param object $queue
-	* @return object $admin
+	* @return Object_Sync_Sf_Admin $admin
 	*   Instance of Object_Sync_Sf_Admin
 	*
 	*/