AyeCode /
invoicing
@@ -13,233 +13,233 @@ |
||
| 13 | 13 | |
| 14 | 14 | return array( |
| 15 | 15 | |
| 16 | - 'id' => array( |
|
| 17 | - 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
| 18 | - 'type' => 'integer', |
|
| 19 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 20 | - 'readonly' => true, |
|
| 21 | - ), |
|
| 22 | - |
|
| 23 | - 'parent_id' => array( |
|
| 24 | - 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
| 25 | - 'type' => 'integer', |
|
| 26 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 27 | - 'default' => 0, |
|
| 28 | - ), |
|
| 29 | - |
|
| 30 | - 'status' => array( |
|
| 31 | - 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
| 32 | - 'type' => 'string', |
|
| 33 | - 'enum' => array( 'draft', 'pending', 'publish' ), |
|
| 34 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 35 | - 'default' => 'draft', |
|
| 36 | - ), |
|
| 37 | - |
|
| 38 | - 'version' => array( |
|
| 39 | - 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
| 40 | - 'type' => 'string', |
|
| 41 | - 'context' => array( 'view', 'edit' ), |
|
| 42 | - 'readonly' => true, |
|
| 43 | - ), |
|
| 44 | - |
|
| 45 | - 'date_created' => array( |
|
| 46 | - 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
| 47 | - 'type' => 'string', |
|
| 48 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 49 | - ), |
|
| 50 | - |
|
| 51 | - 'date_created_gmt' => array( |
|
| 52 | - 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
| 53 | - 'type' => 'string', |
|
| 54 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 55 | - 'readonly' => true, |
|
| 56 | - ), |
|
| 57 | - |
|
| 58 | - 'date_modified' => array( |
|
| 59 | - 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
| 60 | - 'type' => 'string', |
|
| 61 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 62 | - 'readonly' => true, |
|
| 63 | - ), |
|
| 64 | - |
|
| 65 | - 'date_modified_gmt' => array( |
|
| 66 | - 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
| 67 | - 'type' => 'string', |
|
| 68 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 69 | - 'readonly' => true, |
|
| 70 | - ), |
|
| 71 | - |
|
| 72 | - 'name' => array( |
|
| 73 | - 'description' => __( "The item's name.", 'invoicing' ), |
|
| 74 | - 'type' => 'string', |
|
| 75 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 76 | - 'required' => true, |
|
| 77 | - ), |
|
| 78 | - |
|
| 79 | - 'description' => array( |
|
| 80 | - 'description' => __( "The item's description.", 'invoicing' ), |
|
| 81 | - 'type' => 'string', |
|
| 82 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 83 | - ), |
|
| 84 | - |
|
| 85 | - 'owner' => array( |
|
| 86 | - 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
| 87 | - 'type' => 'integer', |
|
| 88 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 89 | - ), |
|
| 90 | - |
|
| 91 | - 'price' => array( |
|
| 92 | - 'description' => __( 'The price of the item.', 'invoicing' ), |
|
| 93 | - 'type' => 'number', |
|
| 94 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 95 | - 'required' => true, |
|
| 96 | - ), |
|
| 97 | - |
|
| 98 | - 'the_price' => array( |
|
| 99 | - 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
| 100 | - 'type' => 'string', |
|
| 101 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 102 | - 'readonly' => true, |
|
| 103 | - ), |
|
| 104 | - |
|
| 105 | - 'type' => array( |
|
| 106 | - 'description' => __( 'The item type.', 'invoicing' ), |
|
| 107 | - 'type' => 'string', |
|
| 108 | - 'enum' => wpinv_item_types(), |
|
| 109 | - 'default' => 'custom', |
|
| 110 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 111 | - ), |
|
| 112 | - |
|
| 113 | - 'vat_rule' => array( |
|
| 114 | - 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
| 115 | - 'type' => 'string', |
|
| 116 | - 'enum' => array_keys( getpaid_get_tax_rules() ), |
|
| 117 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 118 | - ), |
|
| 119 | - |
|
| 120 | - 'vat_class' => array( |
|
| 121 | - 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
| 122 | - 'type' => 'string', |
|
| 123 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 124 | - 'enum' => array_keys( getpaid_get_tax_classes() ), |
|
| 125 | - ), |
|
| 126 | - |
|
| 127 | - 'custom_id' => array( |
|
| 128 | - 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
| 129 | - 'type' => 'string', |
|
| 130 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 131 | - ), |
|
| 16 | + 'id' => array( |
|
| 17 | + 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
| 18 | + 'type' => 'integer', |
|
| 19 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 20 | + 'readonly' => true, |
|
| 21 | + ), |
|
| 22 | + |
|
| 23 | + 'parent_id' => array( |
|
| 24 | + 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
| 25 | + 'type' => 'integer', |
|
| 26 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 27 | + 'default' => 0, |
|
| 28 | + ), |
|
| 29 | + |
|
| 30 | + 'status' => array( |
|
| 31 | + 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
| 32 | + 'type' => 'string', |
|
| 33 | + 'enum' => array( 'draft', 'pending', 'publish' ), |
|
| 34 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 35 | + 'default' => 'draft', |
|
| 36 | + ), |
|
| 37 | + |
|
| 38 | + 'version' => array( |
|
| 39 | + 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
| 40 | + 'type' => 'string', |
|
| 41 | + 'context' => array( 'view', 'edit' ), |
|
| 42 | + 'readonly' => true, |
|
| 43 | + ), |
|
| 44 | + |
|
| 45 | + 'date_created' => array( |
|
| 46 | + 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
| 47 | + 'type' => 'string', |
|
| 48 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 49 | + ), |
|
| 50 | + |
|
| 51 | + 'date_created_gmt' => array( |
|
| 52 | + 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
| 53 | + 'type' => 'string', |
|
| 54 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 55 | + 'readonly' => true, |
|
| 56 | + ), |
|
| 57 | + |
|
| 58 | + 'date_modified' => array( |
|
| 59 | + 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
| 60 | + 'type' => 'string', |
|
| 61 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 62 | + 'readonly' => true, |
|
| 63 | + ), |
|
| 64 | + |
|
| 65 | + 'date_modified_gmt' => array( |
|
| 66 | + 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
| 67 | + 'type' => 'string', |
|
| 68 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 69 | + 'readonly' => true, |
|
| 70 | + ), |
|
| 71 | + |
|
| 72 | + 'name' => array( |
|
| 73 | + 'description' => __( "The item's name.", 'invoicing' ), |
|
| 74 | + 'type' => 'string', |
|
| 75 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 76 | + 'required' => true, |
|
| 77 | + ), |
|
| 78 | + |
|
| 79 | + 'description' => array( |
|
| 80 | + 'description' => __( "The item's description.", 'invoicing' ), |
|
| 81 | + 'type' => 'string', |
|
| 82 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 83 | + ), |
|
| 84 | + |
|
| 85 | + 'owner' => array( |
|
| 86 | + 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
| 87 | + 'type' => 'integer', |
|
| 88 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 89 | + ), |
|
| 90 | + |
|
| 91 | + 'price' => array( |
|
| 92 | + 'description' => __( 'The price of the item.', 'invoicing' ), |
|
| 93 | + 'type' => 'number', |
|
| 94 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 95 | + 'required' => true, |
|
| 96 | + ), |
|
| 97 | + |
|
| 98 | + 'the_price' => array( |
|
| 99 | + 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
| 100 | + 'type' => 'string', |
|
| 101 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 102 | + 'readonly' => true, |
|
| 103 | + ), |
|
| 104 | + |
|
| 105 | + 'type' => array( |
|
| 106 | + 'description' => __( 'The item type.', 'invoicing' ), |
|
| 107 | + 'type' => 'string', |
|
| 108 | + 'enum' => wpinv_item_types(), |
|
| 109 | + 'default' => 'custom', |
|
| 110 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 111 | + ), |
|
| 112 | + |
|
| 113 | + 'vat_rule' => array( |
|
| 114 | + 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
| 115 | + 'type' => 'string', |
|
| 116 | + 'enum' => array_keys( getpaid_get_tax_rules() ), |
|
| 117 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 118 | + ), |
|
| 119 | + |
|
| 120 | + 'vat_class' => array( |
|
| 121 | + 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
| 122 | + 'type' => 'string', |
|
| 123 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 124 | + 'enum' => array_keys( getpaid_get_tax_classes() ), |
|
| 125 | + ), |
|
| 126 | + |
|
| 127 | + 'custom_id' => array( |
|
| 128 | + 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
| 129 | + 'type' => 'string', |
|
| 130 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 131 | + ), |
|
| 132 | 132 | |
| 133 | - 'custom_name' => array( |
|
| 134 | - 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
| 135 | - 'type' => 'string', |
|
| 136 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 137 | - ), |
|
| 138 | - |
|
| 139 | - 'custom_singular_name' => array( |
|
| 140 | - 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
| 141 | - 'type' => 'string', |
|
| 142 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 143 | - ), |
|
| 144 | - |
|
| 145 | - 'is_dynamic_pricing' => array( |
|
| 146 | - 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
| 147 | - 'type' => 'integer', |
|
| 148 | - 'enum' => array( 0, 1 ), |
|
| 149 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 150 | - ), |
|
| 151 | - |
|
| 152 | - 'minimum_price' => array( |
|
| 153 | - 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
| 154 | - 'type' => 'number', |
|
| 155 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 156 | - ), |
|
| 157 | - |
|
| 158 | - 'is_recurring' => array( |
|
| 159 | - 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
| 160 | - 'type' => 'integer', |
|
| 161 | - 'enum' => array( 0, 1 ), |
|
| 162 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 163 | - ), |
|
| 164 | - |
|
| 165 | - 'initial_price' => array( |
|
| 166 | - 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
| 167 | - 'type' => 'number', |
|
| 168 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 169 | - 'readonly' => true, |
|
| 170 | - ), |
|
| 171 | - |
|
| 172 | - 'the_initial_price' => array( |
|
| 173 | - 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
| 174 | - 'type' => 'string', |
|
| 175 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 176 | - 'readonly' => true, |
|
| 177 | - ), |
|
| 178 | - |
|
| 179 | - 'recurring_price' => array( |
|
| 180 | - 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
| 181 | - 'type' => 'number', |
|
| 182 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 183 | - 'readonly' => true, |
|
| 184 | - ), |
|
| 185 | - |
|
| 186 | - 'the_recurring_price' => array( |
|
| 187 | - 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
| 188 | - 'type' => 'string', |
|
| 189 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 190 | - 'readonly' => true, |
|
| 191 | - ), |
|
| 192 | - |
|
| 193 | - 'recurring_period' => array( |
|
| 194 | - 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
| 195 | - 'type' => 'string', |
|
| 196 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 197 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
| 198 | - ), |
|
| 199 | - |
|
| 200 | - 'recurring_interval' => array( |
|
| 201 | - 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
| 202 | - 'type' => 'integer', |
|
| 203 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 204 | - ), |
|
| 205 | - |
|
| 206 | - 'recurring_limit' => array( |
|
| 207 | - 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
| 208 | - 'type' => 'integer', |
|
| 209 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 210 | - ), |
|
| 211 | - |
|
| 212 | - 'is_free_trial' => array( |
|
| 213 | - 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
| 214 | - 'type' => 'integer', |
|
| 215 | - 'enum' => array( 0, 1 ), |
|
| 216 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 217 | - ), |
|
| 218 | - |
|
| 219 | - 'trial_period' => array( |
|
| 220 | - 'description' => __( 'The trial period.', 'invoicing' ), |
|
| 221 | - 'type' => 'string', |
|
| 222 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 223 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
| 224 | - ), |
|
| 225 | - |
|
| 226 | - 'trial_interval' => array( |
|
| 227 | - 'description' => __( 'The trial interval.', 'invoicing' ), |
|
| 228 | - 'type' => 'integer', |
|
| 229 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 230 | - ), |
|
| 231 | - |
|
| 232 | - 'first_renewal_date' => array( |
|
| 233 | - 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
| 234 | - 'type' => 'string', |
|
| 235 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 236 | - 'readonly' => true, |
|
| 237 | - ), |
|
| 238 | - |
|
| 239 | - 'edit_url' => array( |
|
| 240 | - 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
| 241 | - 'type' => 'string', |
|
| 242 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 243 | - 'readonly' => true, |
|
| 244 | - ), |
|
| 133 | + 'custom_name' => array( |
|
| 134 | + 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
| 135 | + 'type' => 'string', |
|
| 136 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 137 | + ), |
|
| 138 | + |
|
| 139 | + 'custom_singular_name' => array( |
|
| 140 | + 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
| 141 | + 'type' => 'string', |
|
| 142 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 143 | + ), |
|
| 144 | + |
|
| 145 | + 'is_dynamic_pricing' => array( |
|
| 146 | + 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
| 147 | + 'type' => 'integer', |
|
| 148 | + 'enum' => array( 0, 1 ), |
|
| 149 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 150 | + ), |
|
| 151 | + |
|
| 152 | + 'minimum_price' => array( |
|
| 153 | + 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
| 154 | + 'type' => 'number', |
|
| 155 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 156 | + ), |
|
| 157 | + |
|
| 158 | + 'is_recurring' => array( |
|
| 159 | + 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
| 160 | + 'type' => 'integer', |
|
| 161 | + 'enum' => array( 0, 1 ), |
|
| 162 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 163 | + ), |
|
| 164 | + |
|
| 165 | + 'initial_price' => array( |
|
| 166 | + 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
| 167 | + 'type' => 'number', |
|
| 168 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 169 | + 'readonly' => true, |
|
| 170 | + ), |
|
| 171 | + |
|
| 172 | + 'the_initial_price' => array( |
|
| 173 | + 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
| 174 | + 'type' => 'string', |
|
| 175 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 176 | + 'readonly' => true, |
|
| 177 | + ), |
|
| 178 | + |
|
| 179 | + 'recurring_price' => array( |
|
| 180 | + 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
| 181 | + 'type' => 'number', |
|
| 182 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 183 | + 'readonly' => true, |
|
| 184 | + ), |
|
| 185 | + |
|
| 186 | + 'the_recurring_price' => array( |
|
| 187 | + 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
| 188 | + 'type' => 'string', |
|
| 189 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 190 | + 'readonly' => true, |
|
| 191 | + ), |
|
| 192 | + |
|
| 193 | + 'recurring_period' => array( |
|
| 194 | + 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
| 195 | + 'type' => 'string', |
|
| 196 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 197 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
| 198 | + ), |
|
| 199 | + |
|
| 200 | + 'recurring_interval' => array( |
|
| 201 | + 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
| 202 | + 'type' => 'integer', |
|
| 203 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 204 | + ), |
|
| 205 | + |
|
| 206 | + 'recurring_limit' => array( |
|
| 207 | + 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
| 208 | + 'type' => 'integer', |
|
| 209 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 210 | + ), |
|
| 211 | + |
|
| 212 | + 'is_free_trial' => array( |
|
| 213 | + 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
| 214 | + 'type' => 'integer', |
|
| 215 | + 'enum' => array( 0, 1 ), |
|
| 216 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 217 | + ), |
|
| 218 | + |
|
| 219 | + 'trial_period' => array( |
|
| 220 | + 'description' => __( 'The trial period.', 'invoicing' ), |
|
| 221 | + 'type' => 'string', |
|
| 222 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 223 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
| 224 | + ), |
|
| 225 | + |
|
| 226 | + 'trial_interval' => array( |
|
| 227 | + 'description' => __( 'The trial interval.', 'invoicing' ), |
|
| 228 | + 'type' => 'integer', |
|
| 229 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 230 | + ), |
|
| 231 | + |
|
| 232 | + 'first_renewal_date' => array( |
|
| 233 | + 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
| 234 | + 'type' => 'string', |
|
| 235 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 236 | + 'readonly' => true, |
|
| 237 | + ), |
|
| 238 | + |
|
| 239 | + 'edit_url' => array( |
|
| 240 | + 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
| 241 | + 'type' => 'string', |
|
| 242 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 243 | + 'readonly' => true, |
|
| 244 | + ), |
|
| 245 | 245 | ); |
@@ -36,36 +36,36 @@ discard block |
||
| 36 | 36 | 'desc_tip' => true, |
| 37 | 37 | 'default' => '', |
| 38 | 38 | 'advanced' => false |
| 39 | - ), |
|
| 39 | + ), |
|
| 40 | 40 | |
| 41 | 41 | 'form' => array( |
| 42 | - 'title' => __( 'Form', 'invoicing' ), |
|
| 43 | - 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
| 44 | - 'type' => 'text', |
|
| 45 | - 'desc_tip' => true, |
|
| 46 | - 'default' => '', |
|
| 47 | - 'placeholder' => __('1','invoicing'), |
|
| 48 | - 'advanced' => false |
|
| 49 | - ), |
|
| 50 | - |
|
| 51 | - 'item' => array( |
|
| 52 | - 'title' => __( 'Items', 'invoicing' ), |
|
| 53 | - 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
| 54 | - 'type' => 'text', |
|
| 55 | - 'desc_tip' => true, |
|
| 56 | - 'default' => '', |
|
| 57 | - 'placeholder' => __('1','invoicing'), |
|
| 58 | - 'advanced' => false |
|
| 59 | - ), |
|
| 42 | + 'title' => __( 'Form', 'invoicing' ), |
|
| 43 | + 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
| 44 | + 'type' => 'text', |
|
| 45 | + 'desc_tip' => true, |
|
| 46 | + 'default' => '', |
|
| 47 | + 'placeholder' => __('1','invoicing'), |
|
| 48 | + 'advanced' => false |
|
| 49 | + ), |
|
| 50 | + |
|
| 51 | + 'item' => array( |
|
| 52 | + 'title' => __( 'Items', 'invoicing' ), |
|
| 53 | + 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
| 54 | + 'type' => 'text', |
|
| 55 | + 'desc_tip' => true, |
|
| 56 | + 'default' => '', |
|
| 57 | + 'placeholder' => __('1','invoicing'), |
|
| 58 | + 'advanced' => false |
|
| 59 | + ), |
|
| 60 | 60 | |
| 61 | 61 | 'button' => array( |
| 62 | - 'title' => __( 'Button', 'invoicing' ), |
|
| 63 | - 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
| 64 | - 'type' => 'text', |
|
| 65 | - 'desc_tip' => true, |
|
| 66 | - 'default' => '', |
|
| 67 | - 'advanced' => false |
|
| 68 | - ) |
|
| 62 | + 'title' => __( 'Button', 'invoicing' ), |
|
| 63 | + 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
| 64 | + 'type' => 'text', |
|
| 65 | + 'desc_tip' => true, |
|
| 66 | + 'default' => '', |
|
| 67 | + 'advanced' => false |
|
| 68 | + ) |
|
| 69 | 69 | |
| 70 | 70 | ) |
| 71 | 71 | |
@@ -75,96 +75,96 @@ discard block |
||
| 75 | 75 | parent::__construct( $options ); |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * The Super block output function. |
|
| 80 | - * |
|
| 81 | - * @param array $args |
|
| 82 | - * @param array $widget_args |
|
| 83 | - * @param string $content |
|
| 84 | - * |
|
| 85 | - * @return string |
|
| 86 | - */ |
|
| 78 | + /** |
|
| 79 | + * The Super block output function. |
|
| 80 | + * |
|
| 81 | + * @param array $args |
|
| 82 | + * @param array $widget_args |
|
| 83 | + * @param string $content |
|
| 84 | + * |
|
| 85 | + * @return string |
|
| 86 | + */ |
|
| 87 | 87 | public function output( $args = array(), $widget_args = array(), $content = '' ) { |
| 88 | 88 | |
| 89 | - // Is the shortcode set up correctly? |
|
| 90 | - if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
| 91 | - return aui()->alert( |
|
| 92 | - array( |
|
| 93 | - 'type' => 'warning', |
|
| 94 | - 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
| 95 | - ) |
|
| 96 | - ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - // Payment form or button? |
|
| 100 | - if ( ! empty( $args['form'] ) ) { |
|
| 101 | - return $this->handle_payment_form( $args ); |
|
| 102 | - } else { |
|
| 103 | - return $this->handle_buy_item( $args ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Displaying a payment form |
|
| 110 | - * |
|
| 111 | - * @return string |
|
| 112 | - */ |
|
| 89 | + // Is the shortcode set up correctly? |
|
| 90 | + if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
| 91 | + return aui()->alert( |
|
| 92 | + array( |
|
| 93 | + 'type' => 'warning', |
|
| 94 | + 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
| 95 | + ) |
|
| 96 | + ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + // Payment form or button? |
|
| 100 | + if ( ! empty( $args['form'] ) ) { |
|
| 101 | + return $this->handle_payment_form( $args ); |
|
| 102 | + } else { |
|
| 103 | + return $this->handle_buy_item( $args ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Displaying a payment form |
|
| 110 | + * |
|
| 111 | + * @return string |
|
| 112 | + */ |
|
| 113 | 113 | protected function handle_payment_form( $args = array() ) { |
| 114 | 114 | |
| 115 | - if ( empty( $args['button'] ) ) { |
|
| 116 | - ob_start(); |
|
| 117 | - getpaid_display_payment_form( $args['form'] ); |
|
| 118 | - return ob_get_clean(); |
|
| 119 | - } |
|
| 115 | + if ( empty( $args['button'] ) ) { |
|
| 116 | + ob_start(); |
|
| 117 | + getpaid_display_payment_form( $args['form'] ); |
|
| 118 | + return ob_get_clean(); |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - return $this->payment_form_button( $args['form'], $args['button'] ); |
|
| 122 | - } |
|
| 121 | + return $this->payment_form_button( $args['form'], $args['button'] ); |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Displays a payment form button. |
|
| 126 | - * |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 124 | + /** |
|
| 125 | + * Displays a payment form button. |
|
| 126 | + * |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | 129 | protected function payment_form_button( $form, $button ) { |
| 130 | - return getpaid_get_payment_button( $button, $form ); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Selling an item |
|
| 135 | - * |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 130 | + return getpaid_get_payment_button( $button, $form ); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Selling an item |
|
| 135 | + * |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | 138 | protected function handle_buy_item( $args = array() ) { |
| 139 | 139 | |
| 140 | - if ( empty( $args['button'] ) ) { |
|
| 141 | - return $this->buy_item_form( $args['item'] ); |
|
| 142 | - } |
|
| 140 | + if ( empty( $args['button'] ) ) { |
|
| 141 | + return $this->buy_item_form( $args['item'] ); |
|
| 142 | + } |
|
| 143 | 143 | |
| 144 | - return $this->buy_item_button( $args['item'], $args['button'] ); |
|
| 144 | + return $this->buy_item_button( $args['item'], $args['button'] ); |
|
| 145 | 145 | |
| 146 | - } |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Displays a buy item form. |
|
| 150 | - * |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 148 | + /** |
|
| 149 | + * Displays a buy item form. |
|
| 150 | + * |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | 153 | protected function buy_item_form( $item ) { |
| 154 | - $items = getpaid_convert_items_to_array( $item ); |
|
| 155 | - ob_start(); |
|
| 156 | - getpaid_display_item_payment_form( $items ); |
|
| 157 | - return ob_get_clean(); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * Displays a buy item button. |
|
| 162 | - * |
|
| 163 | - * @return string |
|
| 164 | - */ |
|
| 154 | + $items = getpaid_convert_items_to_array( $item ); |
|
| 155 | + ob_start(); |
|
| 156 | + getpaid_display_item_payment_form( $items ); |
|
| 157 | + return ob_get_clean(); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * Displays a buy item button. |
|
| 162 | + * |
|
| 163 | + * @return string |
|
| 164 | + */ |
|
| 165 | 165 | protected function buy_item_button( $item, $button ) { |
| 166 | - $button = getpaid_get_payment_button( $button, null, $item ); |
|
| 167 | - return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
| 166 | + $button = getpaid_get_payment_button( $button, null, $item ); |
|
| 167 | + return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
| 168 | 168 | } |
| 169 | 169 | |
| 170 | 170 | } |
@@ -18,758 +18,758 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * An array of available settings. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $settings; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Route base. |
|
| 30 | - * |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - protected $rest_base = 'settings'; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Registers the routes for the objects of the controller. |
|
| 37 | - * |
|
| 38 | - * @since 2.0.0 |
|
| 39 | - * |
|
| 40 | - * @see register_rest_route() |
|
| 41 | - */ |
|
| 42 | - public function register_namespace_routes( $namespace ) { |
|
| 43 | - |
|
| 44 | - // List all registered tabs. |
|
| 45 | - register_rest_route( |
|
| 46 | - $namespace, |
|
| 47 | - $this->rest_base, |
|
| 48 | - array( |
|
| 49 | - array( |
|
| 50 | - 'methods' => WP_REST_Server::READABLE, |
|
| 51 | - 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 53 | - ), |
|
| 54 | - 'schema' => '__return_empty_array', |
|
| 55 | - ) |
|
| 56 | - ); |
|
| 57 | - |
|
| 58 | - // View/Update a single setting. |
|
| 59 | - register_rest_route( |
|
| 60 | - $namespace, |
|
| 61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
| 62 | - array( |
|
| 63 | - 'args' => array( |
|
| 64 | - 'id' => array( |
|
| 65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 66 | - 'type' => 'string', |
|
| 67 | - 'required' => true, |
|
| 68 | - ), |
|
| 69 | - ), |
|
| 70 | - array( |
|
| 71 | - 'methods' => WP_REST_Server::READABLE, |
|
| 72 | - 'callback' => array( $this, 'get_item' ), |
|
| 73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 74 | - ), |
|
| 75 | - array( |
|
| 76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 77 | - 'callback' => array( $this, 'update_item' ), |
|
| 78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
| 79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 80 | - ), |
|
| 81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 82 | - ) |
|
| 83 | - ); |
|
| 84 | - |
|
| 85 | - // List registered sections for a given tab. |
|
| 86 | - register_rest_route( |
|
| 87 | - $namespace, |
|
| 88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
| 89 | - array( |
|
| 90 | - 'args' => array( |
|
| 91 | - 'tab' => array( |
|
| 92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 93 | - 'type' => 'string', |
|
| 94 | - 'required' => true, |
|
| 95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 96 | - ), |
|
| 97 | - ), |
|
| 98 | - array( |
|
| 99 | - 'methods' => WP_REST_Server::READABLE, |
|
| 100 | - 'callback' => array( $this, 'get_sections' ), |
|
| 101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 102 | - ), |
|
| 103 | - 'schema' => '__return_empty_array', |
|
| 104 | - ) |
|
| 105 | - ); |
|
| 106 | - |
|
| 107 | - // List all registered settings for a given tab. |
|
| 108 | - register_rest_route( |
|
| 109 | - $namespace, |
|
| 110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
| 111 | - array( |
|
| 112 | - 'args' => array( |
|
| 113 | - 'tab' => array( |
|
| 114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 115 | - 'type' => 'string', |
|
| 116 | - 'required' => true, |
|
| 117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 118 | - ), |
|
| 119 | - 'section' => array( |
|
| 120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 121 | - 'type' => 'string', |
|
| 122 | - 'required' => true, |
|
| 123 | - ), |
|
| 124 | - ), |
|
| 125 | - array( |
|
| 126 | - 'methods' => WP_REST_Server::READABLE, |
|
| 127 | - 'callback' => array( $this, 'get_items' ), |
|
| 128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 129 | - ), |
|
| 130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 131 | - ) |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - register_rest_route( |
|
| 135 | - $namespace, |
|
| 136 | - '/' . $this->rest_base . '/batch', |
|
| 137 | - array( |
|
| 138 | - 'args' => array( |
|
| 139 | - 'id' => array( |
|
| 140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 141 | - 'type' => 'string', |
|
| 142 | - ), |
|
| 143 | - ), |
|
| 144 | - array( |
|
| 145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
| 146 | - 'callback' => array( $this, 'batch_items' ), |
|
| 147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 149 | - ), |
|
| 150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 151 | - ) |
|
| 152 | - ); |
|
| 153 | - |
|
| 154 | - } |
|
| 21 | + /** |
|
| 22 | + * An array of available settings. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $settings; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Route base. |
|
| 30 | + * |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + protected $rest_base = 'settings'; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Registers the routes for the objects of the controller. |
|
| 37 | + * |
|
| 38 | + * @since 2.0.0 |
|
| 39 | + * |
|
| 40 | + * @see register_rest_route() |
|
| 41 | + */ |
|
| 42 | + public function register_namespace_routes( $namespace ) { |
|
| 43 | + |
|
| 44 | + // List all registered tabs. |
|
| 45 | + register_rest_route( |
|
| 46 | + $namespace, |
|
| 47 | + $this->rest_base, |
|
| 48 | + array( |
|
| 49 | + array( |
|
| 50 | + 'methods' => WP_REST_Server::READABLE, |
|
| 51 | + 'callback' => array( $this, 'get_tabs' ), |
|
| 52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 53 | + ), |
|
| 54 | + 'schema' => '__return_empty_array', |
|
| 55 | + ) |
|
| 56 | + ); |
|
| 57 | + |
|
| 58 | + // View/Update a single setting. |
|
| 59 | + register_rest_route( |
|
| 60 | + $namespace, |
|
| 61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
| 62 | + array( |
|
| 63 | + 'args' => array( |
|
| 64 | + 'id' => array( |
|
| 65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
| 66 | + 'type' => 'string', |
|
| 67 | + 'required' => true, |
|
| 68 | + ), |
|
| 69 | + ), |
|
| 70 | + array( |
|
| 71 | + 'methods' => WP_REST_Server::READABLE, |
|
| 72 | + 'callback' => array( $this, 'get_item' ), |
|
| 73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 74 | + ), |
|
| 75 | + array( |
|
| 76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 77 | + 'callback' => array( $this, 'update_item' ), |
|
| 78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
| 79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 80 | + ), |
|
| 81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 82 | + ) |
|
| 83 | + ); |
|
| 84 | + |
|
| 85 | + // List registered sections for a given tab. |
|
| 86 | + register_rest_route( |
|
| 87 | + $namespace, |
|
| 88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
| 89 | + array( |
|
| 90 | + 'args' => array( |
|
| 91 | + 'tab' => array( |
|
| 92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
| 93 | + 'type' => 'string', |
|
| 94 | + 'required' => true, |
|
| 95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 96 | + ), |
|
| 97 | + ), |
|
| 98 | + array( |
|
| 99 | + 'methods' => WP_REST_Server::READABLE, |
|
| 100 | + 'callback' => array( $this, 'get_sections' ), |
|
| 101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 102 | + ), |
|
| 103 | + 'schema' => '__return_empty_array', |
|
| 104 | + ) |
|
| 105 | + ); |
|
| 106 | + |
|
| 107 | + // List all registered settings for a given tab. |
|
| 108 | + register_rest_route( |
|
| 109 | + $namespace, |
|
| 110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
| 111 | + array( |
|
| 112 | + 'args' => array( |
|
| 113 | + 'tab' => array( |
|
| 114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 115 | + 'type' => 'string', |
|
| 116 | + 'required' => true, |
|
| 117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
| 118 | + ), |
|
| 119 | + 'section' => array( |
|
| 120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
| 121 | + 'type' => 'string', |
|
| 122 | + 'required' => true, |
|
| 123 | + ), |
|
| 124 | + ), |
|
| 125 | + array( |
|
| 126 | + 'methods' => WP_REST_Server::READABLE, |
|
| 127 | + 'callback' => array( $this, 'get_items' ), |
|
| 128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 129 | + ), |
|
| 130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 131 | + ) |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + register_rest_route( |
|
| 135 | + $namespace, |
|
| 136 | + '/' . $this->rest_base . '/batch', |
|
| 137 | + array( |
|
| 138 | + 'args' => array( |
|
| 139 | + 'id' => array( |
|
| 140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
| 141 | + 'type' => 'string', |
|
| 142 | + ), |
|
| 143 | + ), |
|
| 144 | + array( |
|
| 145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
| 146 | + 'callback' => array( $this, 'batch_items' ), |
|
| 147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
| 148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
| 149 | + ), |
|
| 150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
| 151 | + ) |
|
| 152 | + ); |
|
| 153 | + |
|
| 154 | + } |
|
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * Return all settings. |
|
| 158 | - * |
|
| 159 | - * @since 2.0.0 |
|
| 160 | - * @param WP_REST_Request $request Request data. |
|
| 161 | - * @return WP_Error|WP_REST_Response |
|
| 162 | - */ |
|
| 163 | - public function get_items( $request ) { |
|
| 164 | - |
|
| 165 | - $settings = $this->get_settings(); |
|
| 166 | - |
|
| 167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 176 | - $prepared = array(); |
|
| 177 | - |
|
| 178 | - foreach ( $settings as $setting ) { |
|
| 179 | - |
|
| 180 | - $setting = $this->sanitize_setting( $setting ); |
|
| 181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
| 182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
| 183 | - |
|
| 184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | - $prepared[] = $setting_data; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - return rest_ensure_response( $prepared ); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * Return a single setting. |
|
| 195 | - * |
|
| 196 | - * @since 2.0.0 |
|
| 197 | - * @param WP_REST_Request $request Request data. |
|
| 198 | - * @return WP_Error|WP_REST_Response |
|
| 199 | - */ |
|
| 200 | - public function get_item( $request ) { |
|
| 201 | - $setting = $this->get_setting( $request['id'] ); |
|
| 202 | - |
|
| 203 | - if ( is_wp_error( $setting ) ) { |
|
| 204 | - return $setting; |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - $setting = $this->sanitize_setting( $setting ); |
|
| 208 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 209 | - return rest_ensure_response( $response ); |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Update a single setting. |
|
| 214 | - * |
|
| 215 | - * @since 2.0.0 |
|
| 216 | - * @param WP_REST_Request $request Request data. |
|
| 217 | - * @return WP_Error|WP_REST_Response |
|
| 218 | - */ |
|
| 219 | - public function update_item( $request ) { |
|
| 220 | - $setting = $this->get_setting( $request['id'] ); |
|
| 221 | - |
|
| 222 | - if ( is_wp_error( $setting ) ) { |
|
| 223 | - return $setting; |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 227 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 228 | - } else { |
|
| 229 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - if ( is_wp_error( $value ) ) { |
|
| 233 | - return $value; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - wpinv_update_option( $request['id'], $value ); |
|
| 237 | - $setting['value'] = $value; |
|
| 238 | - $setting = $this->sanitize_setting( $setting ); |
|
| 239 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 240 | - |
|
| 241 | - return rest_ensure_response( $response ); |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * Makes sure the current user has access to READ the settings APIs. |
|
| 246 | - * |
|
| 247 | - * @since 2.0.0 |
|
| 248 | - * @param WP_REST_Request $request Full data about the request. |
|
| 249 | - * @return WP_Error|boolean |
|
| 250 | - */ |
|
| 251 | - public function get_items_permissions_check( $request ) { |
|
| 252 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 253 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - return true; |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
| 261 | - * |
|
| 262 | - * @since 2.0.0 |
|
| 263 | - * @param WP_REST_Request $request Full data about the request. |
|
| 264 | - * @return WP_Error|boolean |
|
| 265 | - */ |
|
| 266 | - public function update_items_permissions_check( $request ) { |
|
| 267 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 268 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - return true; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Check if a given request has access batch create, update and delete items. |
|
| 276 | - * |
|
| 277 | - * @param WP_REST_Request $request Full details about the request. |
|
| 278 | - * |
|
| 279 | - * @return boolean|WP_Error |
|
| 280 | - */ |
|
| 281 | - public function batch_items_permissions_check( $request ) { |
|
| 282 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * Prepare links for the request. |
|
| 287 | - * |
|
| 288 | - * @param string $setting_id Setting ID. |
|
| 289 | - * @return array Links for the given setting. |
|
| 290 | - */ |
|
| 291 | - protected function prepare_links( $setting_id ) { |
|
| 292 | - |
|
| 293 | - $links = array( |
|
| 294 | - 'self' => array( |
|
| 295 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 296 | - ), |
|
| 297 | - 'collection' => array( |
|
| 298 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 299 | - ), |
|
| 300 | - ); |
|
| 301 | - |
|
| 302 | - return $links; |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Prepare a settings object for serialization. |
|
| 307 | - * |
|
| 308 | - * @since 2.0.0 |
|
| 309 | - * @param array $item Setting object. |
|
| 310 | - * @param WP_REST_Request $request Request object. |
|
| 311 | - * @return WP_REST_Response $response Response data. |
|
| 312 | - */ |
|
| 313 | - public function prepare_item_for_response( $item, $request ) { |
|
| 314 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 315 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 316 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 317 | - |
|
| 318 | - $response = rest_ensure_response( $data ); |
|
| 319 | - |
|
| 320 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 321 | - |
|
| 322 | - return $response; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - /** |
|
| 326 | - * Filters out bad values from the settings array/filter so we |
|
| 327 | - * only return known values via the API. |
|
| 328 | - * |
|
| 329 | - * @since 2.0.0 |
|
| 330 | - * @param array $setting Setting. |
|
| 331 | - * @return array |
|
| 332 | - */ |
|
| 333 | - public function filter_setting( $setting ) { |
|
| 334 | - return array_intersect_key( |
|
| 335 | - $setting, |
|
| 336 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 337 | - ); |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /** |
|
| 341 | - * Callback for allowed keys for each setting response. |
|
| 342 | - * |
|
| 343 | - * @param string $key Key to check. |
|
| 344 | - * @return boolean |
|
| 345 | - */ |
|
| 346 | - public function allowed_setting_keys( $key ) { |
|
| 347 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * Returns default options for a setting. null means the field is required. |
|
| 352 | - * |
|
| 353 | - * @since 2.0.0 |
|
| 354 | - * @return array |
|
| 355 | - */ |
|
| 356 | - protected function setting_defaults() { |
|
| 357 | - return array( |
|
| 358 | - 'id' => null, |
|
| 359 | - 'name' => null, |
|
| 360 | - 'desc' => '', |
|
| 361 | - 'options' => array(), |
|
| 362 | - 'std' => false, |
|
| 363 | - 'value' => false, |
|
| 364 | - 'placeholder' => '', |
|
| 365 | - 'readonly' => false, |
|
| 366 | - 'faux' => false, |
|
| 367 | - 'section' => 'main', |
|
| 368 | - 'tab' => 'general', |
|
| 369 | - 'type' => 'text', |
|
| 370 | - ); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 374 | - * Sanitizes a setting's field. |
|
| 375 | - * |
|
| 376 | - * @param array $setting The setting to sanitize. |
|
| 377 | - * @return array |
|
| 378 | - */ |
|
| 379 | - public function sanitize_setting( $setting ) { |
|
| 156 | + /** |
|
| 157 | + * Return all settings. |
|
| 158 | + * |
|
| 159 | + * @since 2.0.0 |
|
| 160 | + * @param WP_REST_Request $request Request data. |
|
| 161 | + * @return WP_Error|WP_REST_Response |
|
| 162 | + */ |
|
| 163 | + public function get_items( $request ) { |
|
| 164 | + |
|
| 165 | + $settings = $this->get_settings(); |
|
| 166 | + |
|
| 167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
| 168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
| 172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
| 176 | + $prepared = array(); |
|
| 177 | + |
|
| 178 | + foreach ( $settings as $setting ) { |
|
| 179 | + |
|
| 180 | + $setting = $this->sanitize_setting( $setting ); |
|
| 181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
| 182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
| 183 | + |
|
| 184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
| 185 | + $prepared[] = $setting_data; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + return rest_ensure_response( $prepared ); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * Return a single setting. |
|
| 195 | + * |
|
| 196 | + * @since 2.0.0 |
|
| 197 | + * @param WP_REST_Request $request Request data. |
|
| 198 | + * @return WP_Error|WP_REST_Response |
|
| 199 | + */ |
|
| 200 | + public function get_item( $request ) { |
|
| 201 | + $setting = $this->get_setting( $request['id'] ); |
|
| 202 | + |
|
| 203 | + if ( is_wp_error( $setting ) ) { |
|
| 204 | + return $setting; |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + $setting = $this->sanitize_setting( $setting ); |
|
| 208 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 209 | + return rest_ensure_response( $response ); |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Update a single setting. |
|
| 214 | + * |
|
| 215 | + * @since 2.0.0 |
|
| 216 | + * @param WP_REST_Request $request Request data. |
|
| 217 | + * @return WP_Error|WP_REST_Response |
|
| 218 | + */ |
|
| 219 | + public function update_item( $request ) { |
|
| 220 | + $setting = $this->get_setting( $request['id'] ); |
|
| 221 | + |
|
| 222 | + if ( is_wp_error( $setting ) ) { |
|
| 223 | + return $setting; |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
| 227 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
| 228 | + } else { |
|
| 229 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + if ( is_wp_error( $value ) ) { |
|
| 233 | + return $value; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + wpinv_update_option( $request['id'], $value ); |
|
| 237 | + $setting['value'] = $value; |
|
| 238 | + $setting = $this->sanitize_setting( $setting ); |
|
| 239 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
| 240 | + |
|
| 241 | + return rest_ensure_response( $response ); |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * Makes sure the current user has access to READ the settings APIs. |
|
| 246 | + * |
|
| 247 | + * @since 2.0.0 |
|
| 248 | + * @param WP_REST_Request $request Full data about the request. |
|
| 249 | + * @return WP_Error|boolean |
|
| 250 | + */ |
|
| 251 | + public function get_items_permissions_check( $request ) { |
|
| 252 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 253 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + return true; |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
| 261 | + * |
|
| 262 | + * @since 2.0.0 |
|
| 263 | + * @param WP_REST_Request $request Full data about the request. |
|
| 264 | + * @return WP_Error|boolean |
|
| 265 | + */ |
|
| 266 | + public function update_items_permissions_check( $request ) { |
|
| 267 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 268 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + return true; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Check if a given request has access batch create, update and delete items. |
|
| 276 | + * |
|
| 277 | + * @param WP_REST_Request $request Full details about the request. |
|
| 278 | + * |
|
| 279 | + * @return boolean|WP_Error |
|
| 280 | + */ |
|
| 281 | + public function batch_items_permissions_check( $request ) { |
|
| 282 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * Prepare links for the request. |
|
| 287 | + * |
|
| 288 | + * @param string $setting_id Setting ID. |
|
| 289 | + * @return array Links for the given setting. |
|
| 290 | + */ |
|
| 291 | + protected function prepare_links( $setting_id ) { |
|
| 292 | + |
|
| 293 | + $links = array( |
|
| 294 | + 'self' => array( |
|
| 295 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
| 296 | + ), |
|
| 297 | + 'collection' => array( |
|
| 298 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 299 | + ), |
|
| 300 | + ); |
|
| 301 | + |
|
| 302 | + return $links; |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Prepare a settings object for serialization. |
|
| 307 | + * |
|
| 308 | + * @since 2.0.0 |
|
| 309 | + * @param array $item Setting object. |
|
| 310 | + * @param WP_REST_Request $request Request object. |
|
| 311 | + * @return WP_REST_Response $response Response data. |
|
| 312 | + */ |
|
| 313 | + public function prepare_item_for_response( $item, $request ) { |
|
| 314 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
| 315 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
| 316 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 317 | + |
|
| 318 | + $response = rest_ensure_response( $data ); |
|
| 319 | + |
|
| 320 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
| 321 | + |
|
| 322 | + return $response; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + /** |
|
| 326 | + * Filters out bad values from the settings array/filter so we |
|
| 327 | + * only return known values via the API. |
|
| 328 | + * |
|
| 329 | + * @since 2.0.0 |
|
| 330 | + * @param array $setting Setting. |
|
| 331 | + * @return array |
|
| 332 | + */ |
|
| 333 | + public function filter_setting( $setting ) { |
|
| 334 | + return array_intersect_key( |
|
| 335 | + $setting, |
|
| 336 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
| 337 | + ); |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /** |
|
| 341 | + * Callback for allowed keys for each setting response. |
|
| 342 | + * |
|
| 343 | + * @param string $key Key to check. |
|
| 344 | + * @return boolean |
|
| 345 | + */ |
|
| 346 | + public function allowed_setting_keys( $key ) { |
|
| 347 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * Returns default options for a setting. null means the field is required. |
|
| 352 | + * |
|
| 353 | + * @since 2.0.0 |
|
| 354 | + * @return array |
|
| 355 | + */ |
|
| 356 | + protected function setting_defaults() { |
|
| 357 | + return array( |
|
| 358 | + 'id' => null, |
|
| 359 | + 'name' => null, |
|
| 360 | + 'desc' => '', |
|
| 361 | + 'options' => array(), |
|
| 362 | + 'std' => false, |
|
| 363 | + 'value' => false, |
|
| 364 | + 'placeholder' => '', |
|
| 365 | + 'readonly' => false, |
|
| 366 | + 'faux' => false, |
|
| 367 | + 'section' => 'main', |
|
| 368 | + 'tab' => 'general', |
|
| 369 | + 'type' => 'text', |
|
| 370 | + ); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | + * Sanitizes a setting's field. |
|
| 375 | + * |
|
| 376 | + * @param array $setting The setting to sanitize. |
|
| 377 | + * @return array |
|
| 378 | + */ |
|
| 379 | + public function sanitize_setting( $setting ) { |
|
| 380 | 380 | |
| 381 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 382 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 383 | - return $this->filter_setting( $setting ); |
|
| 384 | - |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Get setting data. |
|
| 389 | - * |
|
| 390 | - * @since 2.0.0 |
|
| 391 | - * @param string $setting_id Setting ID. |
|
| 392 | - * @return array|WP_Error |
|
| 393 | - */ |
|
| 394 | - public function get_setting( $setting_id ) { |
|
| 395 | - |
|
| 396 | - if ( empty( $setting_id ) ) { |
|
| 397 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - $settings = $this->get_settings(); |
|
| 401 | - |
|
| 402 | - foreach ( $settings as $tabs ) { |
|
| 403 | - |
|
| 404 | - foreach ( $tabs as $sections ) { |
|
| 405 | - |
|
| 406 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
| 407 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 408 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - return $sections[ $setting_id ]; |
|
| 412 | - } |
|
| 413 | - |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 419 | - } |
|
| 420 | - |
|
| 421 | - /** |
|
| 422 | - * Get all tabs. |
|
| 423 | - * |
|
| 424 | - * @param WP_REST_Request $request Request data. |
|
| 425 | - * @return array |
|
| 426 | - */ |
|
| 427 | - public function get_tabs( $request ) { |
|
| 428 | - $tabs = wpinv_get_settings_tabs(); |
|
| 429 | - $prepared = array(); |
|
| 430 | - |
|
| 431 | - foreach ( $tabs as $id => $tab ) { |
|
| 432 | - |
|
| 433 | - $_request = $request; |
|
| 434 | - $_request['tab'] = sanitize_title( $id ); |
|
| 435 | - $data = array( |
|
| 436 | - 'id' => sanitize_title( $id ), |
|
| 437 | - 'label' => sanitize_text_field( $tab ), |
|
| 438 | - 'sections' => $this->get_sections( $_request ), |
|
| 439 | - ); |
|
| 440 | - |
|
| 441 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 442 | - $response = rest_ensure_response( $data ); |
|
| 443 | - |
|
| 444 | - if ( ! is_wp_error( $response ) ) { |
|
| 445 | - $links = array( |
|
| 446 | - 'sections' => array( |
|
| 447 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 448 | - ), |
|
| 449 | - 'collection' => array( |
|
| 450 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 451 | - ), |
|
| 452 | - ); |
|
| 453 | - $response->add_links( $links ); |
|
| 454 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - $prepared[] = $response; |
|
| 458 | - |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - return rest_ensure_response( $prepared ); |
|
| 462 | - } |
|
| 463 | - |
|
| 464 | - /** |
|
| 465 | - * Get all sections. |
|
| 466 | - * |
|
| 467 | - * @param WP_REST_Request $request Request data. |
|
| 468 | - * @return array |
|
| 469 | - */ |
|
| 470 | - public function get_sections( $request ) { |
|
| 471 | - |
|
| 472 | - $tab = sanitize_title( $request['tab'] ); |
|
| 473 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 474 | - $prepared = array(); |
|
| 475 | - |
|
| 476 | - foreach ( $sections as $id => $section ) { |
|
| 477 | - |
|
| 478 | - $data = array( |
|
| 479 | - 'id' => sanitize_title( $id ), |
|
| 480 | - 'label' => sanitize_text_field( $section ), |
|
| 481 | - ); |
|
| 482 | - |
|
| 483 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 484 | - $response = rest_ensure_response( $data ); |
|
| 485 | - |
|
| 486 | - if ( ! is_wp_error( $response ) ) { |
|
| 487 | - $links = array( |
|
| 488 | - 'settings' => array( |
|
| 489 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 490 | - ), |
|
| 491 | - 'collection' => array( |
|
| 492 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 493 | - ), |
|
| 494 | - 'tabs' => array( |
|
| 495 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 496 | - ), |
|
| 497 | - ); |
|
| 498 | - $response->add_links( $links ); |
|
| 499 | - $response = $this->prepare_response_for_collection( $response ); |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - $prepared[] = $response; |
|
| 503 | - |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - return rest_ensure_response( $prepared ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Get all settings. |
|
| 511 | - * |
|
| 512 | - * @return array |
|
| 513 | - */ |
|
| 514 | - public function get_settings() { |
|
| 515 | - |
|
| 516 | - if ( empty( $this->settings ) ) { |
|
| 517 | - $this->settings = wpinv_get_registered_settings(); |
|
| 518 | - } |
|
| 519 | - |
|
| 520 | - return $this->settings; |
|
| 521 | - |
|
| 522 | - } |
|
| 523 | - |
|
| 524 | - /** |
|
| 525 | - * Boolean for if a setting type is a valid supported setting type. |
|
| 526 | - * |
|
| 527 | - * @since 2.0.0 |
|
| 528 | - * @param string $type Type. |
|
| 529 | - * @return bool |
|
| 530 | - */ |
|
| 531 | - public function is_setting_type_valid( $type ) { |
|
| 532 | - |
|
| 533 | - return in_array( |
|
| 534 | - $type, array( |
|
| 535 | - 'text', // Validates with validate_setting_text_field. |
|
| 536 | - 'email', // Validates with validate_setting_text_field. |
|
| 537 | - 'number', // Validates with validate_setting_text_field. |
|
| 538 | - 'color', // Validates with validate_setting_text_field. |
|
| 539 | - 'password', // Validates with validate_setting_text_field. |
|
| 540 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | - 'select', // Validates with validate_setting_select_field. |
|
| 542 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | - 'header', // Validates with validate_setting_text_field. |
|
| 546 | - ) |
|
| 547 | - ); |
|
| 548 | - |
|
| 549 | - } |
|
| 550 | - |
|
| 551 | - /** |
|
| 552 | - * Get the settings schema, conforming to JSON Schema. |
|
| 553 | - * |
|
| 554 | - * @return array |
|
| 555 | - */ |
|
| 556 | - public function get_item_schema() { |
|
| 557 | - |
|
| 558 | - // Maybe retrieve the schema from cache. |
|
| 559 | - if ( ! empty( $this->schema ) ) { |
|
| 560 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 561 | - } |
|
| 562 | - |
|
| 563 | - $schema = array( |
|
| 564 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 565 | - 'title' => 'setting', |
|
| 566 | - 'type' => 'object', |
|
| 567 | - 'properties' => array( |
|
| 568 | - 'id' => array( |
|
| 569 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 570 | - 'type' => 'string', |
|
| 571 | - 'arg_options' => array( |
|
| 572 | - 'sanitize_callback' => 'sanitize_title', |
|
| 573 | - ), |
|
| 574 | - 'context' => array( 'view', 'edit' ), |
|
| 575 | - 'readonly' => true, |
|
| 576 | - ), |
|
| 577 | - 'tab' => array( |
|
| 578 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 579 | - 'type' => 'string', |
|
| 580 | - 'arg_options' => array( |
|
| 581 | - 'sanitize_callback' => 'sanitize_title', |
|
| 582 | - ), |
|
| 583 | - 'context' => array( 'view', 'edit' ), |
|
| 584 | - 'readonly' => true, |
|
| 585 | - ), |
|
| 586 | - 'section' => array( |
|
| 587 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 588 | - 'type' => 'string', |
|
| 589 | - 'arg_options' => array( |
|
| 590 | - 'sanitize_callback' => 'sanitize_title', |
|
| 591 | - ), |
|
| 592 | - 'context' => array( 'view', 'edit' ), |
|
| 593 | - 'readonly' => true, |
|
| 594 | - ), |
|
| 595 | - 'name' => array( |
|
| 596 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 597 | - 'type' => 'string', |
|
| 598 | - 'arg_options' => array( |
|
| 599 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 600 | - ), |
|
| 601 | - 'context' => array( 'view', 'edit' ), |
|
| 602 | - 'readonly' => true, |
|
| 603 | - ), |
|
| 604 | - 'desc' => array( |
|
| 605 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 606 | - 'type' => 'string', |
|
| 607 | - 'context' => array( 'view', 'edit' ), |
|
| 608 | - 'readonly' => true, |
|
| 609 | - ), |
|
| 610 | - 'value' => array( |
|
| 611 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 612 | - 'type' => 'mixed', |
|
| 613 | - 'context' => array( 'view', 'edit' ), |
|
| 614 | - ), |
|
| 615 | - 'default' => array( |
|
| 616 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 617 | - 'type' => 'mixed', |
|
| 618 | - 'context' => array( 'view', 'edit' ), |
|
| 619 | - 'readonly' => true, |
|
| 620 | - ), |
|
| 621 | - 'placeholder' => array( |
|
| 622 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 623 | - 'type' => 'string', |
|
| 624 | - 'arg_options' => array( |
|
| 625 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 626 | - ), |
|
| 627 | - 'context' => array( 'view', 'edit' ), |
|
| 628 | - 'readonly' => true, |
|
| 629 | - ), |
|
| 630 | - 'type' => array( |
|
| 631 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 632 | - 'type' => 'string', |
|
| 633 | - 'arg_options' => array( |
|
| 634 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 635 | - ), |
|
| 636 | - 'context' => array( 'view', 'edit' ), |
|
| 637 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 638 | - 'readonly' => true, |
|
| 639 | - ), |
|
| 640 | - 'options' => array( |
|
| 641 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 642 | - 'type' => 'object', |
|
| 643 | - 'context' => array( 'view', 'edit' ), |
|
| 644 | - 'readonly' => true, |
|
| 645 | - ), |
|
| 646 | - 'readonly' => array( |
|
| 647 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 648 | - 'type' => 'string', |
|
| 649 | - 'context' => array( 'view' ), |
|
| 650 | - 'readonly' => true, |
|
| 651 | - ), |
|
| 652 | - 'faux' => array( |
|
| 653 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 654 | - 'type' => 'string', |
|
| 655 | - 'context' => array( 'view' ), |
|
| 656 | - 'readonly' => true, |
|
| 657 | - ), |
|
| 658 | - ), |
|
| 659 | - ); |
|
| 660 | - |
|
| 661 | - // Filters the settings schema for the REST API. |
|
| 381 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
| 382 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
| 383 | + return $this->filter_setting( $setting ); |
|
| 384 | + |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Get setting data. |
|
| 389 | + * |
|
| 390 | + * @since 2.0.0 |
|
| 391 | + * @param string $setting_id Setting ID. |
|
| 392 | + * @return array|WP_Error |
|
| 393 | + */ |
|
| 394 | + public function get_setting( $setting_id ) { |
|
| 395 | + |
|
| 396 | + if ( empty( $setting_id ) ) { |
|
| 397 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + $settings = $this->get_settings(); |
|
| 401 | + |
|
| 402 | + foreach ( $settings as $tabs ) { |
|
| 403 | + |
|
| 404 | + foreach ( $tabs as $sections ) { |
|
| 405 | + |
|
| 406 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
| 407 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
| 408 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + return $sections[ $setting_id ]; |
|
| 412 | + } |
|
| 413 | + |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
| 419 | + } |
|
| 420 | + |
|
| 421 | + /** |
|
| 422 | + * Get all tabs. |
|
| 423 | + * |
|
| 424 | + * @param WP_REST_Request $request Request data. |
|
| 425 | + * @return array |
|
| 426 | + */ |
|
| 427 | + public function get_tabs( $request ) { |
|
| 428 | + $tabs = wpinv_get_settings_tabs(); |
|
| 429 | + $prepared = array(); |
|
| 430 | + |
|
| 431 | + foreach ( $tabs as $id => $tab ) { |
|
| 432 | + |
|
| 433 | + $_request = $request; |
|
| 434 | + $_request['tab'] = sanitize_title( $id ); |
|
| 435 | + $data = array( |
|
| 436 | + 'id' => sanitize_title( $id ), |
|
| 437 | + 'label' => sanitize_text_field( $tab ), |
|
| 438 | + 'sections' => $this->get_sections( $_request ), |
|
| 439 | + ); |
|
| 440 | + |
|
| 441 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 442 | + $response = rest_ensure_response( $data ); |
|
| 443 | + |
|
| 444 | + if ( ! is_wp_error( $response ) ) { |
|
| 445 | + $links = array( |
|
| 446 | + 'sections' => array( |
|
| 447 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
| 448 | + ), |
|
| 449 | + 'collection' => array( |
|
| 450 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 451 | + ), |
|
| 452 | + ); |
|
| 453 | + $response->add_links( $links ); |
|
| 454 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + $prepared[] = $response; |
|
| 458 | + |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + return rest_ensure_response( $prepared ); |
|
| 462 | + } |
|
| 463 | + |
|
| 464 | + /** |
|
| 465 | + * Get all sections. |
|
| 466 | + * |
|
| 467 | + * @param WP_REST_Request $request Request data. |
|
| 468 | + * @return array |
|
| 469 | + */ |
|
| 470 | + public function get_sections( $request ) { |
|
| 471 | + |
|
| 472 | + $tab = sanitize_title( $request['tab'] ); |
|
| 473 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
| 474 | + $prepared = array(); |
|
| 475 | + |
|
| 476 | + foreach ( $sections as $id => $section ) { |
|
| 477 | + |
|
| 478 | + $data = array( |
|
| 479 | + 'id' => sanitize_title( $id ), |
|
| 480 | + 'label' => sanitize_text_field( $section ), |
|
| 481 | + ); |
|
| 482 | + |
|
| 483 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 484 | + $response = rest_ensure_response( $data ); |
|
| 485 | + |
|
| 486 | + if ( ! is_wp_error( $response ) ) { |
|
| 487 | + $links = array( |
|
| 488 | + 'settings' => array( |
|
| 489 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
| 490 | + ), |
|
| 491 | + 'collection' => array( |
|
| 492 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
| 493 | + ), |
|
| 494 | + 'tabs' => array( |
|
| 495 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 496 | + ), |
|
| 497 | + ); |
|
| 498 | + $response->add_links( $links ); |
|
| 499 | + $response = $this->prepare_response_for_collection( $response ); |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + $prepared[] = $response; |
|
| 503 | + |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + return rest_ensure_response( $prepared ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Get all settings. |
|
| 511 | + * |
|
| 512 | + * @return array |
|
| 513 | + */ |
|
| 514 | + public function get_settings() { |
|
| 515 | + |
|
| 516 | + if ( empty( $this->settings ) ) { |
|
| 517 | + $this->settings = wpinv_get_registered_settings(); |
|
| 518 | + } |
|
| 519 | + |
|
| 520 | + return $this->settings; |
|
| 521 | + |
|
| 522 | + } |
|
| 523 | + |
|
| 524 | + /** |
|
| 525 | + * Boolean for if a setting type is a valid supported setting type. |
|
| 526 | + * |
|
| 527 | + * @since 2.0.0 |
|
| 528 | + * @param string $type Type. |
|
| 529 | + * @return bool |
|
| 530 | + */ |
|
| 531 | + public function is_setting_type_valid( $type ) { |
|
| 532 | + |
|
| 533 | + return in_array( |
|
| 534 | + $type, array( |
|
| 535 | + 'text', // Validates with validate_setting_text_field. |
|
| 536 | + 'email', // Validates with validate_setting_text_field. |
|
| 537 | + 'number', // Validates with validate_setting_text_field. |
|
| 538 | + 'color', // Validates with validate_setting_text_field. |
|
| 539 | + 'password', // Validates with validate_setting_text_field. |
|
| 540 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
| 541 | + 'select', // Validates with validate_setting_select_field. |
|
| 542 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
| 543 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
| 544 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
| 545 | + 'header', // Validates with validate_setting_text_field. |
|
| 546 | + ) |
|
| 547 | + ); |
|
| 548 | + |
|
| 549 | + } |
|
| 550 | + |
|
| 551 | + /** |
|
| 552 | + * Get the settings schema, conforming to JSON Schema. |
|
| 553 | + * |
|
| 554 | + * @return array |
|
| 555 | + */ |
|
| 556 | + public function get_item_schema() { |
|
| 557 | + |
|
| 558 | + // Maybe retrieve the schema from cache. |
|
| 559 | + if ( ! empty( $this->schema ) ) { |
|
| 560 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 561 | + } |
|
| 562 | + |
|
| 563 | + $schema = array( |
|
| 564 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 565 | + 'title' => 'setting', |
|
| 566 | + 'type' => 'object', |
|
| 567 | + 'properties' => array( |
|
| 568 | + 'id' => array( |
|
| 569 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
| 570 | + 'type' => 'string', |
|
| 571 | + 'arg_options' => array( |
|
| 572 | + 'sanitize_callback' => 'sanitize_title', |
|
| 573 | + ), |
|
| 574 | + 'context' => array( 'view', 'edit' ), |
|
| 575 | + 'readonly' => true, |
|
| 576 | + ), |
|
| 577 | + 'tab' => array( |
|
| 578 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
| 579 | + 'type' => 'string', |
|
| 580 | + 'arg_options' => array( |
|
| 581 | + 'sanitize_callback' => 'sanitize_title', |
|
| 582 | + ), |
|
| 583 | + 'context' => array( 'view', 'edit' ), |
|
| 584 | + 'readonly' => true, |
|
| 585 | + ), |
|
| 586 | + 'section' => array( |
|
| 587 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
| 588 | + 'type' => 'string', |
|
| 589 | + 'arg_options' => array( |
|
| 590 | + 'sanitize_callback' => 'sanitize_title', |
|
| 591 | + ), |
|
| 592 | + 'context' => array( 'view', 'edit' ), |
|
| 593 | + 'readonly' => true, |
|
| 594 | + ), |
|
| 595 | + 'name' => array( |
|
| 596 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
| 597 | + 'type' => 'string', |
|
| 598 | + 'arg_options' => array( |
|
| 599 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 600 | + ), |
|
| 601 | + 'context' => array( 'view', 'edit' ), |
|
| 602 | + 'readonly' => true, |
|
| 603 | + ), |
|
| 604 | + 'desc' => array( |
|
| 605 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
| 606 | + 'type' => 'string', |
|
| 607 | + 'context' => array( 'view', 'edit' ), |
|
| 608 | + 'readonly' => true, |
|
| 609 | + ), |
|
| 610 | + 'value' => array( |
|
| 611 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
| 612 | + 'type' => 'mixed', |
|
| 613 | + 'context' => array( 'view', 'edit' ), |
|
| 614 | + ), |
|
| 615 | + 'default' => array( |
|
| 616 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
| 617 | + 'type' => 'mixed', |
|
| 618 | + 'context' => array( 'view', 'edit' ), |
|
| 619 | + 'readonly' => true, |
|
| 620 | + ), |
|
| 621 | + 'placeholder' => array( |
|
| 622 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
| 623 | + 'type' => 'string', |
|
| 624 | + 'arg_options' => array( |
|
| 625 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 626 | + ), |
|
| 627 | + 'context' => array( 'view', 'edit' ), |
|
| 628 | + 'readonly' => true, |
|
| 629 | + ), |
|
| 630 | + 'type' => array( |
|
| 631 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
| 632 | + 'type' => 'string', |
|
| 633 | + 'arg_options' => array( |
|
| 634 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 635 | + ), |
|
| 636 | + 'context' => array( 'view', 'edit' ), |
|
| 637 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
| 638 | + 'readonly' => true, |
|
| 639 | + ), |
|
| 640 | + 'options' => array( |
|
| 641 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
| 642 | + 'type' => 'object', |
|
| 643 | + 'context' => array( 'view', 'edit' ), |
|
| 644 | + 'readonly' => true, |
|
| 645 | + ), |
|
| 646 | + 'readonly' => array( |
|
| 647 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
| 648 | + 'type' => 'string', |
|
| 649 | + 'context' => array( 'view' ), |
|
| 650 | + 'readonly' => true, |
|
| 651 | + ), |
|
| 652 | + 'faux' => array( |
|
| 653 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
| 654 | + 'type' => 'string', |
|
| 655 | + 'context' => array( 'view' ), |
|
| 656 | + 'readonly' => true, |
|
| 657 | + ), |
|
| 658 | + ), |
|
| 659 | + ); |
|
| 660 | + |
|
| 661 | + // Filters the settings schema for the REST API. |
|
| 662 | 662 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
| 663 | 663 | |
| 664 | - // Cache the settings schema. |
|
| 665 | - $this->schema = $schema; |
|
| 666 | - |
|
| 667 | - return $this->add_additional_fields_schema( $this->schema ); |
|
| 668 | - |
|
| 669 | - } |
|
| 670 | - |
|
| 671 | - /** |
|
| 672 | - * Validate a text value for a text based setting. |
|
| 673 | - * |
|
| 674 | - * @since 2.0.0 |
|
| 675 | - * @param string $value Value. |
|
| 676 | - * @param array $setting Setting. |
|
| 677 | - * @return string |
|
| 678 | - */ |
|
| 679 | - public function validate_setting_text_field( $value ) { |
|
| 680 | - $value = is_null( $value ) ? '' : $value; |
|
| 681 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 682 | - } |
|
| 683 | - |
|
| 684 | - /** |
|
| 685 | - * Validate select based settings. |
|
| 686 | - * |
|
| 687 | - * @since 2.0.0 |
|
| 688 | - * @param string $value Value. |
|
| 689 | - * @param array $setting Setting. |
|
| 690 | - * @return string|WP_Error |
|
| 691 | - */ |
|
| 692 | - public function validate_setting_select_field( $value, $setting ) { |
|
| 693 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 694 | - return $value; |
|
| 695 | - } else { |
|
| 696 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 697 | - } |
|
| 698 | - } |
|
| 699 | - |
|
| 700 | - /** |
|
| 701 | - * Validate multiselect based settings. |
|
| 702 | - * |
|
| 703 | - * @since 2.0.0 |
|
| 704 | - * @param array $values Values. |
|
| 705 | - * @param array $setting Setting. |
|
| 706 | - * @return array|WP_Error |
|
| 707 | - */ |
|
| 708 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 709 | - if ( empty( $values ) ) { |
|
| 710 | - return array(); |
|
| 711 | - } |
|
| 712 | - |
|
| 713 | - if ( ! is_array( $values ) ) { |
|
| 714 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - $final_values = array(); |
|
| 718 | - foreach ( $values as $value ) { |
|
| 719 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 720 | - $final_values[] = $value; |
|
| 721 | - } |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - return $final_values; |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * Validate radio based settings. |
|
| 729 | - * |
|
| 730 | - * @since 2.0.0 |
|
| 731 | - * @param string $value Value. |
|
| 732 | - * @param array $setting Setting. |
|
| 733 | - * @return string|WP_Error |
|
| 734 | - */ |
|
| 735 | - public function validate_setting_radio_field( $value, $setting ) { |
|
| 736 | - return $this->validate_setting_select_field( $value, $setting ); |
|
| 737 | - } |
|
| 738 | - |
|
| 739 | - /** |
|
| 740 | - * Validate checkbox based settings. |
|
| 741 | - * |
|
| 742 | - * @since 2.0.0 |
|
| 743 | - * @param string $value Value. |
|
| 744 | - * @return int |
|
| 745 | - */ |
|
| 746 | - public function validate_setting_checkbox_field( $value ) { |
|
| 747 | - return (int) ! empty( $value ); |
|
| 748 | - } |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Validate textarea based settings. |
|
| 752 | - * |
|
| 753 | - * @since 2.0.0 |
|
| 754 | - * @param string $value Value. |
|
| 755 | - * @return string |
|
| 756 | - */ |
|
| 757 | - public function validate_setting_textarea_field( $value ) { |
|
| 758 | - $value = is_null( $value ) ? '' : $value; |
|
| 759 | - return wp_kses( |
|
| 760 | - trim( stripslashes( $value ) ), |
|
| 761 | - array_merge( |
|
| 762 | - array( |
|
| 763 | - 'iframe' => array( |
|
| 764 | - 'src' => true, |
|
| 765 | - 'style' => true, |
|
| 766 | - 'id' => true, |
|
| 767 | - 'class' => true, |
|
| 768 | - ), |
|
| 769 | - ), |
|
| 770 | - wp_kses_allowed_html( 'post' ) |
|
| 771 | - ) |
|
| 772 | - ); |
|
| 773 | - } |
|
| 664 | + // Cache the settings schema. |
|
| 665 | + $this->schema = $schema; |
|
| 666 | + |
|
| 667 | + return $this->add_additional_fields_schema( $this->schema ); |
|
| 668 | + |
|
| 669 | + } |
|
| 670 | + |
|
| 671 | + /** |
|
| 672 | + * Validate a text value for a text based setting. |
|
| 673 | + * |
|
| 674 | + * @since 2.0.0 |
|
| 675 | + * @param string $value Value. |
|
| 676 | + * @param array $setting Setting. |
|
| 677 | + * @return string |
|
| 678 | + */ |
|
| 679 | + public function validate_setting_text_field( $value ) { |
|
| 680 | + $value = is_null( $value ) ? '' : $value; |
|
| 681 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
| 682 | + } |
|
| 683 | + |
|
| 684 | + /** |
|
| 685 | + * Validate select based settings. |
|
| 686 | + * |
|
| 687 | + * @since 2.0.0 |
|
| 688 | + * @param string $value Value. |
|
| 689 | + * @param array $setting Setting. |
|
| 690 | + * @return string|WP_Error |
|
| 691 | + */ |
|
| 692 | + public function validate_setting_select_field( $value, $setting ) { |
|
| 693 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 694 | + return $value; |
|
| 695 | + } else { |
|
| 696 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 697 | + } |
|
| 698 | + } |
|
| 699 | + |
|
| 700 | + /** |
|
| 701 | + * Validate multiselect based settings. |
|
| 702 | + * |
|
| 703 | + * @since 2.0.0 |
|
| 704 | + * @param array $values Values. |
|
| 705 | + * @param array $setting Setting. |
|
| 706 | + * @return array|WP_Error |
|
| 707 | + */ |
|
| 708 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
| 709 | + if ( empty( $values ) ) { |
|
| 710 | + return array(); |
|
| 711 | + } |
|
| 712 | + |
|
| 713 | + if ( ! is_array( $values ) ) { |
|
| 714 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
| 715 | + } |
|
| 716 | + |
|
| 717 | + $final_values = array(); |
|
| 718 | + foreach ( $values as $value ) { |
|
| 719 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
| 720 | + $final_values[] = $value; |
|
| 721 | + } |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + return $final_values; |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * Validate radio based settings. |
|
| 729 | + * |
|
| 730 | + * @since 2.0.0 |
|
| 731 | + * @param string $value Value. |
|
| 732 | + * @param array $setting Setting. |
|
| 733 | + * @return string|WP_Error |
|
| 734 | + */ |
|
| 735 | + public function validate_setting_radio_field( $value, $setting ) { |
|
| 736 | + return $this->validate_setting_select_field( $value, $setting ); |
|
| 737 | + } |
|
| 738 | + |
|
| 739 | + /** |
|
| 740 | + * Validate checkbox based settings. |
|
| 741 | + * |
|
| 742 | + * @since 2.0.0 |
|
| 743 | + * @param string $value Value. |
|
| 744 | + * @return int |
|
| 745 | + */ |
|
| 746 | + public function validate_setting_checkbox_field( $value ) { |
|
| 747 | + return (int) ! empty( $value ); |
|
| 748 | + } |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Validate textarea based settings. |
|
| 752 | + * |
|
| 753 | + * @since 2.0.0 |
|
| 754 | + * @param string $value Value. |
|
| 755 | + * @return string |
|
| 756 | + */ |
|
| 757 | + public function validate_setting_textarea_field( $value ) { |
|
| 758 | + $value = is_null( $value ) ? '' : $value; |
|
| 759 | + return wp_kses( |
|
| 760 | + trim( stripslashes( $value ) ), |
|
| 761 | + array_merge( |
|
| 762 | + array( |
|
| 763 | + 'iframe' => array( |
|
| 764 | + 'src' => true, |
|
| 765 | + 'style' => true, |
|
| 766 | + 'id' => true, |
|
| 767 | + 'class' => true, |
|
| 768 | + ), |
|
| 769 | + ), |
|
| 770 | + wp_kses_allowed_html( 'post' ) |
|
| 771 | + ) |
|
| 772 | + ); |
|
| 773 | + } |
|
| 774 | 774 | |
| 775 | 775 | } |
@@ -18,50 +18,50 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/top_earners'; |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/top_earners'; |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Get all data needed for this report and store in the class. |
|
| 30 | - */ |
|
| 31 | - protected function query_report_data() { |
|
| 28 | + /** |
|
| 29 | + * Get all data needed for this report and store in the class. |
|
| 30 | + */ |
|
| 31 | + protected function query_report_data() { |
|
| 32 | 32 | |
| 33 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 34 | - array( |
|
| 35 | - 'data' => array( |
|
| 36 | - 'quantity' => array( |
|
| 37 | - 'type' => 'invoice_item', |
|
| 38 | - 'function' => 'SUM', |
|
| 39 | - 'name' => 'invoice_item_qty', |
|
| 40 | - ), |
|
| 41 | - 'item_id' => array( |
|
| 42 | - 'type' => 'invoice_item', |
|
| 43 | - 'function' => '', |
|
| 44 | - 'name' => 'invoice_item_id', |
|
| 45 | - ), |
|
| 46 | - 'item_name' => array( |
|
| 47 | - 'type' => 'invoice_item', |
|
| 48 | - 'function' => '', |
|
| 49 | - 'name' => 'invoice_item_name', |
|
| 50 | - ), |
|
| 51 | - 'price' => array( |
|
| 52 | - 'type' => 'invoice_item', |
|
| 53 | - 'function' => 'SUM', |
|
| 54 | - 'name' => 'invoice_item_price', |
|
| 55 | - ), |
|
| 56 | - ), |
|
| 57 | - 'group_by' => 'invoice_item_id', |
|
| 58 | - 'order_by' => 'invoice_item_price DESC', |
|
| 59 | - 'query_type' => 'get_results', |
|
| 60 | - 'limit' => 10, |
|
| 61 | - 'filter_range' => $this->report_range, |
|
| 62 | - ) |
|
| 63 | - ); |
|
| 33 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 34 | + array( |
|
| 35 | + 'data' => array( |
|
| 36 | + 'quantity' => array( |
|
| 37 | + 'type' => 'invoice_item', |
|
| 38 | + 'function' => 'SUM', |
|
| 39 | + 'name' => 'invoice_item_qty', |
|
| 40 | + ), |
|
| 41 | + 'item_id' => array( |
|
| 42 | + 'type' => 'invoice_item', |
|
| 43 | + 'function' => '', |
|
| 44 | + 'name' => 'invoice_item_id', |
|
| 45 | + ), |
|
| 46 | + 'item_name' => array( |
|
| 47 | + 'type' => 'invoice_item', |
|
| 48 | + 'function' => '', |
|
| 49 | + 'name' => 'invoice_item_name', |
|
| 50 | + ), |
|
| 51 | + 'price' => array( |
|
| 52 | + 'type' => 'invoice_item', |
|
| 53 | + 'function' => 'SUM', |
|
| 54 | + 'name' => 'invoice_item_price', |
|
| 55 | + ), |
|
| 56 | + ), |
|
| 57 | + 'group_by' => 'invoice_item_id', |
|
| 58 | + 'order_by' => 'invoice_item_price DESC', |
|
| 59 | + 'query_type' => 'get_results', |
|
| 60 | + 'limit' => 10, |
|
| 61 | + 'filter_range' => $this->report_range, |
|
| 62 | + ) |
|
| 63 | + ); |
|
| 64 | 64 | |
| 65 | - } |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | 67 | } |
@@ -18,102 +18,102 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Invoice_Counts_Controller extends GetPaid_REST_Reports_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/invoices/counts'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Prepare a report object for serialization. |
|
| 30 | - * |
|
| 31 | - * @param stdClass $report Report data. |
|
| 32 | - * @param WP_REST_Request $request Request object. |
|
| 33 | - * @return WP_REST_Response $response Response data. |
|
| 34 | - */ |
|
| 35 | - public function prepare_item_for_response( $report, $request ) { |
|
| 36 | - |
|
| 37 | - $data = (array) $report; |
|
| 38 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 39 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 40 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 41 | - |
|
| 42 | - // Wrap the data in a response object. |
|
| 43 | - $response = rest_ensure_response( $data ); |
|
| 44 | - |
|
| 45 | - $response->add_links( |
|
| 46 | - array( |
|
| 47 | - 'about' => array( |
|
| 48 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 49 | - ), |
|
| 50 | - ) |
|
| 51 | - ); |
|
| 52 | - |
|
| 53 | - return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request ); |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Get reports list. |
|
| 58 | - * |
|
| 59 | - * @since 2.0.0 |
|
| 60 | - * @return array |
|
| 61 | - */ |
|
| 62 | - protected function get_reports() { |
|
| 63 | - |
|
| 64 | - $counts = wp_count_posts( 'wpi_invoice' ); |
|
| 65 | - $data = array(); |
|
| 66 | - |
|
| 67 | - foreach ( wpinv_get_invoice_statuses() as $slug => $name ) { |
|
| 68 | - |
|
| 69 | - if ( ! isset( $counts->$slug ) ) { |
|
| 70 | - continue; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - $data[] = array( |
|
| 74 | - 'slug' => $slug, |
|
| 75 | - 'name' => $name, |
|
| 76 | - 'count' => (int) $counts->$slug, |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return $data; |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 87 | - * |
|
| 88 | - * @return array |
|
| 89 | - */ |
|
| 90 | - public function get_item_schema() { |
|
| 91 | - $schema = array( |
|
| 92 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 93 | - 'title' => 'report_invoice_counts', |
|
| 94 | - 'type' => 'object', |
|
| 95 | - 'properties' => array( |
|
| 96 | - 'slug' => array( |
|
| 97 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 98 | - 'type' => 'string', |
|
| 99 | - 'context' => array( 'view' ), |
|
| 100 | - 'readonly' => true, |
|
| 101 | - ), |
|
| 102 | - 'name' => array( |
|
| 103 | - 'description' => __( 'Invoice status name.', 'invoicing' ), |
|
| 104 | - 'type' => 'string', |
|
| 105 | - 'context' => array( 'view' ), |
|
| 106 | - 'readonly' => true, |
|
| 107 | - ), |
|
| 108 | - 'count' => array( |
|
| 109 | - 'description' => __( 'Number of invoices.', 'invoicing' ), |
|
| 110 | - 'type' => 'string', |
|
| 111 | - 'context' => array( 'view' ), |
|
| 112 | - 'readonly' => true, |
|
| 113 | - ), |
|
| 114 | - ), |
|
| 115 | - ); |
|
| 116 | - |
|
| 117 | - return $this->add_additional_fields_schema( $schema ); |
|
| 118 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/invoices/counts'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Prepare a report object for serialization. |
|
| 30 | + * |
|
| 31 | + * @param stdClass $report Report data. |
|
| 32 | + * @param WP_REST_Request $request Request object. |
|
| 33 | + * @return WP_REST_Response $response Response data. |
|
| 34 | + */ |
|
| 35 | + public function prepare_item_for_response( $report, $request ) { |
|
| 36 | + |
|
| 37 | + $data = (array) $report; |
|
| 38 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 39 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 40 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 41 | + |
|
| 42 | + // Wrap the data in a response object. |
|
| 43 | + $response = rest_ensure_response( $data ); |
|
| 44 | + |
|
| 45 | + $response->add_links( |
|
| 46 | + array( |
|
| 47 | + 'about' => array( |
|
| 48 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 49 | + ), |
|
| 50 | + ) |
|
| 51 | + ); |
|
| 52 | + |
|
| 53 | + return apply_filters( 'getpaid_rest_prepare_report_invoices_count', $response, $report, $request ); |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Get reports list. |
|
| 58 | + * |
|
| 59 | + * @since 2.0.0 |
|
| 60 | + * @return array |
|
| 61 | + */ |
|
| 62 | + protected function get_reports() { |
|
| 63 | + |
|
| 64 | + $counts = wp_count_posts( 'wpi_invoice' ); |
|
| 65 | + $data = array(); |
|
| 66 | + |
|
| 67 | + foreach ( wpinv_get_invoice_statuses() as $slug => $name ) { |
|
| 68 | + |
|
| 69 | + if ( ! isset( $counts->$slug ) ) { |
|
| 70 | + continue; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + $data[] = array( |
|
| 74 | + 'slug' => $slug, |
|
| 75 | + 'name' => $name, |
|
| 76 | + 'count' => (int) $counts->$slug, |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return $data; |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 87 | + * |
|
| 88 | + * @return array |
|
| 89 | + */ |
|
| 90 | + public function get_item_schema() { |
|
| 91 | + $schema = array( |
|
| 92 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 93 | + 'title' => 'report_invoice_counts', |
|
| 94 | + 'type' => 'object', |
|
| 95 | + 'properties' => array( |
|
| 96 | + 'slug' => array( |
|
| 97 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 98 | + 'type' => 'string', |
|
| 99 | + 'context' => array( 'view' ), |
|
| 100 | + 'readonly' => true, |
|
| 101 | + ), |
|
| 102 | + 'name' => array( |
|
| 103 | + 'description' => __( 'Invoice status name.', 'invoicing' ), |
|
| 104 | + 'type' => 'string', |
|
| 105 | + 'context' => array( 'view' ), |
|
| 106 | + 'readonly' => true, |
|
| 107 | + ), |
|
| 108 | + 'count' => array( |
|
| 109 | + 'description' => __( 'Number of invoices.', 'invoicing' ), |
|
| 110 | + 'type' => 'string', |
|
| 111 | + 'context' => array( 'view' ), |
|
| 112 | + 'readonly' => true, |
|
| 113 | + ), |
|
| 114 | + ), |
|
| 115 | + ); |
|
| 116 | + |
|
| 117 | + return $this->add_additional_fields_schema( $schema ); |
|
| 118 | + } |
|
| 119 | 119 | } |
@@ -18,176 +18,176 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the routes for the objects of the controller. |
|
| 30 | - * |
|
| 31 | - * @since 2.0.0 |
|
| 32 | - * |
|
| 33 | - * @see register_rest_route() |
|
| 34 | - */ |
|
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 36 | - |
|
| 37 | - // List all available reports. |
|
| 38 | - register_rest_route( |
|
| 39 | - $namespace, |
|
| 40 | - $this->rest_base, |
|
| 41 | - array( |
|
| 42 | - array( |
|
| 43 | - 'methods' => WP_REST_Server::READABLE, |
|
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | - 'args' => $this->get_collection_params(), |
|
| 47 | - ), |
|
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | - ) |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Makes sure the current user has access to READ the report APIs. |
|
| 56 | - * |
|
| 57 | - * @since 2.0.0 |
|
| 58 | - * @param WP_REST_Request $request Full data about the request. |
|
| 59 | - * @return WP_Error|boolean |
|
| 60 | - */ |
|
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 62 | - |
|
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - return true; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Get reports list. |
|
| 72 | - * |
|
| 73 | - * @since 2.0.0 |
|
| 74 | - * @return array |
|
| 75 | - */ |
|
| 76 | - protected function get_reports() { |
|
| 77 | - |
|
| 78 | - $reports = array( |
|
| 79 | - array( |
|
| 80 | - 'slug' => 'sales', |
|
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'slug' => 'top_sellers', |
|
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | - ), |
|
| 87 | - array( |
|
| 88 | - 'slug' => 'top_earners', |
|
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | - ), |
|
| 91 | - array( |
|
| 92 | - 'slug' => 'invoices/counts', |
|
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | - ), |
|
| 95 | - ); |
|
| 96 | - |
|
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | - |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Get all reports. |
|
| 103 | - * |
|
| 104 | - * @since 2.0.0 |
|
| 105 | - * @param WP_REST_Request $request |
|
| 106 | - * @return array|WP_Error |
|
| 107 | - */ |
|
| 108 | - public function get_items( $request ) { |
|
| 109 | - $data = array(); |
|
| 110 | - $reports = $this->get_reports(); |
|
| 111 | - |
|
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - return rest_ensure_response( $data ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Prepare a report object for serialization. |
|
| 122 | - * |
|
| 123 | - * @since 2.0.0 |
|
| 124 | - * @param stdClass $report Report data. |
|
| 125 | - * @param WP_REST_Request $request Request object. |
|
| 126 | - * @return WP_REST_Response $response Response data. |
|
| 127 | - */ |
|
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 129 | - $data = array( |
|
| 130 | - 'slug' => $report->slug, |
|
| 131 | - 'description' => $report->description, |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | - |
|
| 138 | - // Wrap the data in a response object. |
|
| 139 | - $response = rest_ensure_response( $data ); |
|
| 140 | - $response->add_links( array( |
|
| 141 | - 'self' => array( |
|
| 142 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | - ), |
|
| 144 | - 'collection' => array( |
|
| 145 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | - ), |
|
| 147 | - ) ); |
|
| 148 | - |
|
| 149 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | - * |
|
| 155 | - * @since 2.0.0 |
|
| 156 | - * @return array |
|
| 157 | - */ |
|
| 158 | - public function get_item_schema() { |
|
| 159 | - $schema = array( |
|
| 160 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | - 'title' => 'report', |
|
| 162 | - 'type' => 'object', |
|
| 163 | - 'properties' => array( |
|
| 164 | - 'slug' => array( |
|
| 165 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | - 'type' => 'string', |
|
| 167 | - 'context' => array( 'view' ), |
|
| 168 | - 'readonly' => true, |
|
| 169 | - ), |
|
| 170 | - 'description' => array( |
|
| 171 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | - 'type' => 'string', |
|
| 173 | - 'context' => array( 'view' ), |
|
| 174 | - 'readonly' => true, |
|
| 175 | - ), |
|
| 176 | - ), |
|
| 177 | - ); |
|
| 178 | - |
|
| 179 | - return $this->add_additional_fields_schema( $schema ); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * Get the query params for collections. |
|
| 184 | - * |
|
| 185 | - * @since 2.0.0 |
|
| 186 | - * @return array |
|
| 187 | - */ |
|
| 188 | - public function get_collection_params() { |
|
| 189 | - return array( |
|
| 190 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | - ); |
|
| 192 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the routes for the objects of the controller. |
|
| 30 | + * |
|
| 31 | + * @since 2.0.0 |
|
| 32 | + * |
|
| 33 | + * @see register_rest_route() |
|
| 34 | + */ |
|
| 35 | + public function register_namespace_routes( $namespace ) { |
|
| 36 | + |
|
| 37 | + // List all available reports. |
|
| 38 | + register_rest_route( |
|
| 39 | + $namespace, |
|
| 40 | + $this->rest_base, |
|
| 41 | + array( |
|
| 42 | + array( |
|
| 43 | + 'methods' => WP_REST_Server::READABLE, |
|
| 44 | + 'callback' => array( $this, 'get_items' ), |
|
| 45 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | + 'args' => $this->get_collection_params(), |
|
| 47 | + ), |
|
| 48 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | + ) |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Makes sure the current user has access to READ the report APIs. |
|
| 56 | + * |
|
| 57 | + * @since 2.0.0 |
|
| 58 | + * @param WP_REST_Request $request Full data about the request. |
|
| 59 | + * @return WP_Error|boolean |
|
| 60 | + */ |
|
| 61 | + public function get_items_permissions_check( $request ) { |
|
| 62 | + |
|
| 63 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + return true; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Get reports list. |
|
| 72 | + * |
|
| 73 | + * @since 2.0.0 |
|
| 74 | + * @return array |
|
| 75 | + */ |
|
| 76 | + protected function get_reports() { |
|
| 77 | + |
|
| 78 | + $reports = array( |
|
| 79 | + array( |
|
| 80 | + 'slug' => 'sales', |
|
| 81 | + 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'slug' => 'top_sellers', |
|
| 85 | + 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | + ), |
|
| 87 | + array( |
|
| 88 | + 'slug' => 'top_earners', |
|
| 89 | + 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | + ), |
|
| 91 | + array( |
|
| 92 | + 'slug' => 'invoices/counts', |
|
| 93 | + 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | + ), |
|
| 95 | + ); |
|
| 96 | + |
|
| 97 | + return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | + |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Get all reports. |
|
| 103 | + * |
|
| 104 | + * @since 2.0.0 |
|
| 105 | + * @param WP_REST_Request $request |
|
| 106 | + * @return array|WP_Error |
|
| 107 | + */ |
|
| 108 | + public function get_items( $request ) { |
|
| 109 | + $data = array(); |
|
| 110 | + $reports = $this->get_reports(); |
|
| 111 | + |
|
| 112 | + foreach ( $reports as $report ) { |
|
| 113 | + $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + return rest_ensure_response( $data ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Prepare a report object for serialization. |
|
| 122 | + * |
|
| 123 | + * @since 2.0.0 |
|
| 124 | + * @param stdClass $report Report data. |
|
| 125 | + * @param WP_REST_Request $request Request object. |
|
| 126 | + * @return WP_REST_Response $response Response data. |
|
| 127 | + */ |
|
| 128 | + public function prepare_item_for_response( $report, $request ) { |
|
| 129 | + $data = array( |
|
| 130 | + 'slug' => $report->slug, |
|
| 131 | + 'description' => $report->description, |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | + |
|
| 138 | + // Wrap the data in a response object. |
|
| 139 | + $response = rest_ensure_response( $data ); |
|
| 140 | + $response->add_links( array( |
|
| 141 | + 'self' => array( |
|
| 142 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | + ), |
|
| 144 | + 'collection' => array( |
|
| 145 | + 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | + ), |
|
| 147 | + ) ); |
|
| 148 | + |
|
| 149 | + return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | + * |
|
| 155 | + * @since 2.0.0 |
|
| 156 | + * @return array |
|
| 157 | + */ |
|
| 158 | + public function get_item_schema() { |
|
| 159 | + $schema = array( |
|
| 160 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | + 'title' => 'report', |
|
| 162 | + 'type' => 'object', |
|
| 163 | + 'properties' => array( |
|
| 164 | + 'slug' => array( |
|
| 165 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | + 'type' => 'string', |
|
| 167 | + 'context' => array( 'view' ), |
|
| 168 | + 'readonly' => true, |
|
| 169 | + ), |
|
| 170 | + 'description' => array( |
|
| 171 | + 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | + 'type' => 'string', |
|
| 173 | + 'context' => array( 'view' ), |
|
| 174 | + 'readonly' => true, |
|
| 175 | + ), |
|
| 176 | + ), |
|
| 177 | + ); |
|
| 178 | + |
|
| 179 | + return $this->add_additional_fields_schema( $schema ); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * Get the query params for collections. |
|
| 184 | + * |
|
| 185 | + * @since 2.0.0 |
|
| 186 | + * @return array |
|
| 187 | + */ |
|
| 188 | + public function get_collection_params() { |
|
| 189 | + return array( |
|
| 190 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | + ); |
|
| 192 | + } |
|
| 193 | 193 | } |
@@ -12,43 +12,43 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Retrieves the earning graphs. |
|
| 17 | - * |
|
| 18 | - */ |
|
| 19 | - public function get_graphs() { |
|
| 15 | + /** |
|
| 16 | + * Retrieves the earning graphs. |
|
| 17 | + * |
|
| 18 | + */ |
|
| 19 | + public function get_graphs() { |
|
| 20 | 20 | |
| 21 | - $graphs = array( |
|
| 21 | + $graphs = array( |
|
| 22 | 22 | |
| 23 | 23 | 'total' => __( 'Earnings', 'invoicing' ), |
| 24 | 24 | 'discount' => __( 'Discount', 'invoicing' ), |
| 25 | - 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
| 25 | + 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | + 'tax' => __( 'Tax', 'invoicing' ), |
|
| 27 | 27 | |
| 28 | - ); |
|
| 28 | + ); |
|
| 29 | 29 | |
| 30 | - return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 30 | + return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 31 | 31 | |
| 32 | - } |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Retrieves the earning sql. |
|
| 36 | - * |
|
| 37 | - */ |
|
| 38 | - public function get_sql( $range ) { |
|
| 39 | - global $wpdb; |
|
| 34 | + /** |
|
| 35 | + * Retrieves the earning sql. |
|
| 36 | + * |
|
| 37 | + */ |
|
| 38 | + public function get_sql( $range ) { |
|
| 39 | + global $wpdb; |
|
| 40 | 40 | |
| 41 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | - $clauses = $this->get_range_sql( $range ); |
|
| 43 | - $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | - $graphs_sql = array(); |
|
| 41 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | + $clauses = $this->get_range_sql( $range ); |
|
| 43 | + $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | + $graphs_sql = array(); |
|
| 45 | 45 | |
| 46 | - foreach ( $graphs as $graph ) { |
|
| 47 | - $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | - } |
|
| 46 | + foreach ( $graphs as $graph ) { |
|
| 47 | + $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | - $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 50 | + $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | + $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 52 | 52 | FROM $wpdb->posts |
| 53 | 53 | LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID |
| 54 | 54 | WHERE meta.post_id IS NOT NULL |
@@ -58,94 +58,94 @@ discard block |
||
| 58 | 58 | GROUP BY {$clauses[0]} |
| 59 | 59 | "; |
| 60 | 60 | |
| 61 | - return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | - |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Prepares the report stats. |
|
| 67 | - * |
|
| 68 | - */ |
|
| 69 | - public function prepare_stats() { |
|
| 70 | - global $wpdb; |
|
| 71 | - $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Retrieves report labels. |
|
| 76 | - * |
|
| 77 | - */ |
|
| 78 | - public function get_labels( $range ) { |
|
| 79 | - |
|
| 80 | - $labels = array( |
|
| 81 | - 'today' => $this->get_hours_in_a_day(), |
|
| 82 | - 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | - '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | - '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | - '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | - '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | - '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | - '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | - ); |
|
| 90 | - |
|
| 91 | - $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | - return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Retrieves report datasets. |
|
| 97 | - * |
|
| 98 | - */ |
|
| 99 | - public function get_datasets( $labels ) { |
|
| 100 | - |
|
| 101 | - $datasets = array(); |
|
| 102 | - |
|
| 103 | - foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | - $datasets[ $key ] = array( |
|
| 105 | - 'label' => $label, |
|
| 106 | - 'data' => $this->get_data( $key, $labels ) |
|
| 107 | - ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Retrieves report data. |
|
| 115 | - * |
|
| 116 | - */ |
|
| 117 | - public function get_data( $key, $labels ) { |
|
| 118 | - |
|
| 119 | - $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | - $prepared = array(); |
|
| 121 | - |
|
| 122 | - foreach ( $labels as $label ) { |
|
| 123 | - |
|
| 124 | - $value = 0; |
|
| 125 | - if ( isset( $data[ $label ] ) ) { |
|
| 126 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - $prepared[] = $value; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | - |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Displays the report card. |
|
| 138 | - * |
|
| 139 | - */ |
|
| 140 | - public function display() { |
|
| 141 | - |
|
| 142 | - $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | - $chart_data = array( |
|
| 144 | - 'labels' => array_values( $labels ), |
|
| 145 | - 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - ?> |
|
| 61 | + return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | + |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Prepares the report stats. |
|
| 67 | + * |
|
| 68 | + */ |
|
| 69 | + public function prepare_stats() { |
|
| 70 | + global $wpdb; |
|
| 71 | + $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Retrieves report labels. |
|
| 76 | + * |
|
| 77 | + */ |
|
| 78 | + public function get_labels( $range ) { |
|
| 79 | + |
|
| 80 | + $labels = array( |
|
| 81 | + 'today' => $this->get_hours_in_a_day(), |
|
| 82 | + 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | + '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | + '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | + '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | + '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | + '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | + '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | + ); |
|
| 90 | + |
|
| 91 | + $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | + return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Retrieves report datasets. |
|
| 97 | + * |
|
| 98 | + */ |
|
| 99 | + public function get_datasets( $labels ) { |
|
| 100 | + |
|
| 101 | + $datasets = array(); |
|
| 102 | + |
|
| 103 | + foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | + $datasets[ $key ] = array( |
|
| 105 | + 'label' => $label, |
|
| 106 | + 'data' => $this->get_data( $key, $labels ) |
|
| 107 | + ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Retrieves report data. |
|
| 115 | + * |
|
| 116 | + */ |
|
| 117 | + public function get_data( $key, $labels ) { |
|
| 118 | + |
|
| 119 | + $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | + $prepared = array(); |
|
| 121 | + |
|
| 122 | + foreach ( $labels as $label ) { |
|
| 123 | + |
|
| 124 | + $value = 0; |
|
| 125 | + if ( isset( $data[ $label ] ) ) { |
|
| 126 | + $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + $prepared[] = $value; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | + |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Displays the report card. |
|
| 138 | + * |
|
| 139 | + */ |
|
| 140 | + public function display() { |
|
| 141 | + |
|
| 142 | + $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | + $chart_data = array( |
|
| 144 | + 'labels' => array_values( $labels ), |
|
| 145 | + 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + ?> |
|
| 149 | 149 | |
| 150 | 150 | <?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?> |
| 151 | 151 | <div class="row mb-4"> |
@@ -165,15 +165,15 @@ discard block |
||
| 165 | 165 | |
| 166 | 166 | <?php |
| 167 | 167 | |
| 168 | - } |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - /** |
|
| 171 | - * Displays the actual report. |
|
| 172 | - * |
|
| 173 | - */ |
|
| 174 | - public function display_graph( $key, $dataset, $labels ) { |
|
| 170 | + /** |
|
| 171 | + * Displays the actual report. |
|
| 172 | + * |
|
| 173 | + */ |
|
| 174 | + public function display_graph( $key, $dataset, $labels ) { |
|
| 175 | 175 | |
| 176 | - ?> |
|
| 176 | + ?> |
|
| 177 | 177 | |
| 178 | 178 | <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas> |
| 179 | 179 | |
@@ -223,20 +223,20 @@ discard block |
||
| 223 | 223 | </script> |
| 224 | 224 | |
| 225 | 225 | <?php |
| 226 | - } |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * Displays the actual report. |
|
| 230 | - * |
|
| 231 | - */ |
|
| 232 | - public function display_stats() {} |
|
| 228 | + /** |
|
| 229 | + * Displays the actual report. |
|
| 230 | + * |
|
| 231 | + */ |
|
| 232 | + public function display_stats() {} |
|
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Displays the range selector. |
|
| 236 | - * |
|
| 237 | - */ |
|
| 238 | - public function display_range_selector() { |
|
| 234 | + /** |
|
| 235 | + * Displays the range selector. |
|
| 236 | + * |
|
| 237 | + */ |
|
| 238 | + public function display_range_selector() { |
|
| 239 | 239 | |
| 240 | - } |
|
| 240 | + } |
|
| 241 | 241 | |
| 242 | 242 | } |
@@ -18,664 +18,664 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/sales'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * The report data. |
|
| 30 | - * |
|
| 31 | - * @var stdClass |
|
| 32 | - */ |
|
| 33 | - protected $report_data; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The report range. |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - protected $report_range; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Registers the routes for the objects of the controller. |
|
| 44 | - * |
|
| 45 | - * @since 2.0.0 |
|
| 46 | - * |
|
| 47 | - * @see register_rest_route() |
|
| 48 | - */ |
|
| 49 | - public function register_namespace_routes( $namespace ) { |
|
| 50 | - |
|
| 51 | - // Get sales report. |
|
| 52 | - register_rest_route( |
|
| 53 | - $namespace, |
|
| 54 | - $this->rest_base, |
|
| 55 | - array( |
|
| 56 | - array( |
|
| 57 | - 'methods' => WP_REST_Server::READABLE, |
|
| 58 | - 'callback' => array( $this, 'get_items' ), |
|
| 59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | - 'args' => $this->get_collection_params(), |
|
| 61 | - ), |
|
| 62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Makes sure the current user has access to READ the report APIs. |
|
| 70 | - * |
|
| 71 | - * @since 2.0.0 |
|
| 72 | - * @param WP_REST_Request $request Full data about the request. |
|
| 73 | - * @return WP_Error|boolean |
|
| 74 | - */ |
|
| 75 | - public function get_items_permissions_check( $request ) { |
|
| 76 | - |
|
| 77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Get sales reports. |
|
| 86 | - * |
|
| 87 | - * @param WP_REST_Request $request |
|
| 88 | - * @return array|WP_Error |
|
| 89 | - */ |
|
| 90 | - public function get_items( $request ) { |
|
| 91 | - $data = array(); |
|
| 92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | - |
|
| 95 | - return rest_ensure_response( $data ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Prepare a report sales object for serialization. |
|
| 100 | - * |
|
| 101 | - * @param null $_ |
|
| 102 | - * @param WP_REST_Request $request Request object. |
|
| 103 | - * @return WP_REST_Response $response Response data. |
|
| 104 | - */ |
|
| 105 | - public function prepare_item_for_response( $_, $request ) { |
|
| 106 | - |
|
| 107 | - // Set report range. |
|
| 108 | - $this->report_range = $this->get_date_range( $request ); |
|
| 109 | - |
|
| 110 | - $report_data = $this->get_report_data(); |
|
| 111 | - $period_totals = array(); |
|
| 112 | - |
|
| 113 | - // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | - |
|
| 116 | - if ( 'month' === $this->groupby ) { |
|
| 117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | - |
|
| 122 | - switch ( $this->groupby ) { |
|
| 123 | - case 'day' : |
|
| 124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | - break; |
|
| 126 | - default : |
|
| 127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | - break; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // Set the defaults for each period. |
|
| 132 | - $period_totals[ $time ] = array( |
|
| 133 | - 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | - 'invoices' => 0, |
|
| 135 | - 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | - 'items' => 0, |
|
| 137 | - 'refunded_items' => 0, |
|
| 138 | - 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | - 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | - ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - // add total sales, total invoice count, total tax for each period |
|
| 150 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | - foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | - |
|
| 154 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | - continue; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | - |
|
| 168 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | - continue; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | - |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | - |
|
| 182 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - // Add total invoice items for each period. |
|
| 189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | - |
|
| 192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - // Add total discount for each period. |
|
| 199 | - foreach ( $report_data->coupons as $discount ) { |
|
| 200 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | - |
|
| 202 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - $report_data->totals = $period_totals; |
|
| 209 | - $report_data->grouped_by = $this->groupby; |
|
| 210 | - $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | - $report_data->currency = wpinv_get_currency(); |
|
| 212 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | - $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | - $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | - |
|
| 223 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | - $data = $report_data; |
|
| 225 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | - |
|
| 229 | - // Wrap the data in a response object. |
|
| 230 | - $response = rest_ensure_response( $data ); |
|
| 231 | - $response->add_links( array( |
|
| 232 | - 'about' => array( |
|
| 233 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | - ), |
|
| 235 | - ) ); |
|
| 236 | - |
|
| 237 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * Get report data. |
|
| 242 | - * |
|
| 243 | - * @return stdClass |
|
| 244 | - */ |
|
| 245 | - public function get_report_data() { |
|
| 246 | - if ( empty( $this->report_data ) ) { |
|
| 247 | - $this->query_report_data(); |
|
| 248 | - } |
|
| 249 | - return $this->report_data; |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Get all data needed for this report and store in the class. |
|
| 254 | - */ |
|
| 255 | - protected function query_report_data() { |
|
| 256 | - |
|
| 257 | - // Prepare reports. |
|
| 258 | - $this->report_data = (object) array( |
|
| 259 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | - 'previous_range' => $this->previous_range, |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Calculated totals. |
|
| 269 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - // Calculate average based on net. |
|
| 284 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | - |
|
| 287 | - // Total invoices in this period, even if refunded. |
|
| 288 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | - |
|
| 290 | - // Items invoiced in this period, even if refunded. |
|
| 291 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | - |
|
| 293 | - // 3rd party filtering of report data |
|
| 294 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Prepares invoice counts. |
|
| 299 | - * |
|
| 300 | - * @return array. |
|
| 301 | - */ |
|
| 302 | - protected function query_invoice_counts() { |
|
| 303 | - |
|
| 304 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | - array( |
|
| 306 | - 'data' => array( |
|
| 307 | - 'ID' => array( |
|
| 308 | - 'type' => 'post_data', |
|
| 309 | - 'function' => 'COUNT', |
|
| 310 | - 'name' => 'count', |
|
| 311 | - 'distinct' => true, |
|
| 312 | - ), |
|
| 313 | - 'post_date' => array( |
|
| 314 | - 'type' => 'post_data', |
|
| 315 | - 'function' => '', |
|
| 316 | - 'name' => 'post_date', |
|
| 317 | - ), |
|
| 318 | - ), |
|
| 319 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | - 'order_by' => 'post_date ASC', |
|
| 321 | - 'query_type' => 'get_results', |
|
| 322 | - 'filter_range' => $this->report_range, |
|
| 323 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | - ) |
|
| 325 | - ); |
|
| 326 | - |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - /** |
|
| 330 | - * Prepares coupon counts. |
|
| 331 | - * |
|
| 332 | - * @return array. |
|
| 333 | - */ |
|
| 334 | - protected function query_coupon_counts() { |
|
| 335 | - |
|
| 336 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | - array( |
|
| 338 | - 'data' => array( |
|
| 339 | - 'discount' => array( |
|
| 340 | - 'type' => 'invoice_data', |
|
| 341 | - 'function' => 'SUM', |
|
| 342 | - 'name' => 'discount_amount', |
|
| 343 | - ), |
|
| 344 | - 'post_date' => array( |
|
| 345 | - 'type' => 'post_data', |
|
| 346 | - 'function' => '', |
|
| 347 | - 'name' => 'post_date', |
|
| 348 | - ), |
|
| 349 | - ), |
|
| 350 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | - 'order_by' => 'post_date ASC', |
|
| 352 | - 'query_type' => 'get_results', |
|
| 353 | - 'filter_range' => $this->report_range, |
|
| 354 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | - ) |
|
| 356 | - ); |
|
| 357 | - |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Prepares item counts. |
|
| 362 | - * |
|
| 363 | - * @return array. |
|
| 364 | - */ |
|
| 365 | - protected function query_item_counts() { |
|
| 366 | - |
|
| 367 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | - array( |
|
| 369 | - 'data' => array( |
|
| 370 | - 'quantity' => array( |
|
| 371 | - 'type' => 'invoice_item', |
|
| 372 | - 'function' => 'SUM', |
|
| 373 | - 'name' => 'invoice_item_count', |
|
| 374 | - ), |
|
| 375 | - 'post_date' => array( |
|
| 376 | - 'type' => 'post_data', |
|
| 377 | - 'function' => '', |
|
| 378 | - 'name' => 'post_date', |
|
| 379 | - ), |
|
| 380 | - ), |
|
| 381 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | - 'order_by' => 'post_date ASC', |
|
| 383 | - 'query_type' => 'get_results', |
|
| 384 | - 'filter_range' => $this->report_range, |
|
| 385 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | - ) |
|
| 387 | - ); |
|
| 388 | - |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * Prepares refunded item counts. |
|
| 393 | - * |
|
| 394 | - * @return array. |
|
| 395 | - */ |
|
| 396 | - protected function count_refunded_items() { |
|
| 397 | - |
|
| 398 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | - array( |
|
| 400 | - 'data' => array( |
|
| 401 | - 'quantity' => array( |
|
| 402 | - 'type' => 'invoice_item', |
|
| 403 | - 'function' => 'SUM', |
|
| 404 | - 'name' => 'invoice_item_count', |
|
| 405 | - ), |
|
| 406 | - ), |
|
| 407 | - 'query_type' => 'get_var', |
|
| 408 | - 'filter_range' => $this->report_range, |
|
| 409 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | - ) |
|
| 411 | - ); |
|
| 412 | - |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - /** |
|
| 416 | - * Prepares daily invoice totals. |
|
| 417 | - * |
|
| 418 | - * @return array. |
|
| 419 | - */ |
|
| 420 | - protected function query_invoice_totals() { |
|
| 421 | - |
|
| 422 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | - array( |
|
| 424 | - 'data' => array( |
|
| 425 | - 'total' => array( |
|
| 426 | - 'type' => 'invoice_data', |
|
| 427 | - 'function' => 'SUM', |
|
| 428 | - 'name' => 'total_sales', |
|
| 429 | - ), |
|
| 430 | - 'tax' => array( |
|
| 431 | - 'type' => 'invoice_data', |
|
| 432 | - 'function' => 'SUM', |
|
| 433 | - 'name' => 'total_tax', |
|
| 434 | - ), |
|
| 435 | - 'discount' => array( |
|
| 436 | - 'type' => 'invoice_data', |
|
| 437 | - 'function' => 'SUM', |
|
| 438 | - 'name' => 'total_discount', |
|
| 439 | - ), |
|
| 440 | - 'fees_total' => array( |
|
| 441 | - 'type' => 'invoice_data', |
|
| 442 | - 'function' => 'SUM', |
|
| 443 | - 'name' => 'total_fees', |
|
| 444 | - ), |
|
| 445 | - 'subtotal' => array( |
|
| 446 | - 'type' => 'invoice_data', |
|
| 447 | - 'function' => 'SUM', |
|
| 448 | - 'name' => 'subtotal', |
|
| 449 | - ), |
|
| 450 | - 'post_date' => array( |
|
| 451 | - 'type' => 'post_data', |
|
| 452 | - 'function' => '', |
|
| 453 | - 'name' => 'post_date', |
|
| 454 | - ), |
|
| 455 | - ), |
|
| 456 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | - 'order_by' => 'post_date ASC', |
|
| 458 | - 'query_type' => 'get_results', |
|
| 459 | - 'filter_range' => $this->report_range, |
|
| 460 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | - ) |
|
| 462 | - ); |
|
| 463 | - |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Prepares daily invoice totals. |
|
| 468 | - * |
|
| 469 | - * @return array. |
|
| 470 | - */ |
|
| 471 | - protected function query_refunded_totals() { |
|
| 472 | - |
|
| 473 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | - array( |
|
| 475 | - 'data' => array( |
|
| 476 | - 'total' => array( |
|
| 477 | - 'type' => 'invoice_data', |
|
| 478 | - 'function' => 'SUM', |
|
| 479 | - 'name' => 'total_sales', |
|
| 480 | - ), |
|
| 481 | - 'tax' => array( |
|
| 482 | - 'type' => 'invoice_data', |
|
| 483 | - 'function' => 'SUM', |
|
| 484 | - 'name' => 'total_tax', |
|
| 485 | - ), |
|
| 486 | - 'discount' => array( |
|
| 487 | - 'type' => 'invoice_data', |
|
| 488 | - 'function' => 'SUM', |
|
| 489 | - 'name' => 'total_discount', |
|
| 490 | - ), |
|
| 491 | - 'fees_total' => array( |
|
| 492 | - 'type' => 'invoice_data', |
|
| 493 | - 'function' => 'SUM', |
|
| 494 | - 'name' => 'total_fees', |
|
| 495 | - ), |
|
| 496 | - 'subtotal' => array( |
|
| 497 | - 'type' => 'invoice_data', |
|
| 498 | - 'function' => 'SUM', |
|
| 499 | - 'name' => 'subtotal', |
|
| 500 | - ), |
|
| 501 | - 'post_date' => array( |
|
| 502 | - 'type' => 'post_data', |
|
| 503 | - 'function' => '', |
|
| 504 | - 'name' => 'post_date', |
|
| 505 | - ), |
|
| 506 | - ), |
|
| 507 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | - 'order_by' => 'post_date ASC', |
|
| 509 | - 'query_type' => 'get_results', |
|
| 510 | - 'filter_range' => $this->report_range, |
|
| 511 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | - ) |
|
| 513 | - ); |
|
| 514 | - |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | - * |
|
| 520 | - * @return array |
|
| 521 | - */ |
|
| 522 | - public function get_item_schema() { |
|
| 523 | - |
|
| 524 | - $schema = array( |
|
| 525 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | - 'title' => 'sales_report', |
|
| 527 | - 'type' => 'object', |
|
| 528 | - 'properties' => array( |
|
| 529 | - 'total_sales' => array( |
|
| 530 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | - 'type' => 'string', |
|
| 532 | - 'context' => array( 'view' ), |
|
| 533 | - 'readonly' => true, |
|
| 534 | - ), |
|
| 535 | - 'net_sales' => array( |
|
| 536 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | - 'type' => 'string', |
|
| 538 | - 'context' => array( 'view' ), |
|
| 539 | - 'readonly' => true, |
|
| 540 | - ), |
|
| 541 | - 'average_sales' => array( |
|
| 542 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | - 'type' => 'string', |
|
| 544 | - 'context' => array( 'view' ), |
|
| 545 | - 'readonly' => true, |
|
| 546 | - ), |
|
| 547 | - 'average_total_sales' => array( |
|
| 548 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | - 'type' => 'string', |
|
| 550 | - 'context' => array( 'view' ), |
|
| 551 | - 'readonly' => true, |
|
| 552 | - ), |
|
| 553 | - 'total_invoices' => array( |
|
| 554 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | - 'type' => 'integer', |
|
| 556 | - 'context' => array( 'view' ), |
|
| 557 | - 'readonly' => true, |
|
| 558 | - ), |
|
| 559 | - 'total_items' => array( |
|
| 560 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | - 'type' => 'integer', |
|
| 562 | - 'context' => array( 'view' ), |
|
| 563 | - 'readonly' => true, |
|
| 564 | - ), |
|
| 565 | - 'refunded_items' => array( |
|
| 566 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | - 'type' => 'integer', |
|
| 568 | - 'context' => array( 'view' ), |
|
| 569 | - 'readonly' => true, |
|
| 570 | - ), |
|
| 571 | - 'total_tax' => array( |
|
| 572 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | - 'type' => 'string', |
|
| 574 | - 'context' => array( 'view' ), |
|
| 575 | - 'readonly' => true, |
|
| 576 | - ), |
|
| 577 | - 'total_refunded_tax' => array( |
|
| 578 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | - 'type' => 'string', |
|
| 580 | - 'context' => array( 'view' ), |
|
| 581 | - 'readonly' => true, |
|
| 582 | - ), |
|
| 583 | - 'total_fees' => array( |
|
| 584 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | - 'type' => 'string', |
|
| 586 | - 'context' => array( 'view' ), |
|
| 587 | - 'readonly' => true, |
|
| 588 | - ), |
|
| 589 | - 'total_refunds' => array( |
|
| 590 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | - 'type' => 'integer', |
|
| 592 | - 'context' => array( 'view' ), |
|
| 593 | - 'readonly' => true, |
|
| 594 | - ), |
|
| 595 | - 'net_refunds' => array( |
|
| 596 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | - 'type' => 'integer', |
|
| 598 | - 'context' => array( 'view' ), |
|
| 599 | - 'readonly' => true, |
|
| 600 | - ), |
|
| 601 | - 'total_discount' => array( |
|
| 602 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | - 'type' => 'integer', |
|
| 604 | - 'context' => array( 'view' ), |
|
| 605 | - 'readonly' => true, |
|
| 606 | - ), |
|
| 607 | - 'totals' => array( |
|
| 608 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | - 'type' => 'array', |
|
| 610 | - 'items' => array( |
|
| 611 | - 'type' => 'array', |
|
| 612 | - ), |
|
| 613 | - 'context' => array( 'view' ), |
|
| 614 | - 'readonly' => true, |
|
| 615 | - ), |
|
| 616 | - 'interval' => array( |
|
| 617 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | - 'type' => 'integer', |
|
| 619 | - 'context' => array( 'view' ), |
|
| 620 | - 'readonly' => true, |
|
| 621 | - ), |
|
| 622 | - 'previous_range' => array( |
|
| 623 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | - 'type' => 'array', |
|
| 625 | - 'items' => array( |
|
| 626 | - 'type' => 'string', |
|
| 627 | - ), |
|
| 628 | - 'context' => array( 'view' ), |
|
| 629 | - 'readonly' => true, |
|
| 630 | - ), |
|
| 631 | - 'grouped_by' => array( |
|
| 632 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | - 'type' => 'string', |
|
| 634 | - 'context' => array( 'view' ), |
|
| 635 | - 'enum' => array( 'day', 'month' ), |
|
| 636 | - 'readonly' => true, |
|
| 637 | - ), |
|
| 638 | - 'currency' => array( |
|
| 639 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | - 'type' => 'string', |
|
| 641 | - 'context' => array( 'view' ), |
|
| 642 | - 'readonly' => true, |
|
| 643 | - ), |
|
| 644 | - 'currency_symbol' => array( |
|
| 645 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | - 'type' => 'string', |
|
| 647 | - 'context' => array( 'view' ), |
|
| 648 | - 'readonly' => true, |
|
| 649 | - ), |
|
| 650 | - 'currency_position' => array( |
|
| 651 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | - 'type' => 'string', |
|
| 653 | - 'context' => array( 'view' ), |
|
| 654 | - 'readonly' => true, |
|
| 655 | - ), |
|
| 656 | - 'decimal_places' => array( |
|
| 657 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | - 'type' => 'string', |
|
| 659 | - 'context' => array( 'view' ), |
|
| 660 | - 'readonly' => true, |
|
| 661 | - ), |
|
| 662 | - 'thousands_sep' => array( |
|
| 663 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | - 'type' => 'string', |
|
| 665 | - 'context' => array( 'view' ), |
|
| 666 | - 'readonly' => true, |
|
| 667 | - ), |
|
| 668 | - 'decimals_sep' => array( |
|
| 669 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | - 'type' => 'string', |
|
| 671 | - 'context' => array( 'view' ), |
|
| 672 | - 'readonly' => true, |
|
| 673 | - ), |
|
| 674 | - ), |
|
| 675 | - ); |
|
| 676 | - |
|
| 677 | - return $this->add_additional_fields_schema( $schema ); |
|
| 678 | - |
|
| 679 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/sales'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * The report data. |
|
| 30 | + * |
|
| 31 | + * @var stdClass |
|
| 32 | + */ |
|
| 33 | + protected $report_data; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The report range. |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + protected $report_range; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Registers the routes for the objects of the controller. |
|
| 44 | + * |
|
| 45 | + * @since 2.0.0 |
|
| 46 | + * |
|
| 47 | + * @see register_rest_route() |
|
| 48 | + */ |
|
| 49 | + public function register_namespace_routes( $namespace ) { |
|
| 50 | + |
|
| 51 | + // Get sales report. |
|
| 52 | + register_rest_route( |
|
| 53 | + $namespace, |
|
| 54 | + $this->rest_base, |
|
| 55 | + array( |
|
| 56 | + array( |
|
| 57 | + 'methods' => WP_REST_Server::READABLE, |
|
| 58 | + 'callback' => array( $this, 'get_items' ), |
|
| 59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | + 'args' => $this->get_collection_params(), |
|
| 61 | + ), |
|
| 62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Makes sure the current user has access to READ the report APIs. |
|
| 70 | + * |
|
| 71 | + * @since 2.0.0 |
|
| 72 | + * @param WP_REST_Request $request Full data about the request. |
|
| 73 | + * @return WP_Error|boolean |
|
| 74 | + */ |
|
| 75 | + public function get_items_permissions_check( $request ) { |
|
| 76 | + |
|
| 77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Get sales reports. |
|
| 86 | + * |
|
| 87 | + * @param WP_REST_Request $request |
|
| 88 | + * @return array|WP_Error |
|
| 89 | + */ |
|
| 90 | + public function get_items( $request ) { |
|
| 91 | + $data = array(); |
|
| 92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | + |
|
| 95 | + return rest_ensure_response( $data ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Prepare a report sales object for serialization. |
|
| 100 | + * |
|
| 101 | + * @param null $_ |
|
| 102 | + * @param WP_REST_Request $request Request object. |
|
| 103 | + * @return WP_REST_Response $response Response data. |
|
| 104 | + */ |
|
| 105 | + public function prepare_item_for_response( $_, $request ) { |
|
| 106 | + |
|
| 107 | + // Set report range. |
|
| 108 | + $this->report_range = $this->get_date_range( $request ); |
|
| 109 | + |
|
| 110 | + $report_data = $this->get_report_data(); |
|
| 111 | + $period_totals = array(); |
|
| 112 | + |
|
| 113 | + // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | + $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | + |
|
| 116 | + if ( 'month' === $this->groupby ) { |
|
| 117 | + $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | + |
|
| 122 | + switch ( $this->groupby ) { |
|
| 123 | + case 'day' : |
|
| 124 | + $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | + break; |
|
| 126 | + default : |
|
| 127 | + $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | + break; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // Set the defaults for each period. |
|
| 132 | + $period_totals[ $time ] = array( |
|
| 133 | + 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | + 'invoices' => 0, |
|
| 135 | + 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | + 'items' => 0, |
|
| 137 | + 'refunded_items' => 0, |
|
| 138 | + 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | + 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | + ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + // add total sales, total invoice count, total tax for each period |
|
| 150 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | + foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | + |
|
| 154 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | + continue; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | + |
|
| 168 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | + continue; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | + |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | + |
|
| 182 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + // Add total invoice items for each period. |
|
| 189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | + |
|
| 192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + // Add total discount for each period. |
|
| 199 | + foreach ( $report_data->coupons as $discount ) { |
|
| 200 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | + |
|
| 202 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + $report_data->totals = $period_totals; |
|
| 209 | + $report_data->grouped_by = $this->groupby; |
|
| 210 | + $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | + $report_data->currency = wpinv_get_currency(); |
|
| 212 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | + $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | + $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | + |
|
| 223 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | + $data = $report_data; |
|
| 225 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | + |
|
| 229 | + // Wrap the data in a response object. |
|
| 230 | + $response = rest_ensure_response( $data ); |
|
| 231 | + $response->add_links( array( |
|
| 232 | + 'about' => array( |
|
| 233 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | + ), |
|
| 235 | + ) ); |
|
| 236 | + |
|
| 237 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Get report data. |
|
| 242 | + * |
|
| 243 | + * @return stdClass |
|
| 244 | + */ |
|
| 245 | + public function get_report_data() { |
|
| 246 | + if ( empty( $this->report_data ) ) { |
|
| 247 | + $this->query_report_data(); |
|
| 248 | + } |
|
| 249 | + return $this->report_data; |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Get all data needed for this report and store in the class. |
|
| 254 | + */ |
|
| 255 | + protected function query_report_data() { |
|
| 256 | + |
|
| 257 | + // Prepare reports. |
|
| 258 | + $this->report_data = (object) array( |
|
| 259 | + 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | + 'previous_range' => $this->previous_range, |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Calculated totals. |
|
| 269 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + // Calculate average based on net. |
|
| 284 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | + |
|
| 287 | + // Total invoices in this period, even if refunded. |
|
| 288 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | + |
|
| 290 | + // Items invoiced in this period, even if refunded. |
|
| 291 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | + |
|
| 293 | + // 3rd party filtering of report data |
|
| 294 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Prepares invoice counts. |
|
| 299 | + * |
|
| 300 | + * @return array. |
|
| 301 | + */ |
|
| 302 | + protected function query_invoice_counts() { |
|
| 303 | + |
|
| 304 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | + array( |
|
| 306 | + 'data' => array( |
|
| 307 | + 'ID' => array( |
|
| 308 | + 'type' => 'post_data', |
|
| 309 | + 'function' => 'COUNT', |
|
| 310 | + 'name' => 'count', |
|
| 311 | + 'distinct' => true, |
|
| 312 | + ), |
|
| 313 | + 'post_date' => array( |
|
| 314 | + 'type' => 'post_data', |
|
| 315 | + 'function' => '', |
|
| 316 | + 'name' => 'post_date', |
|
| 317 | + ), |
|
| 318 | + ), |
|
| 319 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | + 'order_by' => 'post_date ASC', |
|
| 321 | + 'query_type' => 'get_results', |
|
| 322 | + 'filter_range' => $this->report_range, |
|
| 323 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | + ) |
|
| 325 | + ); |
|
| 326 | + |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + /** |
|
| 330 | + * Prepares coupon counts. |
|
| 331 | + * |
|
| 332 | + * @return array. |
|
| 333 | + */ |
|
| 334 | + protected function query_coupon_counts() { |
|
| 335 | + |
|
| 336 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | + array( |
|
| 338 | + 'data' => array( |
|
| 339 | + 'discount' => array( |
|
| 340 | + 'type' => 'invoice_data', |
|
| 341 | + 'function' => 'SUM', |
|
| 342 | + 'name' => 'discount_amount', |
|
| 343 | + ), |
|
| 344 | + 'post_date' => array( |
|
| 345 | + 'type' => 'post_data', |
|
| 346 | + 'function' => '', |
|
| 347 | + 'name' => 'post_date', |
|
| 348 | + ), |
|
| 349 | + ), |
|
| 350 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | + 'order_by' => 'post_date ASC', |
|
| 352 | + 'query_type' => 'get_results', |
|
| 353 | + 'filter_range' => $this->report_range, |
|
| 354 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | + ) |
|
| 356 | + ); |
|
| 357 | + |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Prepares item counts. |
|
| 362 | + * |
|
| 363 | + * @return array. |
|
| 364 | + */ |
|
| 365 | + protected function query_item_counts() { |
|
| 366 | + |
|
| 367 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | + array( |
|
| 369 | + 'data' => array( |
|
| 370 | + 'quantity' => array( |
|
| 371 | + 'type' => 'invoice_item', |
|
| 372 | + 'function' => 'SUM', |
|
| 373 | + 'name' => 'invoice_item_count', |
|
| 374 | + ), |
|
| 375 | + 'post_date' => array( |
|
| 376 | + 'type' => 'post_data', |
|
| 377 | + 'function' => '', |
|
| 378 | + 'name' => 'post_date', |
|
| 379 | + ), |
|
| 380 | + ), |
|
| 381 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | + 'order_by' => 'post_date ASC', |
|
| 383 | + 'query_type' => 'get_results', |
|
| 384 | + 'filter_range' => $this->report_range, |
|
| 385 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | + ) |
|
| 387 | + ); |
|
| 388 | + |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * Prepares refunded item counts. |
|
| 393 | + * |
|
| 394 | + * @return array. |
|
| 395 | + */ |
|
| 396 | + protected function count_refunded_items() { |
|
| 397 | + |
|
| 398 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | + array( |
|
| 400 | + 'data' => array( |
|
| 401 | + 'quantity' => array( |
|
| 402 | + 'type' => 'invoice_item', |
|
| 403 | + 'function' => 'SUM', |
|
| 404 | + 'name' => 'invoice_item_count', |
|
| 405 | + ), |
|
| 406 | + ), |
|
| 407 | + 'query_type' => 'get_var', |
|
| 408 | + 'filter_range' => $this->report_range, |
|
| 409 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | + ) |
|
| 411 | + ); |
|
| 412 | + |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + /** |
|
| 416 | + * Prepares daily invoice totals. |
|
| 417 | + * |
|
| 418 | + * @return array. |
|
| 419 | + */ |
|
| 420 | + protected function query_invoice_totals() { |
|
| 421 | + |
|
| 422 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | + array( |
|
| 424 | + 'data' => array( |
|
| 425 | + 'total' => array( |
|
| 426 | + 'type' => 'invoice_data', |
|
| 427 | + 'function' => 'SUM', |
|
| 428 | + 'name' => 'total_sales', |
|
| 429 | + ), |
|
| 430 | + 'tax' => array( |
|
| 431 | + 'type' => 'invoice_data', |
|
| 432 | + 'function' => 'SUM', |
|
| 433 | + 'name' => 'total_tax', |
|
| 434 | + ), |
|
| 435 | + 'discount' => array( |
|
| 436 | + 'type' => 'invoice_data', |
|
| 437 | + 'function' => 'SUM', |
|
| 438 | + 'name' => 'total_discount', |
|
| 439 | + ), |
|
| 440 | + 'fees_total' => array( |
|
| 441 | + 'type' => 'invoice_data', |
|
| 442 | + 'function' => 'SUM', |
|
| 443 | + 'name' => 'total_fees', |
|
| 444 | + ), |
|
| 445 | + 'subtotal' => array( |
|
| 446 | + 'type' => 'invoice_data', |
|
| 447 | + 'function' => 'SUM', |
|
| 448 | + 'name' => 'subtotal', |
|
| 449 | + ), |
|
| 450 | + 'post_date' => array( |
|
| 451 | + 'type' => 'post_data', |
|
| 452 | + 'function' => '', |
|
| 453 | + 'name' => 'post_date', |
|
| 454 | + ), |
|
| 455 | + ), |
|
| 456 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | + 'order_by' => 'post_date ASC', |
|
| 458 | + 'query_type' => 'get_results', |
|
| 459 | + 'filter_range' => $this->report_range, |
|
| 460 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | + ) |
|
| 462 | + ); |
|
| 463 | + |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Prepares daily invoice totals. |
|
| 468 | + * |
|
| 469 | + * @return array. |
|
| 470 | + */ |
|
| 471 | + protected function query_refunded_totals() { |
|
| 472 | + |
|
| 473 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | + array( |
|
| 475 | + 'data' => array( |
|
| 476 | + 'total' => array( |
|
| 477 | + 'type' => 'invoice_data', |
|
| 478 | + 'function' => 'SUM', |
|
| 479 | + 'name' => 'total_sales', |
|
| 480 | + ), |
|
| 481 | + 'tax' => array( |
|
| 482 | + 'type' => 'invoice_data', |
|
| 483 | + 'function' => 'SUM', |
|
| 484 | + 'name' => 'total_tax', |
|
| 485 | + ), |
|
| 486 | + 'discount' => array( |
|
| 487 | + 'type' => 'invoice_data', |
|
| 488 | + 'function' => 'SUM', |
|
| 489 | + 'name' => 'total_discount', |
|
| 490 | + ), |
|
| 491 | + 'fees_total' => array( |
|
| 492 | + 'type' => 'invoice_data', |
|
| 493 | + 'function' => 'SUM', |
|
| 494 | + 'name' => 'total_fees', |
|
| 495 | + ), |
|
| 496 | + 'subtotal' => array( |
|
| 497 | + 'type' => 'invoice_data', |
|
| 498 | + 'function' => 'SUM', |
|
| 499 | + 'name' => 'subtotal', |
|
| 500 | + ), |
|
| 501 | + 'post_date' => array( |
|
| 502 | + 'type' => 'post_data', |
|
| 503 | + 'function' => '', |
|
| 504 | + 'name' => 'post_date', |
|
| 505 | + ), |
|
| 506 | + ), |
|
| 507 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | + 'order_by' => 'post_date ASC', |
|
| 509 | + 'query_type' => 'get_results', |
|
| 510 | + 'filter_range' => $this->report_range, |
|
| 511 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | + ) |
|
| 513 | + ); |
|
| 514 | + |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | + * |
|
| 520 | + * @return array |
|
| 521 | + */ |
|
| 522 | + public function get_item_schema() { |
|
| 523 | + |
|
| 524 | + $schema = array( |
|
| 525 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | + 'title' => 'sales_report', |
|
| 527 | + 'type' => 'object', |
|
| 528 | + 'properties' => array( |
|
| 529 | + 'total_sales' => array( |
|
| 530 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | + 'type' => 'string', |
|
| 532 | + 'context' => array( 'view' ), |
|
| 533 | + 'readonly' => true, |
|
| 534 | + ), |
|
| 535 | + 'net_sales' => array( |
|
| 536 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | + 'type' => 'string', |
|
| 538 | + 'context' => array( 'view' ), |
|
| 539 | + 'readonly' => true, |
|
| 540 | + ), |
|
| 541 | + 'average_sales' => array( |
|
| 542 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | + 'type' => 'string', |
|
| 544 | + 'context' => array( 'view' ), |
|
| 545 | + 'readonly' => true, |
|
| 546 | + ), |
|
| 547 | + 'average_total_sales' => array( |
|
| 548 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | + 'type' => 'string', |
|
| 550 | + 'context' => array( 'view' ), |
|
| 551 | + 'readonly' => true, |
|
| 552 | + ), |
|
| 553 | + 'total_invoices' => array( |
|
| 554 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | + 'type' => 'integer', |
|
| 556 | + 'context' => array( 'view' ), |
|
| 557 | + 'readonly' => true, |
|
| 558 | + ), |
|
| 559 | + 'total_items' => array( |
|
| 560 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | + 'type' => 'integer', |
|
| 562 | + 'context' => array( 'view' ), |
|
| 563 | + 'readonly' => true, |
|
| 564 | + ), |
|
| 565 | + 'refunded_items' => array( |
|
| 566 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | + 'type' => 'integer', |
|
| 568 | + 'context' => array( 'view' ), |
|
| 569 | + 'readonly' => true, |
|
| 570 | + ), |
|
| 571 | + 'total_tax' => array( |
|
| 572 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | + 'type' => 'string', |
|
| 574 | + 'context' => array( 'view' ), |
|
| 575 | + 'readonly' => true, |
|
| 576 | + ), |
|
| 577 | + 'total_refunded_tax' => array( |
|
| 578 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | + 'type' => 'string', |
|
| 580 | + 'context' => array( 'view' ), |
|
| 581 | + 'readonly' => true, |
|
| 582 | + ), |
|
| 583 | + 'total_fees' => array( |
|
| 584 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | + 'type' => 'string', |
|
| 586 | + 'context' => array( 'view' ), |
|
| 587 | + 'readonly' => true, |
|
| 588 | + ), |
|
| 589 | + 'total_refunds' => array( |
|
| 590 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | + 'type' => 'integer', |
|
| 592 | + 'context' => array( 'view' ), |
|
| 593 | + 'readonly' => true, |
|
| 594 | + ), |
|
| 595 | + 'net_refunds' => array( |
|
| 596 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | + 'type' => 'integer', |
|
| 598 | + 'context' => array( 'view' ), |
|
| 599 | + 'readonly' => true, |
|
| 600 | + ), |
|
| 601 | + 'total_discount' => array( |
|
| 602 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | + 'type' => 'integer', |
|
| 604 | + 'context' => array( 'view' ), |
|
| 605 | + 'readonly' => true, |
|
| 606 | + ), |
|
| 607 | + 'totals' => array( |
|
| 608 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | + 'type' => 'array', |
|
| 610 | + 'items' => array( |
|
| 611 | + 'type' => 'array', |
|
| 612 | + ), |
|
| 613 | + 'context' => array( 'view' ), |
|
| 614 | + 'readonly' => true, |
|
| 615 | + ), |
|
| 616 | + 'interval' => array( |
|
| 617 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | + 'type' => 'integer', |
|
| 619 | + 'context' => array( 'view' ), |
|
| 620 | + 'readonly' => true, |
|
| 621 | + ), |
|
| 622 | + 'previous_range' => array( |
|
| 623 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | + 'type' => 'array', |
|
| 625 | + 'items' => array( |
|
| 626 | + 'type' => 'string', |
|
| 627 | + ), |
|
| 628 | + 'context' => array( 'view' ), |
|
| 629 | + 'readonly' => true, |
|
| 630 | + ), |
|
| 631 | + 'grouped_by' => array( |
|
| 632 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | + 'type' => 'string', |
|
| 634 | + 'context' => array( 'view' ), |
|
| 635 | + 'enum' => array( 'day', 'month' ), |
|
| 636 | + 'readonly' => true, |
|
| 637 | + ), |
|
| 638 | + 'currency' => array( |
|
| 639 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | + 'type' => 'string', |
|
| 641 | + 'context' => array( 'view' ), |
|
| 642 | + 'readonly' => true, |
|
| 643 | + ), |
|
| 644 | + 'currency_symbol' => array( |
|
| 645 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | + 'type' => 'string', |
|
| 647 | + 'context' => array( 'view' ), |
|
| 648 | + 'readonly' => true, |
|
| 649 | + ), |
|
| 650 | + 'currency_position' => array( |
|
| 651 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | + 'type' => 'string', |
|
| 653 | + 'context' => array( 'view' ), |
|
| 654 | + 'readonly' => true, |
|
| 655 | + ), |
|
| 656 | + 'decimal_places' => array( |
|
| 657 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | + 'type' => 'string', |
|
| 659 | + 'context' => array( 'view' ), |
|
| 660 | + 'readonly' => true, |
|
| 661 | + ), |
|
| 662 | + 'thousands_sep' => array( |
|
| 663 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | + 'type' => 'string', |
|
| 665 | + 'context' => array( 'view' ), |
|
| 666 | + 'readonly' => true, |
|
| 667 | + ), |
|
| 668 | + 'decimals_sep' => array( |
|
| 669 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | + 'type' => 'string', |
|
| 671 | + 'context' => array( 'view' ), |
|
| 672 | + 'readonly' => true, |
|
| 673 | + ), |
|
| 674 | + ), |
|
| 675 | + ); |
|
| 676 | + |
|
| 677 | + return $this->add_additional_fields_schema( $schema ); |
|
| 678 | + |
|
| 679 | + } |
|
| 680 | 680 | |
| 681 | 681 | } |
@@ -16,577 +16,577 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Group response items by day or month. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - public $groupby = 'day'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Returns an array with arguments to request the previous report. |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - public $previous_range = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * The period interval. |
|
| 35 | - * |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 38 | - public $interval; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Retrieves the before and after dates. |
|
| 42 | - * |
|
| 43 | - * @param WP_REST_Request $request Request object. |
|
| 44 | - * @return array The appropriate date range. |
|
| 45 | - */ |
|
| 46 | - public function get_date_range( $request ) { |
|
| 47 | - |
|
| 48 | - // If not supported, assume all time. |
|
| 49 | - if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | - $request['period'] = '7_days'; |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | - $this->prepare_interval( $date_range ); |
|
| 55 | - |
|
| 56 | - return $date_range; |
|
| 57 | - |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Groups by month or days. |
|
| 62 | - * |
|
| 63 | - * @param array $range Date range. |
|
| 64 | - * @return array The appropriate date range. |
|
| 65 | - */ |
|
| 66 | - public function prepare_interval( $range ) { |
|
| 67 | - |
|
| 68 | - $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | - $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | - if ( 'day' === $this->groupby ) { |
|
| 71 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | - return; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $this->interval = 0; |
|
| 77 | - $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | - |
|
| 79 | - while ( $min_date <= $before ) { |
|
| 80 | - $this->interval ++; |
|
| 81 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - $this->interval = max( 1, $this->interval ); |
|
| 85 | - |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Retrieves a custom date range. |
|
| 90 | - * |
|
| 91 | - * @param WP_REST_Request $request Request object. |
|
| 92 | - * @return array The appropriate date range. |
|
| 93 | - */ |
|
| 94 | - public function get_custom_date_range( $request ) { |
|
| 95 | - |
|
| 96 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | - $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | - |
|
| 99 | - if ( ! empty( $request['before'] ) ) { |
|
| 100 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - // 3 months max for day view |
|
| 104 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | - $this->groupby = 'month'; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - // Set the previous date range. |
|
| 109 | - $difference = $before - $after; |
|
| 110 | - $this->previous_range = array( |
|
| 111 | - 'period' => 'custom', |
|
| 112 | - 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | - 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | - ); |
|
| 115 | - |
|
| 116 | - // Generate the report. |
|
| 117 | - return array( |
|
| 118 | - 'before' => date( 'Y-m-d', $before ), |
|
| 119 | - 'after' => date( 'Y-m-d', $after ), |
|
| 120 | - ); |
|
| 121 | - |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Retrieves todays date range. |
|
| 126 | - * |
|
| 127 | - * @return array The appropriate date range. |
|
| 128 | - */ |
|
| 129 | - public function get_today_date_range() { |
|
| 130 | - |
|
| 131 | - // Set the previous date range. |
|
| 132 | - $this->previous_range = array( |
|
| 133 | - 'period' => 'yesterday', |
|
| 134 | - ); |
|
| 135 | - |
|
| 136 | - // Generate the report. |
|
| 137 | - return array( |
|
| 138 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | - 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | - ); |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Retrieves yesterdays date range. |
|
| 146 | - * |
|
| 147 | - * @return array The appropriate date range. |
|
| 148 | - */ |
|
| 149 | - public function get_yesterday_date_range() { |
|
| 150 | - |
|
| 151 | - // Set the previous date range. |
|
| 152 | - $this->previous_range = array( |
|
| 153 | - 'period' => 'custom', |
|
| 154 | - 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | - 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | - ); |
|
| 157 | - |
|
| 158 | - // Generate the report. |
|
| 159 | - return array( |
|
| 160 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | - 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | - ); |
|
| 163 | - |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Retrieves this week's date range. |
|
| 168 | - * |
|
| 169 | - * @return array The appropriate date range. |
|
| 170 | - */ |
|
| 171 | - public function get_week_date_range() { |
|
| 172 | - |
|
| 173 | - // Set the previous date range. |
|
| 174 | - $this->previous_range = array( |
|
| 175 | - 'period' => 'last_week', |
|
| 176 | - ); |
|
| 177 | - |
|
| 178 | - // Generate the report. |
|
| 179 | - return array( |
|
| 180 | - 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | - ); |
|
| 183 | - |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * Retrieves last week's date range. |
|
| 188 | - * |
|
| 189 | - * @return array The appropriate date range. |
|
| 190 | - */ |
|
| 191 | - public function get_last_week_date_range() { |
|
| 192 | - |
|
| 193 | - // Set the previous date range. |
|
| 194 | - $this->previous_range = array( |
|
| 195 | - 'period' => 'custom', |
|
| 196 | - 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | - ); |
|
| 199 | - |
|
| 200 | - // Generate the report. |
|
| 201 | - return array( |
|
| 202 | - 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | - ); |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Retrieves last 7 days date range. |
|
| 210 | - * |
|
| 211 | - * @return array The appropriate date range. |
|
| 212 | - */ |
|
| 213 | - public function get_7_days_date_range() { |
|
| 214 | - |
|
| 215 | - // Set the previous date range. |
|
| 216 | - $this->previous_range = array( |
|
| 217 | - 'period' => 'custom', |
|
| 218 | - 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | - 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | - ); |
|
| 221 | - |
|
| 222 | - // Generate the report. |
|
| 223 | - return array( |
|
| 224 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | - 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | - ); |
|
| 227 | - |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - /** |
|
| 231 | - * Retrieves last 30 days date range. |
|
| 232 | - * |
|
| 233 | - * @return array The appropriate date range. |
|
| 234 | - */ |
|
| 235 | - public function get_30_days_date_range() { |
|
| 236 | - |
|
| 237 | - // Set the previous date range. |
|
| 238 | - $this->previous_range = array( |
|
| 239 | - 'period' => 'custom', |
|
| 240 | - 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | - ); |
|
| 243 | - |
|
| 244 | - // Generate the report. |
|
| 245 | - return array( |
|
| 246 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | - 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | - ); |
|
| 249 | - |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Retrieves last 90 days date range. |
|
| 254 | - * |
|
| 255 | - * @return array The appropriate date range. |
|
| 256 | - */ |
|
| 257 | - public function get_90_days_date_range() { |
|
| 258 | - |
|
| 259 | - $this->groupby = 'month'; |
|
| 260 | - |
|
| 261 | - // Set the previous date range. |
|
| 262 | - $this->previous_range = array( |
|
| 263 | - 'period' => 'custom', |
|
| 264 | - 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Generate the report. |
|
| 269 | - return array( |
|
| 270 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | - 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | - ); |
|
| 273 | - |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Retrieves last 180 days date range. |
|
| 278 | - * |
|
| 279 | - * @return array The appropriate date range. |
|
| 280 | - */ |
|
| 281 | - public function get_180_days_date_range() { |
|
| 282 | - |
|
| 283 | - $this->groupby = 'month'; |
|
| 284 | - |
|
| 285 | - // Set the previous date range. |
|
| 286 | - $this->previous_range = array( |
|
| 287 | - 'period' => 'custom', |
|
| 288 | - 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | - 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | - ); |
|
| 291 | - |
|
| 292 | - // Generate the report. |
|
| 293 | - return array( |
|
| 294 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | - ); |
|
| 297 | - |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Retrieves last 60 days date range. |
|
| 302 | - * |
|
| 303 | - * @return array The appropriate date range. |
|
| 304 | - */ |
|
| 305 | - public function get_60_days_date_range() { |
|
| 306 | - |
|
| 307 | - // Set the previous date range. |
|
| 308 | - $this->previous_range = array( |
|
| 309 | - 'period' => 'custom', |
|
| 310 | - 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | - 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | - ); |
|
| 313 | - |
|
| 314 | - // Generate the report. |
|
| 315 | - return array( |
|
| 316 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | - ); |
|
| 319 | - |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Retrieves this month date range. |
|
| 324 | - * |
|
| 325 | - * @return array The appropriate date range. |
|
| 326 | - */ |
|
| 327 | - public function get_month_date_range() { |
|
| 328 | - |
|
| 329 | - // Set the previous date range. |
|
| 330 | - $this->previous_range = array( |
|
| 331 | - 'period' => 'last_month', |
|
| 332 | - ); |
|
| 333 | - |
|
| 334 | - // Generate the report. |
|
| 335 | - return array( |
|
| 336 | - 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | - ); |
|
| 339 | - |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * Retrieves last month's date range. |
|
| 344 | - * |
|
| 345 | - * @return array The appropriate date range. |
|
| 346 | - */ |
|
| 347 | - public function get_last_month_date_range() { |
|
| 348 | - |
|
| 349 | - // Set the previous date range. |
|
| 350 | - $this->previous_range = array( |
|
| 351 | - 'period' => 'custom', |
|
| 352 | - 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | - 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | - ); |
|
| 355 | - |
|
| 356 | - // Generate the report. |
|
| 357 | - return array( |
|
| 358 | - 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | - 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | - ); |
|
| 361 | - |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Retrieves this quarter date range. |
|
| 366 | - * |
|
| 367 | - * @return array The available quarters. |
|
| 368 | - */ |
|
| 369 | - public function get_quarters() { |
|
| 370 | - |
|
| 371 | - $last_year = (int) date('Y') - 1; |
|
| 372 | - $next_year = (int) date('Y') + 1; |
|
| 373 | - $year = (int) date('Y'); |
|
| 374 | - return array( |
|
| 375 | - |
|
| 376 | - array( |
|
| 377 | - 'after' => "$last_year-06-30", |
|
| 378 | - 'before' => "$last_year-10-01", |
|
| 379 | - ), |
|
| 380 | - |
|
| 381 | - array( |
|
| 382 | - 'before' => "$year-01-01", |
|
| 383 | - 'after' => "$last_year-09-30", |
|
| 384 | - ), |
|
| 385 | - |
|
| 386 | - array( |
|
| 387 | - 'before' => "$year-04-01", |
|
| 388 | - 'after' => "$last_year-12-31", |
|
| 389 | - ), |
|
| 390 | - |
|
| 391 | - array( |
|
| 392 | - 'before' => "$year-07-01", |
|
| 393 | - 'after' => "$year-03-31", |
|
| 394 | - ), |
|
| 395 | - |
|
| 396 | - array( |
|
| 397 | - 'after' => "$year-06-30", |
|
| 398 | - 'before' => "$year-10-01", |
|
| 399 | - ), |
|
| 400 | - |
|
| 401 | - array( |
|
| 402 | - 'before' => "$next_year-01-01", |
|
| 403 | - 'after' => "$year-09-30", |
|
| 404 | - ) |
|
| 405 | - |
|
| 406 | - ); |
|
| 407 | - |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Retrieves the current quater. |
|
| 412 | - * |
|
| 413 | - * @return int The current quarter. |
|
| 414 | - */ |
|
| 415 | - public function get_quarter() { |
|
| 416 | - |
|
| 417 | - $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | - return $quarters[ $month - 1 ]; |
|
| 420 | - |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Retrieves this quarter date range. |
|
| 425 | - * |
|
| 426 | - * @return array The appropriate date range. |
|
| 427 | - */ |
|
| 428 | - public function get_quarter_date_range() { |
|
| 429 | - |
|
| 430 | - // Set the previous date range. |
|
| 431 | - $this->previous_range = array( |
|
| 432 | - 'period' => 'last_quarter', |
|
| 433 | - ); |
|
| 434 | - |
|
| 435 | - // Generate the report. |
|
| 436 | - $quarters = $this->get_quarters(); |
|
| 437 | - return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | - |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - /** |
|
| 442 | - * Retrieves last quarter's date range. |
|
| 443 | - * |
|
| 444 | - * @return array The appropriate date range. |
|
| 445 | - */ |
|
| 446 | - public function get_last_quarter_date_range() { |
|
| 447 | - |
|
| 448 | - $quarters = $this->get_quarters(); |
|
| 449 | - $quarter = $this->get_quarter(); |
|
| 450 | - |
|
| 451 | - // Set the previous date range. |
|
| 452 | - $this->previous_range = array_merge( |
|
| 453 | - $quarters[ $quarter - 1 ], |
|
| 454 | - array( 'period' => 'custom' ) |
|
| 455 | - ); |
|
| 456 | - |
|
| 457 | - // Generate the report. |
|
| 458 | - return $quarters[ $quarter ]; |
|
| 459 | - |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - /** |
|
| 463 | - * Retrieves this year date range. |
|
| 464 | - * |
|
| 465 | - * @return array The appropriate date range. |
|
| 466 | - */ |
|
| 467 | - public function get_year_date_range() { |
|
| 468 | - |
|
| 469 | - $this->groupby = 'month'; |
|
| 470 | - |
|
| 471 | - // Set the previous date range. |
|
| 472 | - $this->previous_range = array( |
|
| 473 | - 'period' => 'last_year', |
|
| 474 | - ); |
|
| 475 | - |
|
| 476 | - // Generate the report. |
|
| 477 | - return array( |
|
| 478 | - 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | - ); |
|
| 481 | - |
|
| 482 | - } |
|
| 483 | - |
|
| 484 | - /** |
|
| 485 | - * Retrieves last year date range. |
|
| 486 | - * |
|
| 487 | - * @return array The appropriate date range. |
|
| 488 | - */ |
|
| 489 | - public function get_last_year_date_range() { |
|
| 490 | - |
|
| 491 | - $this->groupby = 'month'; |
|
| 492 | - |
|
| 493 | - // Set the previous date range. |
|
| 494 | - $year = (int) date('Y') - 3; |
|
| 495 | - $this->previous_range = array( |
|
| 496 | - 'period' => 'custom', |
|
| 497 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | - 'after' => "$year-12-31", |
|
| 499 | - ); |
|
| 500 | - |
|
| 501 | - // Generate the report. |
|
| 502 | - $year = (int) date('Y') - 2; |
|
| 503 | - return array( |
|
| 504 | - 'after' => "$year-12-31", |
|
| 505 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | - ); |
|
| 507 | - |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - /** |
|
| 511 | - * Prepare a the request date for SQL usage. |
|
| 512 | - * |
|
| 513 | - * @param WP_REST_Request $request Request object. |
|
| 514 | - * @param string $date_field The date field. |
|
| 515 | - * @return string The appropriate SQL. |
|
| 516 | - */ |
|
| 517 | - public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | - global $wpdb; |
|
| 519 | - |
|
| 520 | - $sql = '1=1'; |
|
| 521 | - $range = $this->get_date_range( $request ); |
|
| 522 | - |
|
| 523 | - if ( ! empty( $range['after'] ) ) { |
|
| 524 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | - "$date_field > %s", |
|
| 526 | - $range['after'] |
|
| 527 | - ); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - if ( ! empty( $range['before'] ) ) { |
|
| 531 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | - "$date_field < %s", |
|
| 533 | - $range['before'] |
|
| 534 | - ); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - return $sql; |
|
| 538 | - |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * Prepares a group by query. |
|
| 543 | - * |
|
| 544 | - * @param string $date_field The date field. |
|
| 545 | - * @return string The appropriate SQL. |
|
| 546 | - */ |
|
| 547 | - public function get_group_by_sql( $date_field ) { |
|
| 548 | - |
|
| 549 | - if ( 'day' === $this->groupby ) { |
|
| 550 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Get the query params for collections. |
|
| 558 | - * |
|
| 559 | - * @return array |
|
| 560 | - */ |
|
| 561 | - public function get_collection_params() { |
|
| 562 | - return array( |
|
| 563 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | - 'period' => array( |
|
| 565 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | - 'type' => 'string', |
|
| 567 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | - 'default' => '7_days', |
|
| 571 | - ), |
|
| 572 | - 'after' => array( |
|
| 573 | - /* translators: %s: date format */ |
|
| 574 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | - 'type' => 'string', |
|
| 576 | - 'format' => 'date', |
|
| 577 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | - ), |
|
| 581 | - 'before' => array( |
|
| 582 | - /* translators: %s: date format */ |
|
| 583 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | - 'type' => 'string', |
|
| 585 | - 'format' => 'date', |
|
| 586 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | - ), |
|
| 590 | - ); |
|
| 591 | - } |
|
| 19 | + /** |
|
| 20 | + * Group response items by day or month. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + public $groupby = 'day'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Returns an array with arguments to request the previous report. |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + public $previous_range = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * The period interval. |
|
| 35 | + * |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | + public $interval; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Retrieves the before and after dates. |
|
| 42 | + * |
|
| 43 | + * @param WP_REST_Request $request Request object. |
|
| 44 | + * @return array The appropriate date range. |
|
| 45 | + */ |
|
| 46 | + public function get_date_range( $request ) { |
|
| 47 | + |
|
| 48 | + // If not supported, assume all time. |
|
| 49 | + if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | + $request['period'] = '7_days'; |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | + $this->prepare_interval( $date_range ); |
|
| 55 | + |
|
| 56 | + return $date_range; |
|
| 57 | + |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Groups by month or days. |
|
| 62 | + * |
|
| 63 | + * @param array $range Date range. |
|
| 64 | + * @return array The appropriate date range. |
|
| 65 | + */ |
|
| 66 | + public function prepare_interval( $range ) { |
|
| 67 | + |
|
| 68 | + $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | + $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | + if ( 'day' === $this->groupby ) { |
|
| 71 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | + return; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $this->interval = 0; |
|
| 77 | + $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | + |
|
| 79 | + while ( $min_date <= $before ) { |
|
| 80 | + $this->interval ++; |
|
| 81 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + $this->interval = max( 1, $this->interval ); |
|
| 85 | + |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Retrieves a custom date range. |
|
| 90 | + * |
|
| 91 | + * @param WP_REST_Request $request Request object. |
|
| 92 | + * @return array The appropriate date range. |
|
| 93 | + */ |
|
| 94 | + public function get_custom_date_range( $request ) { |
|
| 95 | + |
|
| 96 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | + $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | + |
|
| 99 | + if ( ! empty( $request['before'] ) ) { |
|
| 100 | + $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + // 3 months max for day view |
|
| 104 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | + $this->groupby = 'month'; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + // Set the previous date range. |
|
| 109 | + $difference = $before - $after; |
|
| 110 | + $this->previous_range = array( |
|
| 111 | + 'period' => 'custom', |
|
| 112 | + 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | + 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | + ); |
|
| 115 | + |
|
| 116 | + // Generate the report. |
|
| 117 | + return array( |
|
| 118 | + 'before' => date( 'Y-m-d', $before ), |
|
| 119 | + 'after' => date( 'Y-m-d', $after ), |
|
| 120 | + ); |
|
| 121 | + |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Retrieves todays date range. |
|
| 126 | + * |
|
| 127 | + * @return array The appropriate date range. |
|
| 128 | + */ |
|
| 129 | + public function get_today_date_range() { |
|
| 130 | + |
|
| 131 | + // Set the previous date range. |
|
| 132 | + $this->previous_range = array( |
|
| 133 | + 'period' => 'yesterday', |
|
| 134 | + ); |
|
| 135 | + |
|
| 136 | + // Generate the report. |
|
| 137 | + return array( |
|
| 138 | + 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | + 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | + ); |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Retrieves yesterdays date range. |
|
| 146 | + * |
|
| 147 | + * @return array The appropriate date range. |
|
| 148 | + */ |
|
| 149 | + public function get_yesterday_date_range() { |
|
| 150 | + |
|
| 151 | + // Set the previous date range. |
|
| 152 | + $this->previous_range = array( |
|
| 153 | + 'period' => 'custom', |
|
| 154 | + 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | + 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | + ); |
|
| 157 | + |
|
| 158 | + // Generate the report. |
|
| 159 | + return array( |
|
| 160 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | + 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | + ); |
|
| 163 | + |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Retrieves this week's date range. |
|
| 168 | + * |
|
| 169 | + * @return array The appropriate date range. |
|
| 170 | + */ |
|
| 171 | + public function get_week_date_range() { |
|
| 172 | + |
|
| 173 | + // Set the previous date range. |
|
| 174 | + $this->previous_range = array( |
|
| 175 | + 'period' => 'last_week', |
|
| 176 | + ); |
|
| 177 | + |
|
| 178 | + // Generate the report. |
|
| 179 | + return array( |
|
| 180 | + 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | + 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | + ); |
|
| 183 | + |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * Retrieves last week's date range. |
|
| 188 | + * |
|
| 189 | + * @return array The appropriate date range. |
|
| 190 | + */ |
|
| 191 | + public function get_last_week_date_range() { |
|
| 192 | + |
|
| 193 | + // Set the previous date range. |
|
| 194 | + $this->previous_range = array( |
|
| 195 | + 'period' => 'custom', |
|
| 196 | + 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | + ); |
|
| 199 | + |
|
| 200 | + // Generate the report. |
|
| 201 | + return array( |
|
| 202 | + 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | + ); |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Retrieves last 7 days date range. |
|
| 210 | + * |
|
| 211 | + * @return array The appropriate date range. |
|
| 212 | + */ |
|
| 213 | + public function get_7_days_date_range() { |
|
| 214 | + |
|
| 215 | + // Set the previous date range. |
|
| 216 | + $this->previous_range = array( |
|
| 217 | + 'period' => 'custom', |
|
| 218 | + 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | + 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | + ); |
|
| 221 | + |
|
| 222 | + // Generate the report. |
|
| 223 | + return array( |
|
| 224 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | + 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | + ); |
|
| 227 | + |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * Retrieves last 30 days date range. |
|
| 232 | + * |
|
| 233 | + * @return array The appropriate date range. |
|
| 234 | + */ |
|
| 235 | + public function get_30_days_date_range() { |
|
| 236 | + |
|
| 237 | + // Set the previous date range. |
|
| 238 | + $this->previous_range = array( |
|
| 239 | + 'period' => 'custom', |
|
| 240 | + 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | + ); |
|
| 243 | + |
|
| 244 | + // Generate the report. |
|
| 245 | + return array( |
|
| 246 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | + 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | + ); |
|
| 249 | + |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Retrieves last 90 days date range. |
|
| 254 | + * |
|
| 255 | + * @return array The appropriate date range. |
|
| 256 | + */ |
|
| 257 | + public function get_90_days_date_range() { |
|
| 258 | + |
|
| 259 | + $this->groupby = 'month'; |
|
| 260 | + |
|
| 261 | + // Set the previous date range. |
|
| 262 | + $this->previous_range = array( |
|
| 263 | + 'period' => 'custom', |
|
| 264 | + 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Generate the report. |
|
| 269 | + return array( |
|
| 270 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | + 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | + ); |
|
| 273 | + |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Retrieves last 180 days date range. |
|
| 278 | + * |
|
| 279 | + * @return array The appropriate date range. |
|
| 280 | + */ |
|
| 281 | + public function get_180_days_date_range() { |
|
| 282 | + |
|
| 283 | + $this->groupby = 'month'; |
|
| 284 | + |
|
| 285 | + // Set the previous date range. |
|
| 286 | + $this->previous_range = array( |
|
| 287 | + 'period' => 'custom', |
|
| 288 | + 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | + 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | + ); |
|
| 291 | + |
|
| 292 | + // Generate the report. |
|
| 293 | + return array( |
|
| 294 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | + ); |
|
| 297 | + |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Retrieves last 60 days date range. |
|
| 302 | + * |
|
| 303 | + * @return array The appropriate date range. |
|
| 304 | + */ |
|
| 305 | + public function get_60_days_date_range() { |
|
| 306 | + |
|
| 307 | + // Set the previous date range. |
|
| 308 | + $this->previous_range = array( |
|
| 309 | + 'period' => 'custom', |
|
| 310 | + 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | + 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | + ); |
|
| 313 | + |
|
| 314 | + // Generate the report. |
|
| 315 | + return array( |
|
| 316 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | + ); |
|
| 319 | + |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Retrieves this month date range. |
|
| 324 | + * |
|
| 325 | + * @return array The appropriate date range. |
|
| 326 | + */ |
|
| 327 | + public function get_month_date_range() { |
|
| 328 | + |
|
| 329 | + // Set the previous date range. |
|
| 330 | + $this->previous_range = array( |
|
| 331 | + 'period' => 'last_month', |
|
| 332 | + ); |
|
| 333 | + |
|
| 334 | + // Generate the report. |
|
| 335 | + return array( |
|
| 336 | + 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | + 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | + ); |
|
| 339 | + |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * Retrieves last month's date range. |
|
| 344 | + * |
|
| 345 | + * @return array The appropriate date range. |
|
| 346 | + */ |
|
| 347 | + public function get_last_month_date_range() { |
|
| 348 | + |
|
| 349 | + // Set the previous date range. |
|
| 350 | + $this->previous_range = array( |
|
| 351 | + 'period' => 'custom', |
|
| 352 | + 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | + 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | + ); |
|
| 355 | + |
|
| 356 | + // Generate the report. |
|
| 357 | + return array( |
|
| 358 | + 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | + 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | + ); |
|
| 361 | + |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Retrieves this quarter date range. |
|
| 366 | + * |
|
| 367 | + * @return array The available quarters. |
|
| 368 | + */ |
|
| 369 | + public function get_quarters() { |
|
| 370 | + |
|
| 371 | + $last_year = (int) date('Y') - 1; |
|
| 372 | + $next_year = (int) date('Y') + 1; |
|
| 373 | + $year = (int) date('Y'); |
|
| 374 | + return array( |
|
| 375 | + |
|
| 376 | + array( |
|
| 377 | + 'after' => "$last_year-06-30", |
|
| 378 | + 'before' => "$last_year-10-01", |
|
| 379 | + ), |
|
| 380 | + |
|
| 381 | + array( |
|
| 382 | + 'before' => "$year-01-01", |
|
| 383 | + 'after' => "$last_year-09-30", |
|
| 384 | + ), |
|
| 385 | + |
|
| 386 | + array( |
|
| 387 | + 'before' => "$year-04-01", |
|
| 388 | + 'after' => "$last_year-12-31", |
|
| 389 | + ), |
|
| 390 | + |
|
| 391 | + array( |
|
| 392 | + 'before' => "$year-07-01", |
|
| 393 | + 'after' => "$year-03-31", |
|
| 394 | + ), |
|
| 395 | + |
|
| 396 | + array( |
|
| 397 | + 'after' => "$year-06-30", |
|
| 398 | + 'before' => "$year-10-01", |
|
| 399 | + ), |
|
| 400 | + |
|
| 401 | + array( |
|
| 402 | + 'before' => "$next_year-01-01", |
|
| 403 | + 'after' => "$year-09-30", |
|
| 404 | + ) |
|
| 405 | + |
|
| 406 | + ); |
|
| 407 | + |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Retrieves the current quater. |
|
| 412 | + * |
|
| 413 | + * @return int The current quarter. |
|
| 414 | + */ |
|
| 415 | + public function get_quarter() { |
|
| 416 | + |
|
| 417 | + $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | + return $quarters[ $month - 1 ]; |
|
| 420 | + |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Retrieves this quarter date range. |
|
| 425 | + * |
|
| 426 | + * @return array The appropriate date range. |
|
| 427 | + */ |
|
| 428 | + public function get_quarter_date_range() { |
|
| 429 | + |
|
| 430 | + // Set the previous date range. |
|
| 431 | + $this->previous_range = array( |
|
| 432 | + 'period' => 'last_quarter', |
|
| 433 | + ); |
|
| 434 | + |
|
| 435 | + // Generate the report. |
|
| 436 | + $quarters = $this->get_quarters(); |
|
| 437 | + return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | + |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + /** |
|
| 442 | + * Retrieves last quarter's date range. |
|
| 443 | + * |
|
| 444 | + * @return array The appropriate date range. |
|
| 445 | + */ |
|
| 446 | + public function get_last_quarter_date_range() { |
|
| 447 | + |
|
| 448 | + $quarters = $this->get_quarters(); |
|
| 449 | + $quarter = $this->get_quarter(); |
|
| 450 | + |
|
| 451 | + // Set the previous date range. |
|
| 452 | + $this->previous_range = array_merge( |
|
| 453 | + $quarters[ $quarter - 1 ], |
|
| 454 | + array( 'period' => 'custom' ) |
|
| 455 | + ); |
|
| 456 | + |
|
| 457 | + // Generate the report. |
|
| 458 | + return $quarters[ $quarter ]; |
|
| 459 | + |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + /** |
|
| 463 | + * Retrieves this year date range. |
|
| 464 | + * |
|
| 465 | + * @return array The appropriate date range. |
|
| 466 | + */ |
|
| 467 | + public function get_year_date_range() { |
|
| 468 | + |
|
| 469 | + $this->groupby = 'month'; |
|
| 470 | + |
|
| 471 | + // Set the previous date range. |
|
| 472 | + $this->previous_range = array( |
|
| 473 | + 'period' => 'last_year', |
|
| 474 | + ); |
|
| 475 | + |
|
| 476 | + // Generate the report. |
|
| 477 | + return array( |
|
| 478 | + 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | + 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | + ); |
|
| 481 | + |
|
| 482 | + } |
|
| 483 | + |
|
| 484 | + /** |
|
| 485 | + * Retrieves last year date range. |
|
| 486 | + * |
|
| 487 | + * @return array The appropriate date range. |
|
| 488 | + */ |
|
| 489 | + public function get_last_year_date_range() { |
|
| 490 | + |
|
| 491 | + $this->groupby = 'month'; |
|
| 492 | + |
|
| 493 | + // Set the previous date range. |
|
| 494 | + $year = (int) date('Y') - 3; |
|
| 495 | + $this->previous_range = array( |
|
| 496 | + 'period' => 'custom', |
|
| 497 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | + 'after' => "$year-12-31", |
|
| 499 | + ); |
|
| 500 | + |
|
| 501 | + // Generate the report. |
|
| 502 | + $year = (int) date('Y') - 2; |
|
| 503 | + return array( |
|
| 504 | + 'after' => "$year-12-31", |
|
| 505 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | + ); |
|
| 507 | + |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + /** |
|
| 511 | + * Prepare a the request date for SQL usage. |
|
| 512 | + * |
|
| 513 | + * @param WP_REST_Request $request Request object. |
|
| 514 | + * @param string $date_field The date field. |
|
| 515 | + * @return string The appropriate SQL. |
|
| 516 | + */ |
|
| 517 | + public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | + global $wpdb; |
|
| 519 | + |
|
| 520 | + $sql = '1=1'; |
|
| 521 | + $range = $this->get_date_range( $request ); |
|
| 522 | + |
|
| 523 | + if ( ! empty( $range['after'] ) ) { |
|
| 524 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | + "$date_field > %s", |
|
| 526 | + $range['after'] |
|
| 527 | + ); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + if ( ! empty( $range['before'] ) ) { |
|
| 531 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | + "$date_field < %s", |
|
| 533 | + $range['before'] |
|
| 534 | + ); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + return $sql; |
|
| 538 | + |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * Prepares a group by query. |
|
| 543 | + * |
|
| 544 | + * @param string $date_field The date field. |
|
| 545 | + * @return string The appropriate SQL. |
|
| 546 | + */ |
|
| 547 | + public function get_group_by_sql( $date_field ) { |
|
| 548 | + |
|
| 549 | + if ( 'day' === $this->groupby ) { |
|
| 550 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Get the query params for collections. |
|
| 558 | + * |
|
| 559 | + * @return array |
|
| 560 | + */ |
|
| 561 | + public function get_collection_params() { |
|
| 562 | + return array( |
|
| 563 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | + 'period' => array( |
|
| 565 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | + 'type' => 'string', |
|
| 567 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | + 'default' => '7_days', |
|
| 571 | + ), |
|
| 572 | + 'after' => array( |
|
| 573 | + /* translators: %s: date format */ |
|
| 574 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | + 'type' => 'string', |
|
| 576 | + 'format' => 'date', |
|
| 577 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | + 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | + ), |
|
| 581 | + 'before' => array( |
|
| 582 | + /* translators: %s: date format */ |
|
| 583 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | + 'type' => 'string', |
|
| 585 | + 'format' => 'date', |
|
| 586 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | + 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | + ), |
|
| 590 | + ); |
|
| 591 | + } |
|
| 592 | 592 | } |
