Eoxia / wpshop

includes/librairies/eav/attributes.class.php

Doc Comments +10 added lines, -8 removed lines

@@ -46,6 +46,7 @@ 
 	/**
 	 *	Get the url listing slug of the current class
 	 *
+	 *	@param string $message
 	 *	@return string The table of the class
 	 */
 	function setMessage($message){
@@ -1244,7 +1245,7 @@ 
 	 *
 	 *	@param integer $element_id optionnal The attribute identifier we want to get. If not specify the entire list will be returned
 	 *	@param string $element_status optionnal The status of element to get into database. Default is set to valid element
-	 *	@param mixed $field_to_search optionnal The field we want to check the row identifier into. Default is to set id
+	 *	@param string $field_to_search optionnal The field we want to check the row identifier into. Default is to set id
 	 *
 	 *	@return object $element_list A wordpress database object containing the attribute list
 	 */
@@ -1484,9 +1485,6 @@ 
 	 *	Get the existing element list into database
 	 *
 	 *	@param integer $elementId optionnal The element identifier we want to get. If not specify the entire list will be returned
-	 *	@param string $elementStatus optionnal The status of element to get into database. Default is set to valid element
-	 *
-	 *	@return object $elements A wordpress database object containing the element list
 	 */
 	public static function getElementWithAttributeAndValue($entityId, $elementId, $language, $keyForArray = '', $outputType = '') {
 		global $wpdb;
@@ -1625,7 +1623,7 @@ 
 	/**
 	 * Traduit le shortcode et affiche la valeur d'un attribut donn�
 	 * @param array $atts : tableau de param�tre du shortcode
-	 * @return mixed
+	 * @return string|null
 	 **/
 	public static function wpshop_att_val_func($atts) {
 		global $wpdb;
@@ -1914,7 +1912,7 @@ 
 
 	/**
 	 *
-	 * @param array $attribute_list
+	 * @param array $attribute_code
 	 * @param string $output_from
 	 * @return string The output for
 	 */
@@ -2455,6 +2453,12 @@ 
 		return $affected_value;
 	}
 
+	/**
+	 * @param string $attr_code
+	 * @param string $attr_option
+	 *
+	 * @return string
+	 */
 	public static function get_attribute_option_output($item, $attr_code, $attr_option, $additionnal_params = '') {
 		switch($attr_code){
 			case 'is_downloadable_':
@@ -3187,7 +3191,6 @@ 
 	 * Define the different field available for bulk edition for entities. Attributes to display are defined by checking box in attribute option
 	 *
 	 * @param string $column_name The column name for output type definition
-	 * @param string $post_type The current
 	 *
 	 */
 	function quick_edit( $column_name, $entity ) {
@@ -3212,7 +3215,6 @@ 
 	 * Define the different field available for bulk edition for entities. Attributes to display are defined by checking box in attribute option
 	 *
 	 * @param string $column_name The column name for output type definition
-	 * @param string $post_type The current
 	 *
 	 */
 	public static function bulk_edit( $column_name, $entity ) {

includes/librairies/payments/payment.class.php

Doc Comments +10 added lines, -2 removed lines

@@ -38,6 +38,10 @@ 
 		return $url;
 	}
 
+	/**
+	 * @param string $param
+	 * @param string $value
+	 */
 	public static function construct_url_parameters($url, $param, $value) {
 		$interoguation_marker_pos = strpos($url, '?');
 		if($interoguation_marker_pos===false)
@@ -86,7 +90,7 @@ 
 	 * Display the list of payment methods available
 	 *
 	 * @param integer $order_id The order id if existing - Useful when user does not finish its order and want to validateit later
-	 * @return string The different payment method
+	 * @return string[] The different payment method
 	 */
 	function __display_payment_methods_choice_form($order_id=0, $cart_type = 'cart') {
 		$output = '';
@@ -250,6 +254,9 @@ 
 	}
 
 
+	/**
+	 * @param string|null $payment_status
+	 */
 	function setOrderPaymentStatus( $order_id, $payment_status ) {
 		/**	Get order main information	*/
 		$order = get_post_meta($order_id, '_order_postmeta', true);
@@ -377,7 +384,7 @@ 
 	 * Allows to inform customer that he would pay a partial amount on this order
 	 *
 	 * @param float $current_order_total The current order total to pay before partial amount calcul
-	 * @return array The amount to pay / A html output with amount to pay and different information
+	 * @return string The amount to pay / A html output with amount to pay and different information
 	 */
 	function partial_payment_calcul( $current_order_total, $for = 'for_all' ) {
 		$output = '';
@@ -482,6 +489,7 @@ 
 	 * @param array $order_meta The complete order meta informations
 	 * @param integer $payment_index The payment to add/update data for
 	 * @param array $params : infos sended by the bank, array structure : ('method', 'waited amount', 'status', 'author', 'payment reference', 'date', 'received amount')
+	 * @param integer $order_id
 	 * @return array The order new meta informations
 	 */
 	public static function add_new_payment_to_order( $order_id, $order_meta, $payment_index, $params, $bank_response ) {