@@ -12,265 +12,265 @@ |
||
| 12 | 12 | |
| 13 | 13 | return array( |
| 14 | 14 | |
| 15 | - array( |
|
| 16 | - 'country' => 'AT', // Austria |
|
| 17 | - 'state' => '', |
|
| 18 | - 'global' => true, |
|
| 19 | - 'rate' => 20, |
|
| 20 | - 'reduced_rate' => 13, |
|
| 21 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 22 | - ), |
|
| 23 | - |
|
| 24 | - array( |
|
| 25 | - 'country' => 'BE', // Belgium |
|
| 26 | - 'state' => '', |
|
| 27 | - 'global' => true, |
|
| 28 | - 'rate' => 21, |
|
| 29 | - 'reduced_rate' => 12, |
|
| 30 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 31 | - ), |
|
| 32 | - |
|
| 33 | - array( |
|
| 34 | - 'country' => 'BG', // Bulgaria |
|
| 35 | - 'state' => '', |
|
| 36 | - 'global' => true, |
|
| 37 | - 'rate' => 20, |
|
| 38 | - 'reduced_rate' => 9, |
|
| 39 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 40 | - ), |
|
| 41 | - |
|
| 42 | - array( |
|
| 43 | - 'country' => 'HR', // Croatia |
|
| 44 | - 'state' => '', |
|
| 45 | - 'global' => true, |
|
| 46 | - 'rate' => 25, |
|
| 47 | - 'reduced_rate' => 13, |
|
| 48 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 49 | - ), |
|
| 50 | - |
|
| 51 | - array( |
|
| 52 | - 'country' => 'CY', // Cyprus |
|
| 53 | - 'state' => '', |
|
| 54 | - 'global' => true, |
|
| 55 | - 'rate' => 19, |
|
| 56 | - 'reduced_rate' => 9, |
|
| 57 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 58 | - ), |
|
| 59 | - |
|
| 60 | - array( |
|
| 61 | - 'country' => 'CZ', // Czech Republic |
|
| 62 | - 'state' => '', |
|
| 63 | - 'global' => true, |
|
| 64 | - 'rate' => 21, |
|
| 65 | - 'reduced_rate' => 15, |
|
| 66 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 67 | - ), |
|
| 68 | - |
|
| 69 | - array( |
|
| 70 | - 'country' => 'DK', // Denmark |
|
| 71 | - 'state' => '', |
|
| 72 | - 'global' => true, |
|
| 73 | - 'rate' => 25, |
|
| 74 | - 'reduced_rate' => 0, |
|
| 75 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 76 | - ), |
|
| 77 | - |
|
| 78 | - array( |
|
| 79 | - 'country' => 'EE', // Estonia |
|
| 80 | - 'state' => '', |
|
| 81 | - 'global' => true, |
|
| 82 | - 'rate' => 20, |
|
| 83 | - 'reduced_rate' => 9, |
|
| 84 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 85 | - ), |
|
| 86 | - |
|
| 87 | - array( |
|
| 88 | - 'country' => 'FI', // Finland |
|
| 89 | - 'state' => '', |
|
| 90 | - 'global' => true, |
|
| 91 | - 'rate' => 24, |
|
| 92 | - 'reduced_rate' => 14, |
|
| 93 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 94 | - ), |
|
| 95 | - |
|
| 96 | - array( |
|
| 97 | - 'country' => 'FR', // France |
|
| 98 | - 'state' => '', |
|
| 99 | - 'global' => true, |
|
| 100 | - 'rate' => 20, |
|
| 101 | - 'reduced_rate' => 5.5, |
|
| 102 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 103 | - ), |
|
| 104 | - |
|
| 105 | - array( |
|
| 106 | - 'country' => 'DE', // Germany |
|
| 107 | - 'state' => '', |
|
| 108 | - 'global' => true, |
|
| 109 | - 'rate' => 19, |
|
| 110 | - 'reduced_rate' => 7, |
|
| 111 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 112 | - ), |
|
| 113 | - |
|
| 114 | - array( |
|
| 115 | - 'country' => 'GR', // Greece |
|
| 116 | - 'state' => '', |
|
| 117 | - 'global' => true, |
|
| 118 | - 'rate' => 24, |
|
| 119 | - 'reduced_rate' => 13, |
|
| 120 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 121 | - ), |
|
| 122 | - |
|
| 123 | - array( |
|
| 124 | - 'country' => 'HU', // Hungary |
|
| 125 | - 'state' => '', |
|
| 126 | - 'global' => true, |
|
| 127 | - 'rate' => 27, |
|
| 128 | - 'reduced_rate' => 18, |
|
| 129 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 130 | - ), |
|
| 131 | - |
|
| 132 | - array( |
|
| 133 | - 'country' => 'IE', // Ireland |
|
| 134 | - 'state' => '', |
|
| 135 | - 'global' => true, |
|
| 136 | - 'rate' => 23, |
|
| 137 | - 'reduced_rate' => 13.5, |
|
| 138 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 139 | - ), |
|
| 140 | - |
|
| 141 | - array( |
|
| 142 | - 'country' => 'IT', // Italy |
|
| 143 | - 'state' => '', |
|
| 144 | - 'global' => true, |
|
| 145 | - 'rate' => 22, |
|
| 146 | - 'reduced_rate' => 10, |
|
| 147 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 148 | - ), |
|
| 149 | - |
|
| 150 | - array( |
|
| 151 | - 'country' => 'LV', // Latvia |
|
| 152 | - 'state' => '', |
|
| 153 | - 'global' => true, |
|
| 154 | - 'rate' => 21, |
|
| 155 | - 'reduced_rate' => 12, |
|
| 156 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 157 | - ), |
|
| 158 | - |
|
| 159 | - array( |
|
| 160 | - 'country' => 'LT', // Lithuania |
|
| 161 | - 'state' => '', |
|
| 162 | - 'global' => true, |
|
| 163 | - 'rate' => 21, |
|
| 164 | - 'reduced_rate' => 9, |
|
| 165 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 166 | - ), |
|
| 167 | - |
|
| 168 | - array( |
|
| 169 | - 'country' => 'LU', // Luxembourg |
|
| 170 | - 'state' => '', |
|
| 171 | - 'global' => true, |
|
| 172 | - 'rate' => 17, |
|
| 173 | - 'reduced_rate' => 14, |
|
| 174 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 175 | - ), |
|
| 176 | - |
|
| 177 | - array( |
|
| 178 | - 'country' => 'MT', // Malta |
|
| 179 | - 'state' => '', |
|
| 180 | - 'global' => true, |
|
| 181 | - 'rate' => 18, |
|
| 182 | - 'reduced_rate' => 7, |
|
| 183 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 184 | - ), |
|
| 185 | - |
|
| 186 | - array( |
|
| 187 | - 'country' => 'MC', // Monaco |
|
| 188 | - 'state' => '', |
|
| 189 | - 'global' => true, |
|
| 190 | - 'rate' => 20, |
|
| 191 | - 'reduced_rate' => 10, |
|
| 192 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 193 | - ), |
|
| 194 | - |
|
| 195 | - array( |
|
| 196 | - 'country' => 'NL', // Netherlands |
|
| 197 | - 'state' => '', |
|
| 198 | - 'global' => true, |
|
| 199 | - 'rate' => 21, |
|
| 200 | - 'reduced_rate' => 9, |
|
| 201 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 202 | - ), |
|
| 203 | - |
|
| 204 | - array( |
|
| 205 | - 'country' => 'PL', // Poland |
|
| 206 | - 'state' => '', |
|
| 207 | - 'global' => true, |
|
| 208 | - 'rate' => 23, |
|
| 209 | - 'reduced_rate' => 8, |
|
| 210 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 211 | - ), |
|
| 212 | - |
|
| 213 | - array( |
|
| 214 | - 'country' => 'PT', // Portugal |
|
| 215 | - 'state' => '', |
|
| 216 | - 'global' => true, |
|
| 217 | - 'rate' => 23, |
|
| 218 | - 'reduced_rate' => 13, |
|
| 219 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 220 | - ), |
|
| 221 | - |
|
| 222 | - array( |
|
| 223 | - 'country' => 'RO', // Romania |
|
| 224 | - 'state' => '', |
|
| 225 | - 'global' => true, |
|
| 226 | - 'rate' => 19, |
|
| 227 | - 'reduced_rate' => 9, |
|
| 228 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 229 | - ), |
|
| 230 | - |
|
| 231 | - array( |
|
| 232 | - 'country' => 'SK', // Slovakia |
|
| 233 | - 'state' => '', |
|
| 234 | - 'global' => true, |
|
| 235 | - 'rate' => 20, |
|
| 236 | - 'reduced_rate' => 10, |
|
| 237 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 238 | - ), |
|
| 239 | - |
|
| 240 | - array( |
|
| 241 | - 'country' => 'SI', // Slovenia |
|
| 242 | - 'state' => '', |
|
| 243 | - 'global' => true, |
|
| 244 | - 'rate' => 22, |
|
| 245 | - 'reduced_rate' => 9.5, |
|
| 246 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 247 | - ), |
|
| 248 | - |
|
| 249 | - array( |
|
| 250 | - 'country' => 'ES', // Spain |
|
| 251 | - 'state' => '', |
|
| 252 | - 'global' => true, |
|
| 253 | - 'rate' => 21, |
|
| 254 | - 'reduced_rate' => 10, |
|
| 255 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 256 | - ), |
|
| 257 | - |
|
| 258 | - array( |
|
| 259 | - 'country' => 'SE', // Sweden |
|
| 260 | - 'state' => '', |
|
| 261 | - 'global' => true, |
|
| 262 | - 'rate' => 25, |
|
| 263 | - 'reduced_rate' => 12, |
|
| 264 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 265 | - ), |
|
| 266 | - |
|
| 267 | - array( |
|
| 268 | - 'country' => 'GB', // UK |
|
| 269 | - 'state' => '', |
|
| 270 | - 'global' => true, |
|
| 271 | - 'rate' => 20, |
|
| 272 | - 'reduced_rate' => 5, |
|
| 273 | - 'name' => __( 'VAT', 'invoicing' ), |
|
| 274 | - ), |
|
| 15 | + array( |
|
| 16 | + 'country' => 'AT', // Austria |
|
| 17 | + 'state' => '', |
|
| 18 | + 'global' => true, |
|
| 19 | + 'rate' => 20, |
|
| 20 | + 'reduced_rate' => 13, |
|
| 21 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 22 | + ), |
|
| 23 | + |
|
| 24 | + array( |
|
| 25 | + 'country' => 'BE', // Belgium |
|
| 26 | + 'state' => '', |
|
| 27 | + 'global' => true, |
|
| 28 | + 'rate' => 21, |
|
| 29 | + 'reduced_rate' => 12, |
|
| 30 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 31 | + ), |
|
| 32 | + |
|
| 33 | + array( |
|
| 34 | + 'country' => 'BG', // Bulgaria |
|
| 35 | + 'state' => '', |
|
| 36 | + 'global' => true, |
|
| 37 | + 'rate' => 20, |
|
| 38 | + 'reduced_rate' => 9, |
|
| 39 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 40 | + ), |
|
| 41 | + |
|
| 42 | + array( |
|
| 43 | + 'country' => 'HR', // Croatia |
|
| 44 | + 'state' => '', |
|
| 45 | + 'global' => true, |
|
| 46 | + 'rate' => 25, |
|
| 47 | + 'reduced_rate' => 13, |
|
| 48 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 49 | + ), |
|
| 50 | + |
|
| 51 | + array( |
|
| 52 | + 'country' => 'CY', // Cyprus |
|
| 53 | + 'state' => '', |
|
| 54 | + 'global' => true, |
|
| 55 | + 'rate' => 19, |
|
| 56 | + 'reduced_rate' => 9, |
|
| 57 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 58 | + ), |
|
| 59 | + |
|
| 60 | + array( |
|
| 61 | + 'country' => 'CZ', // Czech Republic |
|
| 62 | + 'state' => '', |
|
| 63 | + 'global' => true, |
|
| 64 | + 'rate' => 21, |
|
| 65 | + 'reduced_rate' => 15, |
|
| 66 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 67 | + ), |
|
| 68 | + |
|
| 69 | + array( |
|
| 70 | + 'country' => 'DK', // Denmark |
|
| 71 | + 'state' => '', |
|
| 72 | + 'global' => true, |
|
| 73 | + 'rate' => 25, |
|
| 74 | + 'reduced_rate' => 0, |
|
| 75 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 76 | + ), |
|
| 77 | + |
|
| 78 | + array( |
|
| 79 | + 'country' => 'EE', // Estonia |
|
| 80 | + 'state' => '', |
|
| 81 | + 'global' => true, |
|
| 82 | + 'rate' => 20, |
|
| 83 | + 'reduced_rate' => 9, |
|
| 84 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 85 | + ), |
|
| 86 | + |
|
| 87 | + array( |
|
| 88 | + 'country' => 'FI', // Finland |
|
| 89 | + 'state' => '', |
|
| 90 | + 'global' => true, |
|
| 91 | + 'rate' => 24, |
|
| 92 | + 'reduced_rate' => 14, |
|
| 93 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 94 | + ), |
|
| 95 | + |
|
| 96 | + array( |
|
| 97 | + 'country' => 'FR', // France |
|
| 98 | + 'state' => '', |
|
| 99 | + 'global' => true, |
|
| 100 | + 'rate' => 20, |
|
| 101 | + 'reduced_rate' => 5.5, |
|
| 102 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 103 | + ), |
|
| 104 | + |
|
| 105 | + array( |
|
| 106 | + 'country' => 'DE', // Germany |
|
| 107 | + 'state' => '', |
|
| 108 | + 'global' => true, |
|
| 109 | + 'rate' => 19, |
|
| 110 | + 'reduced_rate' => 7, |
|
| 111 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 112 | + ), |
|
| 113 | + |
|
| 114 | + array( |
|
| 115 | + 'country' => 'GR', // Greece |
|
| 116 | + 'state' => '', |
|
| 117 | + 'global' => true, |
|
| 118 | + 'rate' => 24, |
|
| 119 | + 'reduced_rate' => 13, |
|
| 120 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 121 | + ), |
|
| 122 | + |
|
| 123 | + array( |
|
| 124 | + 'country' => 'HU', // Hungary |
|
| 125 | + 'state' => '', |
|
| 126 | + 'global' => true, |
|
| 127 | + 'rate' => 27, |
|
| 128 | + 'reduced_rate' => 18, |
|
| 129 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 130 | + ), |
|
| 131 | + |
|
| 132 | + array( |
|
| 133 | + 'country' => 'IE', // Ireland |
|
| 134 | + 'state' => '', |
|
| 135 | + 'global' => true, |
|
| 136 | + 'rate' => 23, |
|
| 137 | + 'reduced_rate' => 13.5, |
|
| 138 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 139 | + ), |
|
| 140 | + |
|
| 141 | + array( |
|
| 142 | + 'country' => 'IT', // Italy |
|
| 143 | + 'state' => '', |
|
| 144 | + 'global' => true, |
|
| 145 | + 'rate' => 22, |
|
| 146 | + 'reduced_rate' => 10, |
|
| 147 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 148 | + ), |
|
| 149 | + |
|
| 150 | + array( |
|
| 151 | + 'country' => 'LV', // Latvia |
|
| 152 | + 'state' => '', |
|
| 153 | + 'global' => true, |
|
| 154 | + 'rate' => 21, |
|
| 155 | + 'reduced_rate' => 12, |
|
| 156 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 157 | + ), |
|
| 158 | + |
|
| 159 | + array( |
|
| 160 | + 'country' => 'LT', // Lithuania |
|
| 161 | + 'state' => '', |
|
| 162 | + 'global' => true, |
|
| 163 | + 'rate' => 21, |
|
| 164 | + 'reduced_rate' => 9, |
|
| 165 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 166 | + ), |
|
| 167 | + |
|
| 168 | + array( |
|
| 169 | + 'country' => 'LU', // Luxembourg |
|
| 170 | + 'state' => '', |
|
| 171 | + 'global' => true, |
|
| 172 | + 'rate' => 17, |
|
| 173 | + 'reduced_rate' => 14, |
|
| 174 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 175 | + ), |
|
| 176 | + |
|
| 177 | + array( |
|
| 178 | + 'country' => 'MT', // Malta |
|
| 179 | + 'state' => '', |
|
| 180 | + 'global' => true, |
|
| 181 | + 'rate' => 18, |
|
| 182 | + 'reduced_rate' => 7, |
|
| 183 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 184 | + ), |
|
| 185 | + |
|
| 186 | + array( |
|
| 187 | + 'country' => 'MC', // Monaco |
|
| 188 | + 'state' => '', |
|
| 189 | + 'global' => true, |
|
| 190 | + 'rate' => 20, |
|
| 191 | + 'reduced_rate' => 10, |
|
| 192 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 193 | + ), |
|
| 194 | + |
|
| 195 | + array( |
|
| 196 | + 'country' => 'NL', // Netherlands |
|
| 197 | + 'state' => '', |
|
| 198 | + 'global' => true, |
|
| 199 | + 'rate' => 21, |
|
| 200 | + 'reduced_rate' => 9, |
|
| 201 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 202 | + ), |
|
| 203 | + |
|
| 204 | + array( |
|
| 205 | + 'country' => 'PL', // Poland |
|
| 206 | + 'state' => '', |
|
| 207 | + 'global' => true, |
|
| 208 | + 'rate' => 23, |
|
| 209 | + 'reduced_rate' => 8, |
|
| 210 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 211 | + ), |
|
| 212 | + |
|
| 213 | + array( |
|
| 214 | + 'country' => 'PT', // Portugal |
|
| 215 | + 'state' => '', |
|
| 216 | + 'global' => true, |
|
| 217 | + 'rate' => 23, |
|
| 218 | + 'reduced_rate' => 13, |
|
| 219 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 220 | + ), |
|
| 221 | + |
|
| 222 | + array( |
|
| 223 | + 'country' => 'RO', // Romania |
|
| 224 | + 'state' => '', |
|
| 225 | + 'global' => true, |
|
| 226 | + 'rate' => 19, |
|
| 227 | + 'reduced_rate' => 9, |
|
| 228 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 229 | + ), |
|
| 230 | + |
|
| 231 | + array( |
|
| 232 | + 'country' => 'SK', // Slovakia |
|
| 233 | + 'state' => '', |
|
| 234 | + 'global' => true, |
|
| 235 | + 'rate' => 20, |
|
| 236 | + 'reduced_rate' => 10, |
|
| 237 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 238 | + ), |
|
| 239 | + |
|
| 240 | + array( |
|
| 241 | + 'country' => 'SI', // Slovenia |
|
| 242 | + 'state' => '', |
|
| 243 | + 'global' => true, |
|
| 244 | + 'rate' => 22, |
|
| 245 | + 'reduced_rate' => 9.5, |
|
| 246 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 247 | + ), |
|
| 248 | + |
|
| 249 | + array( |
|
| 250 | + 'country' => 'ES', // Spain |
|
| 251 | + 'state' => '', |
|
| 252 | + 'global' => true, |
|
| 253 | + 'rate' => 21, |
|
| 254 | + 'reduced_rate' => 10, |
|
| 255 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 256 | + ), |
|
| 257 | + |
|
| 258 | + array( |
|
| 259 | + 'country' => 'SE', // Sweden |
|
| 260 | + 'state' => '', |
|
| 261 | + 'global' => true, |
|
| 262 | + 'rate' => 25, |
|
| 263 | + 'reduced_rate' => 12, |
|
| 264 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 265 | + ), |
|
| 266 | + |
|
| 267 | + array( |
|
| 268 | + 'country' => 'GB', // UK |
|
| 269 | + 'state' => '', |
|
| 270 | + 'global' => true, |
|
| 271 | + 'rate' => 20, |
|
| 272 | + 'reduced_rate' => 5, |
|
| 273 | + 'name' => __( 'VAT', 'invoicing' ), |
|
| 274 | + ), |
|
| 275 | 275 | |
| 276 | 276 | ); |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,30 +10,30 @@ discard block |
||
| 10 | 10 | class WPInv_Item extends GetPaid_Data { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Which data store to load. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 13 | + * Which data store to load. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | 17 | protected $data_store_name = 'item'; |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * This is the name of this object type. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $object_type = 'item'; |
|
| 20 | + * This is the name of this object type. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $object_type = 'item'; |
|
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | - * |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - protected $data = array( |
|
| 33 | - 'parent_id' => 0, |
|
| 34 | - 'status' => 'draft', |
|
| 35 | - 'version' => '', |
|
| 36 | - 'date_created' => null, |
|
| 27 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | + * |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + protected $data = array( |
|
| 33 | + 'parent_id' => 0, |
|
| 34 | + 'status' => 'draft', |
|
| 35 | + 'version' => '', |
|
| 36 | + 'date_created' => null, |
|
| 37 | 37 | 'date_modified' => null, |
| 38 | 38 | 'name' => '', |
| 39 | 39 | 'description' => '', |
@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | ); |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * Stores meta in cache for future reads. |
|
| 62 | - * |
|
| 63 | - * A group must be set to to enable caching. |
|
| 64 | - * |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - protected $cache_group = 'getpaid_items'; |
|
| 61 | + * Stores meta in cache for future reads. |
|
| 62 | + * |
|
| 63 | + * A group must be set to to enable caching. |
|
| 64 | + * |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + protected $cache_group = 'getpaid_items'; |
|
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | 70 | * Stores a reference to the original WP_Post object |
@@ -74,37 +74,37 @@ discard block |
||
| 74 | 74 | protected $post = null; |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | - * |
|
| 79 | - * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | - */ |
|
| 81 | - public function __construct( $item = 0 ) { |
|
| 82 | - parent::__construct( $item ); |
|
| 83 | - |
|
| 84 | - if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | - $this->set_id( $item ); |
|
| 86 | - } elseif ( $item instanceof self ) { |
|
| 87 | - $this->set_id( $item->get_id() ); |
|
| 88 | - } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | - $this->set_id( $item->ID ); |
|
| 90 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | - $this->set_id( $item_id ); |
|
| 92 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | - $this->set_id( $item_id ); |
|
| 94 | - } else { |
|
| 95 | - $this->set_object_read( true ); |
|
| 96 | - } |
|
| 77 | + * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | + * |
|
| 79 | + * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | + */ |
|
| 81 | + public function __construct( $item = 0 ) { |
|
| 82 | + parent::__construct( $item ); |
|
| 83 | + |
|
| 84 | + if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | + $this->set_id( $item ); |
|
| 86 | + } elseif ( $item instanceof self ) { |
|
| 87 | + $this->set_id( $item->get_id() ); |
|
| 88 | + } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | + $this->set_id( $item->ID ); |
|
| 90 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | + $this->set_id( $item_id ); |
|
| 92 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | + $this->set_id( $item_id ); |
|
| 94 | + } else { |
|
| 95 | + $this->set_object_read( true ); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | 98 | // Load the datastore. |
| 99 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 99 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 100 | 100 | |
| 101 | - if ( $this->get_id() > 0 ) { |
|
| 101 | + if ( $this->get_id() > 0 ) { |
|
| 102 | 102 | $this->post = get_post( $this->get_id() ); |
| 103 | 103 | $this->ID = $this->get_id(); |
| 104 | - $this->data_store->read( $this ); |
|
| 104 | + $this->data_store->read( $this ); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - } |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | 109 | /* |
| 110 | 110 | |-------------------------------------------------------------------------- |
@@ -122,401 +122,401 @@ discard block |
||
| 122 | 122 | */ |
| 123 | 123 | |
| 124 | 124 | /** |
| 125 | - * Get parent item ID. |
|
| 126 | - * |
|
| 127 | - * @since 1.0.19 |
|
| 128 | - * @param string $context View or edit context. |
|
| 129 | - * @return int |
|
| 130 | - */ |
|
| 131 | - public function get_parent_id( $context = 'view' ) { |
|
| 132 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 125 | + * Get parent item ID. |
|
| 126 | + * |
|
| 127 | + * @since 1.0.19 |
|
| 128 | + * @param string $context View or edit context. |
|
| 129 | + * @return int |
|
| 130 | + */ |
|
| 131 | + public function get_parent_id( $context = 'view' ) { |
|
| 132 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | - * Get item status. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * @param string $context View or edit context. |
|
| 140 | - * @return string |
|
| 141 | - */ |
|
| 142 | - public function get_status( $context = 'view' ) { |
|
| 143 | - return $this->get_prop( 'status', $context ); |
|
| 136 | + * Get item status. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * @param string $context View or edit context. |
|
| 140 | + * @return string |
|
| 141 | + */ |
|
| 142 | + public function get_status( $context = 'view' ) { |
|
| 143 | + return $this->get_prop( 'status', $context ); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
| 147 | - * Get plugin version when the item was created. |
|
| 148 | - * |
|
| 149 | - * @since 1.0.19 |
|
| 150 | - * @param string $context View or edit context. |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 153 | - public function get_version( $context = 'view' ) { |
|
| 154 | - return $this->get_prop( 'version', $context ); |
|
| 147 | + * Get plugin version when the item was created. |
|
| 148 | + * |
|
| 149 | + * @since 1.0.19 |
|
| 150 | + * @param string $context View or edit context. |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | + public function get_version( $context = 'view' ) { |
|
| 154 | + return $this->get_prop( 'version', $context ); |
|
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | /** |
| 158 | - * Get date when the item was created. |
|
| 159 | - * |
|
| 160 | - * @since 1.0.19 |
|
| 161 | - * @param string $context View or edit context. |
|
| 162 | - * @return string |
|
| 163 | - */ |
|
| 164 | - public function get_date_created( $context = 'view' ) { |
|
| 165 | - return $this->get_prop( 'date_created', $context ); |
|
| 158 | + * Get date when the item was created. |
|
| 159 | + * |
|
| 160 | + * @since 1.0.19 |
|
| 161 | + * @param string $context View or edit context. |
|
| 162 | + * @return string |
|
| 163 | + */ |
|
| 164 | + public function get_date_created( $context = 'view' ) { |
|
| 165 | + return $this->get_prop( 'date_created', $context ); |
|
| 166 | 166 | } |
| 167 | 167 | |
| 168 | 168 | /** |
| 169 | - * Get GMT date when the item was created. |
|
| 170 | - * |
|
| 171 | - * @since 1.0.19 |
|
| 172 | - * @param string $context View or edit context. |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 169 | + * Get GMT date when the item was created. |
|
| 170 | + * |
|
| 171 | + * @since 1.0.19 |
|
| 172 | + * @param string $context View or edit context. |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 176 | 176 | $date = $this->get_date_created( $context ); |
| 177 | 177 | |
| 178 | 178 | if ( $date ) { |
| 179 | 179 | $date = get_gmt_from_date( $date ); |
| 180 | 180 | } |
| 181 | - return $date; |
|
| 181 | + return $date; |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | /** |
| 185 | - * Get date when the item was last modified. |
|
| 186 | - * |
|
| 187 | - * @since 1.0.19 |
|
| 188 | - * @param string $context View or edit context. |
|
| 189 | - * @return string |
|
| 190 | - */ |
|
| 191 | - public function get_date_modified( $context = 'view' ) { |
|
| 192 | - return $this->get_prop( 'date_modified', $context ); |
|
| 185 | + * Get date when the item was last modified. |
|
| 186 | + * |
|
| 187 | + * @since 1.0.19 |
|
| 188 | + * @param string $context View or edit context. |
|
| 189 | + * @return string |
|
| 190 | + */ |
|
| 191 | + public function get_date_modified( $context = 'view' ) { |
|
| 192 | + return $this->get_prop( 'date_modified', $context ); |
|
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | /** |
| 196 | - * Get GMT date when the item was last modified. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 196 | + * Get GMT date when the item was last modified. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 203 | 203 | $date = $this->get_date_modified( $context ); |
| 204 | 204 | |
| 205 | 205 | if ( $date ) { |
| 206 | 206 | $date = get_gmt_from_date( $date ); |
| 207 | 207 | } |
| 208 | - return $date; |
|
| 208 | + return $date; |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
| 212 | - * Get the item name. |
|
| 213 | - * |
|
| 214 | - * @since 1.0.19 |
|
| 215 | - * @param string $context View or edit context. |
|
| 216 | - * @return string |
|
| 217 | - */ |
|
| 218 | - public function get_name( $context = 'view' ) { |
|
| 219 | - return $this->get_prop( 'name', $context ); |
|
| 212 | + * Get the item name. |
|
| 213 | + * |
|
| 214 | + * @since 1.0.19 |
|
| 215 | + * @param string $context View or edit context. |
|
| 216 | + * @return string |
|
| 217 | + */ |
|
| 218 | + public function get_name( $context = 'view' ) { |
|
| 219 | + return $this->get_prop( 'name', $context ); |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
| 223 | - * Alias of self::get_name(). |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @param string $context View or edit context. |
|
| 227 | - * @return string |
|
| 228 | - */ |
|
| 229 | - public function get_title( $context = 'view' ) { |
|
| 230 | - return $this->get_name( $context ); |
|
| 223 | + * Alias of self::get_name(). |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @param string $context View or edit context. |
|
| 227 | + * @return string |
|
| 228 | + */ |
|
| 229 | + public function get_title( $context = 'view' ) { |
|
| 230 | + return $this->get_name( $context ); |
|
| 231 | 231 | } |
| 232 | 232 | |
| 233 | 233 | /** |
| 234 | - * Get the item description. |
|
| 235 | - * |
|
| 236 | - * @since 1.0.19 |
|
| 237 | - * @param string $context View or edit context. |
|
| 238 | - * @return string |
|
| 239 | - */ |
|
| 240 | - public function get_description( $context = 'view' ) { |
|
| 241 | - return $this->get_prop( 'description', $context ); |
|
| 234 | + * Get the item description. |
|
| 235 | + * |
|
| 236 | + * @since 1.0.19 |
|
| 237 | + * @param string $context View or edit context. |
|
| 238 | + * @return string |
|
| 239 | + */ |
|
| 240 | + public function get_description( $context = 'view' ) { |
|
| 241 | + return $this->get_prop( 'description', $context ); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Alias of self::get_description(). |
|
| 246 | - * |
|
| 247 | - * @since 1.0.19 |
|
| 248 | - * @param string $context View or edit context. |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function get_excerpt( $context = 'view' ) { |
|
| 252 | - return $this->get_description( $context ); |
|
| 245 | + * Alias of self::get_description(). |
|
| 246 | + * |
|
| 247 | + * @since 1.0.19 |
|
| 248 | + * @param string $context View or edit context. |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function get_excerpt( $context = 'view' ) { |
|
| 252 | + return $this->get_description( $context ); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Alias of self::get_description(). |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @param string $context View or edit context. |
|
| 260 | - * @return string |
|
| 261 | - */ |
|
| 262 | - public function get_summary( $context = 'view' ) { |
|
| 263 | - return $this->get_description( $context ); |
|
| 256 | + * Alias of self::get_description(). |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @param string $context View or edit context. |
|
| 260 | + * @return string |
|
| 261 | + */ |
|
| 262 | + public function get_summary( $context = 'view' ) { |
|
| 263 | + return $this->get_description( $context ); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | - * Get the owner of the item. |
|
| 268 | - * |
|
| 269 | - * @since 1.0.19 |
|
| 270 | - * @param string $context View or edit context. |
|
| 271 | - * @return int |
|
| 272 | - */ |
|
| 273 | - public function get_author( $context = 'view' ) { |
|
| 274 | - return (int) $this->get_prop( 'author', $context ); |
|
| 275 | - } |
|
| 267 | + * Get the owner of the item. |
|
| 268 | + * |
|
| 269 | + * @since 1.0.19 |
|
| 270 | + * @param string $context View or edit context. |
|
| 271 | + * @return int |
|
| 272 | + */ |
|
| 273 | + public function get_author( $context = 'view' ) { |
|
| 274 | + return (int) $this->get_prop( 'author', $context ); |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Alias of self::get_author(). |
|
| 279 | - * |
|
| 280 | - * @since 1.0.19 |
|
| 281 | - * @param string $context View or edit context. |
|
| 282 | - * @return int |
|
| 283 | - */ |
|
| 284 | - public function get_owner( $context = 'view' ) { |
|
| 285 | - return $this->get_author( $context ); |
|
| 277 | + /** |
|
| 278 | + * Alias of self::get_author(). |
|
| 279 | + * |
|
| 280 | + * @since 1.0.19 |
|
| 281 | + * @param string $context View or edit context. |
|
| 282 | + * @return int |
|
| 283 | + */ |
|
| 284 | + public function get_owner( $context = 'view' ) { |
|
| 285 | + return $this->get_author( $context ); |
|
| 286 | 286 | } |
| 287 | 287 | |
| 288 | 288 | /** |
| 289 | - * Get the price of the item. |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @param string $context View or edit context. |
|
| 293 | - * @return float |
|
| 294 | - */ |
|
| 295 | - public function get_price( $context = 'view' ) { |
|
| 289 | + * Get the price of the item. |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @param string $context View or edit context. |
|
| 293 | + * @return float |
|
| 294 | + */ |
|
| 295 | + public function get_price( $context = 'view' ) { |
|
| 296 | 296 | return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) ); |
| 297 | - } |
|
| 297 | + } |
|
| 298 | 298 | |
| 299 | - /** |
|
| 300 | - * Get the inital price of the item. |
|
| 301 | - * |
|
| 302 | - * @since 1.0.19 |
|
| 303 | - * @param string $context View or edit context. |
|
| 304 | - * @return float |
|
| 305 | - */ |
|
| 306 | - public function get_initial_price( $context = 'view' ) { |
|
| 299 | + /** |
|
| 300 | + * Get the inital price of the item. |
|
| 301 | + * |
|
| 302 | + * @since 1.0.19 |
|
| 303 | + * @param string $context View or edit context. |
|
| 304 | + * @return float |
|
| 305 | + */ |
|
| 306 | + public function get_initial_price( $context = 'view' ) { |
|
| 307 | 307 | |
| 308 | - $price = (float) $this->get_price( $context ); |
|
| 308 | + $price = (float) $this->get_price( $context ); |
|
| 309 | 309 | |
| 310 | - if ( $this->has_free_trial() ) { |
|
| 311 | - $price = 0; |
|
| 312 | - } |
|
| 310 | + if ( $this->has_free_trial() ) { |
|
| 311 | + $price = 0; |
|
| 312 | + } |
|
| 313 | 313 | |
| 314 | 314 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) ); |
| 315 | 315 | } |
| 316 | 316 | |
| 317 | 317 | /** |
| 318 | - * Returns a formated price. |
|
| 319 | - * |
|
| 320 | - * @since 1.0.19 |
|
| 321 | - * @param string $context View or edit context. |
|
| 322 | - * @return string |
|
| 323 | - */ |
|
| 318 | + * Returns a formated price. |
|
| 319 | + * |
|
| 320 | + * @since 1.0.19 |
|
| 321 | + * @param string $context View or edit context. |
|
| 322 | + * @return string |
|
| 323 | + */ |
|
| 324 | 324 | public function get_the_price() { |
| 325 | 325 | return wpinv_price( $this->get_price() ); |
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Returns the formated initial price. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param string $context View or edit context. |
|
| 333 | - * @return string |
|
| 334 | - */ |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Returns the formated initial price. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param string $context View or edit context. |
|
| 333 | + * @return string |
|
| 334 | + */ |
|
| 335 | 335 | public function get_the_initial_price() { |
| 336 | 336 | return wpinv_price( $this->get_initial_price() ); |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
| 340 | - * Get the VAT rule of the item. |
|
| 341 | - * |
|
| 342 | - * @since 1.0.19 |
|
| 343 | - * @param string $context View or edit context. |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - public function get_vat_rule( $context = 'view' ) { |
|
| 340 | + * Get the VAT rule of the item. |
|
| 341 | + * |
|
| 342 | + * @since 1.0.19 |
|
| 343 | + * @param string $context View or edit context. |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + public function get_vat_rule( $context = 'view' ) { |
|
| 347 | 347 | return $this->get_prop( 'vat_rule', $context ); |
| 348 | 348 | } |
| 349 | 349 | |
| 350 | 350 | /** |
| 351 | - * Get the VAT class of the item. |
|
| 352 | - * |
|
| 353 | - * @since 1.0.19 |
|
| 354 | - * @param string $context View or edit context. |
|
| 355 | - * @return string |
|
| 356 | - */ |
|
| 357 | - public function get_vat_class( $context = 'view' ) { |
|
| 351 | + * Get the VAT class of the item. |
|
| 352 | + * |
|
| 353 | + * @since 1.0.19 |
|
| 354 | + * @param string $context View or edit context. |
|
| 355 | + * @return string |
|
| 356 | + */ |
|
| 357 | + public function get_vat_class( $context = 'view' ) { |
|
| 358 | 358 | return $this->get_prop( 'vat_class', $context ); |
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | - * Get the type of the item. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param string $context View or edit context. |
|
| 366 | - * @return string |
|
| 367 | - */ |
|
| 368 | - public function get_type( $context = 'view' ) { |
|
| 362 | + * Get the type of the item. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param string $context View or edit context. |
|
| 366 | + * @return string |
|
| 367 | + */ |
|
| 368 | + public function get_type( $context = 'view' ) { |
|
| 369 | 369 | return $this->get_prop( 'type', $context ); |
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
| 373 | - * Get the custom id of the item. |
|
| 374 | - * |
|
| 375 | - * @since 1.0.19 |
|
| 376 | - * @param string $context View or edit context. |
|
| 377 | - * @return string |
|
| 378 | - */ |
|
| 379 | - public function get_custom_id( $context = 'view' ) { |
|
| 373 | + * Get the custom id of the item. |
|
| 374 | + * |
|
| 375 | + * @since 1.0.19 |
|
| 376 | + * @param string $context View or edit context. |
|
| 377 | + * @return string |
|
| 378 | + */ |
|
| 379 | + public function get_custom_id( $context = 'view' ) { |
|
| 380 | 380 | return $this->get_prop( 'custom_id', $context ); |
| 381 | 381 | } |
| 382 | 382 | |
| 383 | 383 | /** |
| 384 | - * Get the custom name of the item. |
|
| 385 | - * |
|
| 386 | - * @since 1.0.19 |
|
| 387 | - * @param string $context View or edit context. |
|
| 388 | - * @return string |
|
| 389 | - */ |
|
| 390 | - public function get_custom_name( $context = 'view' ) { |
|
| 384 | + * Get the custom name of the item. |
|
| 385 | + * |
|
| 386 | + * @since 1.0.19 |
|
| 387 | + * @param string $context View or edit context. |
|
| 388 | + * @return string |
|
| 389 | + */ |
|
| 390 | + public function get_custom_name( $context = 'view' ) { |
|
| 391 | 391 | return $this->get_prop( 'custom_name', $context ); |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | /** |
| 395 | - * Get the custom singular name of the item. |
|
| 396 | - * |
|
| 397 | - * @since 1.0.19 |
|
| 398 | - * @param string $context View or edit context. |
|
| 399 | - * @return string |
|
| 400 | - */ |
|
| 401 | - public function get_custom_singular_name( $context = 'view' ) { |
|
| 395 | + * Get the custom singular name of the item. |
|
| 396 | + * |
|
| 397 | + * @since 1.0.19 |
|
| 398 | + * @param string $context View or edit context. |
|
| 399 | + * @return string |
|
| 400 | + */ |
|
| 401 | + public function get_custom_singular_name( $context = 'view' ) { |
|
| 402 | 402 | return $this->get_prop( 'custom_singular_name', $context ); |
| 403 | 403 | } |
| 404 | 404 | |
| 405 | 405 | /** |
| 406 | - * Checks if an item is editable.. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * @param string $context View or edit context. |
|
| 410 | - * @return int |
|
| 411 | - */ |
|
| 412 | - public function get_is_editable( $context = 'view' ) { |
|
| 406 | + * Checks if an item is editable.. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * @param string $context View or edit context. |
|
| 410 | + * @return int |
|
| 411 | + */ |
|
| 412 | + public function get_is_editable( $context = 'view' ) { |
|
| 413 | 413 | return (int) $this->get_prop( 'is_editable', $context ); |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | /** |
| 417 | - * Alias of self::get_is_editable(). |
|
| 418 | - * |
|
| 419 | - * @since 1.0.19 |
|
| 420 | - * @param string $context View or edit context. |
|
| 421 | - * @return int |
|
| 422 | - */ |
|
| 423 | - public function get_editable( $context = 'view' ) { |
|
| 424 | - return $this->get_is_editable( $context ); |
|
| 417 | + * Alias of self::get_is_editable(). |
|
| 418 | + * |
|
| 419 | + * @since 1.0.19 |
|
| 420 | + * @param string $context View or edit context. |
|
| 421 | + * @return int |
|
| 422 | + */ |
|
| 423 | + public function get_editable( $context = 'view' ) { |
|
| 424 | + return $this->get_is_editable( $context ); |
|
| 425 | 425 | } |
| 426 | 426 | |
| 427 | 427 | /** |
| 428 | - * Checks if dynamic pricing is enabled. |
|
| 429 | - * |
|
| 430 | - * @since 1.0.19 |
|
| 431 | - * @param string $context View or edit context. |
|
| 432 | - * @return int |
|
| 433 | - */ |
|
| 434 | - public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 428 | + * Checks if dynamic pricing is enabled. |
|
| 429 | + * |
|
| 430 | + * @since 1.0.19 |
|
| 431 | + * @param string $context View or edit context. |
|
| 432 | + * @return int |
|
| 433 | + */ |
|
| 434 | + public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 435 | 435 | return (int) $this->get_prop( 'is_dynamic_pricing', $context ); |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | /** |
| 439 | - * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | - * |
|
| 441 | - * @since 1.0.19 |
|
| 442 | - * @param string $context View or edit context. |
|
| 443 | - * @return float |
|
| 444 | - */ |
|
| 445 | - public function get_minimum_price( $context = 'view' ) { |
|
| 439 | + * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | + * |
|
| 441 | + * @since 1.0.19 |
|
| 442 | + * @param string $context View or edit context. |
|
| 443 | + * @return float |
|
| 444 | + */ |
|
| 445 | + public function get_minimum_price( $context = 'view' ) { |
|
| 446 | 446 | return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) ); |
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | - * Checks if this is a recurring item. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param string $context View or edit context. |
|
| 454 | - * @return int |
|
| 455 | - */ |
|
| 456 | - public function get_is_recurring( $context = 'view' ) { |
|
| 450 | + * Checks if this is a recurring item. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param string $context View or edit context. |
|
| 454 | + * @return int |
|
| 455 | + */ |
|
| 456 | + public function get_is_recurring( $context = 'view' ) { |
|
| 457 | 457 | return (int) $this->get_prop( 'is_recurring', $context ); |
| 458 | - } |
|
| 459 | - |
|
| 460 | - /** |
|
| 461 | - * Get the recurring price of the item. |
|
| 462 | - * |
|
| 463 | - * @since 1.0.19 |
|
| 464 | - * @param string $context View or edit context. |
|
| 465 | - * @return float |
|
| 466 | - */ |
|
| 467 | - public function get_recurring_price( $context = 'view' ) { |
|
| 468 | - $price = $this->get_price( $context ); |
|
| 458 | + } |
|
| 459 | + |
|
| 460 | + /** |
|
| 461 | + * Get the recurring price of the item. |
|
| 462 | + * |
|
| 463 | + * @since 1.0.19 |
|
| 464 | + * @param string $context View or edit context. |
|
| 465 | + * @return float |
|
| 466 | + */ |
|
| 467 | + public function get_recurring_price( $context = 'view' ) { |
|
| 468 | + $price = $this->get_price( $context ); |
|
| 469 | 469 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) ); |
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Get the formatted recurring price of the item. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return string |
|
| 478 | - */ |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Get the formatted recurring price of the item. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return string |
|
| 478 | + */ |
|
| 479 | 479 | public function get_the_recurring_price() { |
| 480 | 480 | return wpinv_price( $this->get_recurring_price() ); |
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the first renewal date (in timestamps) of the item. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return int |
|
| 488 | - */ |
|
| 489 | - public function get_first_renewal_date() { |
|
| 490 | - |
|
| 491 | - $periods = array( |
|
| 492 | - 'D' => 'days', |
|
| 493 | - 'W' => 'weeks', |
|
| 494 | - 'M' => 'months', |
|
| 495 | - 'Y' => 'years', |
|
| 496 | - ); |
|
| 497 | - |
|
| 498 | - $period = $this->get_recurring_period(); |
|
| 499 | - $interval = $this->get_recurring_interval(); |
|
| 500 | - |
|
| 501 | - if ( $this->has_free_trial() ) { |
|
| 502 | - $period = $this->get_trial_period(); |
|
| 503 | - $interval = $this->get_trial_interval(); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - $period = $periods[ $period ]; |
|
| 507 | - $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | - $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the first renewal date (in timestamps) of the item. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return int |
|
| 488 | + */ |
|
| 489 | + public function get_first_renewal_date() { |
|
| 490 | + |
|
| 491 | + $periods = array( |
|
| 492 | + 'D' => 'days', |
|
| 493 | + 'W' => 'weeks', |
|
| 494 | + 'M' => 'months', |
|
| 495 | + 'Y' => 'years', |
|
| 496 | + ); |
|
| 497 | + |
|
| 498 | + $period = $this->get_recurring_period(); |
|
| 499 | + $interval = $this->get_recurring_interval(); |
|
| 500 | + |
|
| 501 | + if ( $this->has_free_trial() ) { |
|
| 502 | + $period = $this->get_trial_period(); |
|
| 503 | + $interval = $this->get_trial_interval(); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + $period = $periods[ $period ]; |
|
| 507 | + $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | + $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 509 | 509 | return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this ); |
| 510 | 510 | } |
| 511 | 511 | |
| 512 | 512 | /** |
| 513 | - * Get the recurring period. |
|
| 514 | - * |
|
| 515 | - * @since 1.0.19 |
|
| 516 | - * @param bool $full Return abbreviation or in full. |
|
| 517 | - * @return string |
|
| 518 | - */ |
|
| 519 | - public function get_recurring_period( $full = false ) { |
|
| 513 | + * Get the recurring period. |
|
| 514 | + * |
|
| 515 | + * @since 1.0.19 |
|
| 516 | + * @param bool $full Return abbreviation or in full. |
|
| 517 | + * @return string |
|
| 518 | + */ |
|
| 519 | + public function get_recurring_period( $full = false ) { |
|
| 520 | 520 | $period = $this->get_prop( 'recurring_period', 'view' ); |
| 521 | 521 | |
| 522 | 522 | if ( $full && ! is_bool( $full ) ) { |
@@ -527,58 +527,58 @@ discard block |
||
| 527 | 527 | } |
| 528 | 528 | |
| 529 | 529 | /** |
| 530 | - * Get the recurring interval. |
|
| 531 | - * |
|
| 532 | - * @since 1.0.19 |
|
| 533 | - * @param string $context View or edit context. |
|
| 534 | - * @return int |
|
| 535 | - */ |
|
| 536 | - public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | - $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | - return max( 1, $interval ); |
|
| 530 | + * Get the recurring interval. |
|
| 531 | + * |
|
| 532 | + * @since 1.0.19 |
|
| 533 | + * @param string $context View or edit context. |
|
| 534 | + * @return int |
|
| 535 | + */ |
|
| 536 | + public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | + $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | + return max( 1, $interval ); |
|
| 539 | 539 | } |
| 540 | 540 | |
| 541 | 541 | /** |
| 542 | - * Get the recurring limit. |
|
| 543 | - * |
|
| 544 | - * @since 1.0.19 |
|
| 545 | - * @param string $context View or edit context. |
|
| 546 | - * @return int |
|
| 547 | - */ |
|
| 548 | - public function get_recurring_limit( $context = 'view' ) { |
|
| 542 | + * Get the recurring limit. |
|
| 543 | + * |
|
| 544 | + * @since 1.0.19 |
|
| 545 | + * @param string $context View or edit context. |
|
| 546 | + * @return int |
|
| 547 | + */ |
|
| 548 | + public function get_recurring_limit( $context = 'view' ) { |
|
| 549 | 549 | return (int) $this->get_prop( 'recurring_limit', $context ); |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | 552 | /** |
| 553 | - * Checks if we have a free trial. |
|
| 554 | - * |
|
| 555 | - * @since 1.0.19 |
|
| 556 | - * @param string $context View or edit context. |
|
| 557 | - * @return int |
|
| 558 | - */ |
|
| 559 | - public function get_is_free_trial( $context = 'view' ) { |
|
| 553 | + * Checks if we have a free trial. |
|
| 554 | + * |
|
| 555 | + * @since 1.0.19 |
|
| 556 | + * @param string $context View or edit context. |
|
| 557 | + * @return int |
|
| 558 | + */ |
|
| 559 | + public function get_is_free_trial( $context = 'view' ) { |
|
| 560 | 560 | return (int) $this->get_prop( 'is_free_trial', $context ); |
| 561 | 561 | } |
| 562 | 562 | |
| 563 | 563 | /** |
| 564 | - * Alias for self::get_is_free_trial(). |
|
| 565 | - * |
|
| 566 | - * @since 1.0.19 |
|
| 567 | - * @param string $context View or edit context. |
|
| 568 | - * @return int |
|
| 569 | - */ |
|
| 570 | - public function get_free_trial( $context = 'view' ) { |
|
| 564 | + * Alias for self::get_is_free_trial(). |
|
| 565 | + * |
|
| 566 | + * @since 1.0.19 |
|
| 567 | + * @param string $context View or edit context. |
|
| 568 | + * @return int |
|
| 569 | + */ |
|
| 570 | + public function get_free_trial( $context = 'view' ) { |
|
| 571 | 571 | return $this->get_is_free_trial( $context ); |
| 572 | 572 | } |
| 573 | 573 | |
| 574 | 574 | /** |
| 575 | - * Get the trial period. |
|
| 576 | - * |
|
| 577 | - * @since 1.0.19 |
|
| 578 | - * @param bool $full Return abbreviation or in full. |
|
| 579 | - * @return string |
|
| 580 | - */ |
|
| 581 | - public function get_trial_period( $full = false ) { |
|
| 575 | + * Get the trial period. |
|
| 576 | + * |
|
| 577 | + * @since 1.0.19 |
|
| 578 | + * @param bool $full Return abbreviation or in full. |
|
| 579 | + * @return string |
|
| 580 | + */ |
|
| 581 | + public function get_trial_period( $full = false ) { |
|
| 582 | 582 | $period = $this->get_prop( 'trial_period', 'view' ); |
| 583 | 583 | |
| 584 | 584 | if ( $full && ! is_bool( $full ) ) { |
@@ -589,104 +589,104 @@ discard block |
||
| 589 | 589 | } |
| 590 | 590 | |
| 591 | 591 | /** |
| 592 | - * Get the trial interval. |
|
| 593 | - * |
|
| 594 | - * @since 1.0.19 |
|
| 595 | - * @param string $context View or edit context. |
|
| 596 | - * @return int |
|
| 597 | - */ |
|
| 598 | - public function get_trial_interval( $context = 'view' ) { |
|
| 592 | + * Get the trial interval. |
|
| 593 | + * |
|
| 594 | + * @since 1.0.19 |
|
| 595 | + * @param string $context View or edit context. |
|
| 596 | + * @return int |
|
| 597 | + */ |
|
| 598 | + public function get_trial_interval( $context = 'view' ) { |
|
| 599 | 599 | return (int) $this->get_prop( 'trial_interval', $context ); |
| 600 | - } |
|
| 601 | - |
|
| 602 | - /** |
|
| 603 | - * Get the item's edit url. |
|
| 604 | - * |
|
| 605 | - * @since 1.0.19 |
|
| 606 | - * @return string |
|
| 607 | - */ |
|
| 608 | - public function get_edit_url() { |
|
| 600 | + } |
|
| 601 | + |
|
| 602 | + /** |
|
| 603 | + * Get the item's edit url. |
|
| 604 | + * |
|
| 605 | + * @since 1.0.19 |
|
| 606 | + * @return string |
|
| 607 | + */ |
|
| 608 | + public function get_edit_url() { |
|
| 609 | 609 | return get_edit_post_link( $this->get_id(), 'edit' ); |
| 610 | - } |
|
| 611 | - |
|
| 612 | - /** |
|
| 613 | - * Given an item's name/custom id, it returns its id. |
|
| 614 | - * |
|
| 615 | - * |
|
| 616 | - * @static |
|
| 617 | - * @param string $value The item name or custom id. |
|
| 618 | - * @param string $field Either name or custom_id. |
|
| 619 | - * @param string $type in case you need to search for a given type. |
|
| 620 | - * @since 1.0.15 |
|
| 621 | - * @return int |
|
| 622 | - */ |
|
| 623 | - public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | - |
|
| 625 | - // Trim the value. |
|
| 626 | - $value = sanitize_text_field( $value ); |
|
| 627 | - if ( empty( $value ) ) { |
|
| 628 | - return 0; |
|
| 629 | - } |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + /** |
|
| 613 | + * Given an item's name/custom id, it returns its id. |
|
| 614 | + * |
|
| 615 | + * |
|
| 616 | + * @static |
|
| 617 | + * @param string $value The item name or custom id. |
|
| 618 | + * @param string $field Either name or custom_id. |
|
| 619 | + * @param string $type in case you need to search for a given type. |
|
| 620 | + * @since 1.0.15 |
|
| 621 | + * @return int |
|
| 622 | + */ |
|
| 623 | + public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 624 | + |
|
| 625 | + // Trim the value. |
|
| 626 | + $value = sanitize_text_field( $value ); |
|
| 627 | + if ( empty( $value ) ) { |
|
| 628 | + return 0; |
|
| 629 | + } |
|
| 630 | 630 | |
| 631 | 631 | // Valid fields. |
| 632 | 632 | $fields = array( 'custom_id', 'name', 'slug' ); |
| 633 | 633 | |
| 634 | - // Ensure a field has been passed. |
|
| 635 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | - return 0; |
|
| 637 | - } |
|
| 638 | - |
|
| 639 | - if ( $field == 'name' ) { |
|
| 640 | - $field = 'slug'; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - // Maybe retrieve from the cache. |
|
| 644 | - $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | - if ( ! empty( $item_id ) ) { |
|
| 646 | - return $item_id; |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - // Fetch from the db. |
|
| 650 | - $items = array(); |
|
| 651 | - if ( $field == 'slug' ) { |
|
| 652 | - $items = get_posts( |
|
| 653 | - array( |
|
| 654 | - 'post_type' => 'wpi_item', |
|
| 655 | - 'name' => $value, |
|
| 656 | - 'posts_per_page' => 1, |
|
| 657 | - 'post_status' => 'any', |
|
| 658 | - ) |
|
| 659 | - ); |
|
| 660 | - } |
|
| 661 | - |
|
| 662 | - if ( $field == 'custom_id' ) { |
|
| 663 | - $items = get_posts( |
|
| 664 | - array( |
|
| 665 | - 'post_type' => 'wpi_item', |
|
| 666 | - 'posts_per_page' => 1, |
|
| 667 | - 'post_status' => 'any', |
|
| 668 | - 'meta_query' => array( |
|
| 669 | - array( |
|
| 670 | - 'key' => '_wpinv_type', |
|
| 671 | - 'value' => $type, |
|
| 672 | - ), |
|
| 673 | - array( |
|
| 674 | - 'key' => '_wpinv_custom_id', |
|
| 675 | - 'value' => $value, |
|
| 676 | - ), |
|
| 677 | - ), |
|
| 678 | - ) |
|
| 679 | - ); |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - if ( empty( $items ) ) { |
|
| 683 | - return 0; |
|
| 684 | - } |
|
| 685 | - |
|
| 686 | - // Update the cache with our data |
|
| 687 | - wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | - |
|
| 689 | - return $items[0]->ID; |
|
| 634 | + // Ensure a field has been passed. |
|
| 635 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 636 | + return 0; |
|
| 637 | + } |
|
| 638 | + |
|
| 639 | + if ( $field == 'name' ) { |
|
| 640 | + $field = 'slug'; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + // Maybe retrieve from the cache. |
|
| 644 | + $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 645 | + if ( ! empty( $item_id ) ) { |
|
| 646 | + return $item_id; |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + // Fetch from the db. |
|
| 650 | + $items = array(); |
|
| 651 | + if ( $field == 'slug' ) { |
|
| 652 | + $items = get_posts( |
|
| 653 | + array( |
|
| 654 | + 'post_type' => 'wpi_item', |
|
| 655 | + 'name' => $value, |
|
| 656 | + 'posts_per_page' => 1, |
|
| 657 | + 'post_status' => 'any', |
|
| 658 | + ) |
|
| 659 | + ); |
|
| 660 | + } |
|
| 661 | + |
|
| 662 | + if ( $field == 'custom_id' ) { |
|
| 663 | + $items = get_posts( |
|
| 664 | + array( |
|
| 665 | + 'post_type' => 'wpi_item', |
|
| 666 | + 'posts_per_page' => 1, |
|
| 667 | + 'post_status' => 'any', |
|
| 668 | + 'meta_query' => array( |
|
| 669 | + array( |
|
| 670 | + 'key' => '_wpinv_type', |
|
| 671 | + 'value' => $type, |
|
| 672 | + ), |
|
| 673 | + array( |
|
| 674 | + 'key' => '_wpinv_custom_id', |
|
| 675 | + 'value' => $value, |
|
| 676 | + ), |
|
| 677 | + ), |
|
| 678 | + ) |
|
| 679 | + ); |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + if ( empty( $items ) ) { |
|
| 683 | + return 0; |
|
| 684 | + } |
|
| 685 | + |
|
| 686 | + // Update the cache with our data |
|
| 687 | + wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 688 | + |
|
| 689 | + return $items[0]->ID; |
|
| 690 | 690 | } |
| 691 | 691 | |
| 692 | 692 | /** |
@@ -719,52 +719,52 @@ discard block |
||
| 719 | 719 | */ |
| 720 | 720 | |
| 721 | 721 | /** |
| 722 | - * Set parent order ID. |
|
| 723 | - * |
|
| 724 | - * @since 1.0.19 |
|
| 725 | - */ |
|
| 726 | - public function set_parent_id( $value ) { |
|
| 727 | - if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | - return; |
|
| 729 | - } |
|
| 730 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Sets item status. |
|
| 735 | - * |
|
| 736 | - * @since 1.0.19 |
|
| 737 | - * @param string $status New status. |
|
| 738 | - * @return array details of change. |
|
| 739 | - */ |
|
| 740 | - public function set_status( $status ) { |
|
| 722 | + * Set parent order ID. |
|
| 723 | + * |
|
| 724 | + * @since 1.0.19 |
|
| 725 | + */ |
|
| 726 | + public function set_parent_id( $value ) { |
|
| 727 | + if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 728 | + return; |
|
| 729 | + } |
|
| 730 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Sets item status. |
|
| 735 | + * |
|
| 736 | + * @since 1.0.19 |
|
| 737 | + * @param string $status New status. |
|
| 738 | + * @return array details of change. |
|
| 739 | + */ |
|
| 740 | + public function set_status( $status ) { |
|
| 741 | 741 | $old_status = $this->get_status(); |
| 742 | 742 | |
| 743 | 743 | $this->set_prop( 'status', $status ); |
| 744 | 744 | |
| 745 | - return array( |
|
| 746 | - 'from' => $old_status, |
|
| 747 | - 'to' => $status, |
|
| 748 | - ); |
|
| 745 | + return array( |
|
| 746 | + 'from' => $old_status, |
|
| 747 | + 'to' => $status, |
|
| 748 | + ); |
|
| 749 | 749 | } |
| 750 | 750 | |
| 751 | 751 | /** |
| 752 | - * Set plugin version when the item was created. |
|
| 753 | - * |
|
| 754 | - * @since 1.0.19 |
|
| 755 | - */ |
|
| 756 | - public function set_version( $value ) { |
|
| 757 | - $this->set_prop( 'version', $value ); |
|
| 752 | + * Set plugin version when the item was created. |
|
| 753 | + * |
|
| 754 | + * @since 1.0.19 |
|
| 755 | + */ |
|
| 756 | + public function set_version( $value ) { |
|
| 757 | + $this->set_prop( 'version', $value ); |
|
| 758 | 758 | } |
| 759 | 759 | |
| 760 | 760 | /** |
| 761 | - * Set date when the item was created. |
|
| 762 | - * |
|
| 763 | - * @since 1.0.19 |
|
| 764 | - * @param string $value Value to set. |
|
| 761 | + * Set date when the item was created. |
|
| 762 | + * |
|
| 763 | + * @since 1.0.19 |
|
| 764 | + * @param string $value Value to set. |
|
| 765 | 765 | * @return bool Whether or not the date was set. |
| 766 | - */ |
|
| 767 | - public function set_date_created( $value ) { |
|
| 766 | + */ |
|
| 767 | + public function set_date_created( $value ) { |
|
| 768 | 768 | $date = strtotime( $value ); |
| 769 | 769 | |
| 770 | 770 | if ( $date ) { |
@@ -777,13 +777,13 @@ discard block |
||
| 777 | 777 | } |
| 778 | 778 | |
| 779 | 779 | /** |
| 780 | - * Set date when the item was last modified. |
|
| 781 | - * |
|
| 782 | - * @since 1.0.19 |
|
| 783 | - * @param string $value Value to set. |
|
| 780 | + * Set date when the item was last modified. |
|
| 781 | + * |
|
| 782 | + * @since 1.0.19 |
|
| 783 | + * @param string $value Value to set. |
|
| 784 | 784 | * @return bool Whether or not the date was set. |
| 785 | - */ |
|
| 786 | - public function set_date_modified( $value ) { |
|
| 785 | + */ |
|
| 786 | + public function set_date_modified( $value ) { |
|
| 787 | 787 | $date = strtotime( $value ); |
| 788 | 788 | |
| 789 | 789 | if ( $date ) { |
@@ -796,115 +796,115 @@ discard block |
||
| 796 | 796 | } |
| 797 | 797 | |
| 798 | 798 | /** |
| 799 | - * Set the item name. |
|
| 800 | - * |
|
| 801 | - * @since 1.0.19 |
|
| 802 | - * @param string $value New name. |
|
| 803 | - */ |
|
| 804 | - public function set_name( $value ) { |
|
| 799 | + * Set the item name. |
|
| 800 | + * |
|
| 801 | + * @since 1.0.19 |
|
| 802 | + * @param string $value New name. |
|
| 803 | + */ |
|
| 804 | + public function set_name( $value ) { |
|
| 805 | 805 | $name = sanitize_text_field( $value ); |
| 806 | - $this->set_prop( 'name', $name ); |
|
| 806 | + $this->set_prop( 'name', $name ); |
|
| 807 | 807 | } |
| 808 | 808 | |
| 809 | 809 | /** |
| 810 | - * Alias of self::set_name(). |
|
| 811 | - * |
|
| 812 | - * @since 1.0.19 |
|
| 813 | - * @param string $value New name. |
|
| 814 | - */ |
|
| 815 | - public function set_title( $value ) { |
|
| 816 | - $this->set_name( $value ); |
|
| 810 | + * Alias of self::set_name(). |
|
| 811 | + * |
|
| 812 | + * @since 1.0.19 |
|
| 813 | + * @param string $value New name. |
|
| 814 | + */ |
|
| 815 | + public function set_title( $value ) { |
|
| 816 | + $this->set_name( $value ); |
|
| 817 | 817 | } |
| 818 | 818 | |
| 819 | 819 | /** |
| 820 | - * Set the item description. |
|
| 821 | - * |
|
| 822 | - * @since 1.0.19 |
|
| 823 | - * @param string $value New description. |
|
| 824 | - */ |
|
| 825 | - public function set_description( $value ) { |
|
| 826 | - $description = wp_kses_post( wp_unslash( $value ) ); |
|
| 827 | - return $this->set_prop( 'description', $description ); |
|
| 820 | + * Set the item description. |
|
| 821 | + * |
|
| 822 | + * @since 1.0.19 |
|
| 823 | + * @param string $value New description. |
|
| 824 | + */ |
|
| 825 | + public function set_description( $value ) { |
|
| 826 | + $description = wp_kses_post( wp_unslash( $value ) ); |
|
| 827 | + return $this->set_prop( 'description', $description ); |
|
| 828 | 828 | } |
| 829 | 829 | |
| 830 | 830 | /** |
| 831 | - * Alias of self::set_description(). |
|
| 832 | - * |
|
| 833 | - * @since 1.0.19 |
|
| 834 | - * @param string $value New description. |
|
| 835 | - */ |
|
| 836 | - public function set_excerpt( $value ) { |
|
| 837 | - $this->set_description( $value ); |
|
| 831 | + * Alias of self::set_description(). |
|
| 832 | + * |
|
| 833 | + * @since 1.0.19 |
|
| 834 | + * @param string $value New description. |
|
| 835 | + */ |
|
| 836 | + public function set_excerpt( $value ) { |
|
| 837 | + $this->set_description( $value ); |
|
| 838 | 838 | } |
| 839 | 839 | |
| 840 | 840 | /** |
| 841 | - * Alias of self::set_description(). |
|
| 842 | - * |
|
| 843 | - * @since 1.0.19 |
|
| 844 | - * @param string $value New description. |
|
| 845 | - */ |
|
| 846 | - public function set_summary( $value ) { |
|
| 847 | - $this->set_description( $value ); |
|
| 841 | + * Alias of self::set_description(). |
|
| 842 | + * |
|
| 843 | + * @since 1.0.19 |
|
| 844 | + * @param string $value New description. |
|
| 845 | + */ |
|
| 846 | + public function set_summary( $value ) { |
|
| 847 | + $this->set_description( $value ); |
|
| 848 | 848 | } |
| 849 | 849 | |
| 850 | 850 | /** |
| 851 | - * Set the owner of the item. |
|
| 852 | - * |
|
| 853 | - * @since 1.0.19 |
|
| 854 | - * @param int $value New author. |
|
| 855 | - */ |
|
| 856 | - public function set_author( $value ) { |
|
| 857 | - $this->set_prop( 'author', (int) $value ); |
|
| 858 | - } |
|
| 851 | + * Set the owner of the item. |
|
| 852 | + * |
|
| 853 | + * @since 1.0.19 |
|
| 854 | + * @param int $value New author. |
|
| 855 | + */ |
|
| 856 | + public function set_author( $value ) { |
|
| 857 | + $this->set_prop( 'author', (int) $value ); |
|
| 858 | + } |
|
| 859 | 859 | |
| 860 | - /** |
|
| 861 | - * Alias of self::set_author(). |
|
| 862 | - * |
|
| 863 | - * @since 1.0.19 |
|
| 864 | - * @param int $value New author. |
|
| 865 | - */ |
|
| 866 | - public function set_owner( $value ) { |
|
| 867 | - $this->set_author( $value ); |
|
| 860 | + /** |
|
| 861 | + * Alias of self::set_author(). |
|
| 862 | + * |
|
| 863 | + * @since 1.0.19 |
|
| 864 | + * @param int $value New author. |
|
| 865 | + */ |
|
| 866 | + public function set_owner( $value ) { |
|
| 867 | + $this->set_author( $value ); |
|
| 868 | 868 | } |
| 869 | 869 | |
| 870 | 870 | /** |
| 871 | - * Set the price of the item. |
|
| 872 | - * |
|
| 873 | - * @since 1.0.19 |
|
| 874 | - * @param float $value New price. |
|
| 875 | - */ |
|
| 876 | - public function set_price( $value ) { |
|
| 871 | + * Set the price of the item. |
|
| 872 | + * |
|
| 873 | + * @since 1.0.19 |
|
| 874 | + * @param float $value New price. |
|
| 875 | + */ |
|
| 876 | + public function set_price( $value ) { |
|
| 877 | 877 | $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) ); |
| 878 | 878 | } |
| 879 | 879 | |
| 880 | 880 | /** |
| 881 | - * Set the VAT rule of the item. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $value new rule. |
|
| 885 | - */ |
|
| 886 | - public function set_vat_rule( $value ) { |
|
| 881 | + * Set the VAT rule of the item. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $value new rule. |
|
| 885 | + */ |
|
| 886 | + public function set_vat_rule( $value ) { |
|
| 887 | 887 | $this->set_prop( 'vat_rule', $value ); |
| 888 | 888 | } |
| 889 | 889 | |
| 890 | 890 | /** |
| 891 | - * Set the VAT class of the item. |
|
| 892 | - * |
|
| 893 | - * @since 1.0.19 |
|
| 894 | - * @param string $value new class. |
|
| 895 | - */ |
|
| 896 | - public function set_vat_class( $value ) { |
|
| 891 | + * Set the VAT class of the item. |
|
| 892 | + * |
|
| 893 | + * @since 1.0.19 |
|
| 894 | + * @param string $value new class. |
|
| 895 | + */ |
|
| 896 | + public function set_vat_class( $value ) { |
|
| 897 | 897 | $this->set_prop( 'vat_class', $value ); |
| 898 | 898 | } |
| 899 | 899 | |
| 900 | 900 | /** |
| 901 | - * Set the type of the item. |
|
| 902 | - * |
|
| 903 | - * @since 1.0.19 |
|
| 904 | - * @param string $value new item type. |
|
| 905 | - * @return string |
|
| 906 | - */ |
|
| 907 | - public function set_type( $value ) { |
|
| 901 | + * Set the type of the item. |
|
| 902 | + * |
|
| 903 | + * @since 1.0.19 |
|
| 904 | + * @param string $value new item type. |
|
| 905 | + * @return string |
|
| 906 | + */ |
|
| 907 | + public function set_type( $value ) { |
|
| 908 | 908 | |
| 909 | 909 | if ( empty( $value ) ) { |
| 910 | 910 | $value = 'custom'; |
@@ -914,132 +914,132 @@ discard block |
||
| 914 | 914 | } |
| 915 | 915 | |
| 916 | 916 | /** |
| 917 | - * Set the custom id of the item. |
|
| 918 | - * |
|
| 919 | - * @since 1.0.19 |
|
| 920 | - * @param string $value new custom id. |
|
| 921 | - */ |
|
| 922 | - public function set_custom_id( $value ) { |
|
| 917 | + * Set the custom id of the item. |
|
| 918 | + * |
|
| 919 | + * @since 1.0.19 |
|
| 920 | + * @param string $value new custom id. |
|
| 921 | + */ |
|
| 922 | + public function set_custom_id( $value ) { |
|
| 923 | 923 | $this->set_prop( 'custom_id', $value ); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | 926 | /** |
| 927 | - * Set the custom name of the item. |
|
| 928 | - * |
|
| 929 | - * @since 1.0.19 |
|
| 930 | - * @param string $value new custom name. |
|
| 931 | - */ |
|
| 932 | - public function set_custom_name( $value ) { |
|
| 927 | + * Set the custom name of the item. |
|
| 928 | + * |
|
| 929 | + * @since 1.0.19 |
|
| 930 | + * @param string $value new custom name. |
|
| 931 | + */ |
|
| 932 | + public function set_custom_name( $value ) { |
|
| 933 | 933 | $this->set_prop( 'custom_name', $value ); |
| 934 | 934 | } |
| 935 | 935 | |
| 936 | 936 | /** |
| 937 | - * Set the custom singular name of the item. |
|
| 938 | - * |
|
| 939 | - * @since 1.0.19 |
|
| 940 | - * @param string $value new custom singular name. |
|
| 941 | - */ |
|
| 942 | - public function set_custom_singular_name( $value ) { |
|
| 937 | + * Set the custom singular name of the item. |
|
| 938 | + * |
|
| 939 | + * @since 1.0.19 |
|
| 940 | + * @param string $value new custom singular name. |
|
| 941 | + */ |
|
| 942 | + public function set_custom_singular_name( $value ) { |
|
| 943 | 943 | $this->set_prop( 'custom_singular_name', $value ); |
| 944 | 944 | } |
| 945 | 945 | |
| 946 | 946 | /** |
| 947 | - * Sets if an item is editable.. |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param int|bool $value whether or not the item is editable. |
|
| 951 | - */ |
|
| 952 | - public function set_is_editable( $value ) { |
|
| 953 | - $this->set_prop( 'is_editable', (int) $value ); |
|
| 947 | + * Sets if an item is editable.. |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param int|bool $value whether or not the item is editable. |
|
| 951 | + */ |
|
| 952 | + public function set_is_editable( $value ) { |
|
| 953 | + $this->set_prop( 'is_editable', (int) $value ); |
|
| 954 | 954 | } |
| 955 | 955 | |
| 956 | 956 | /** |
| 957 | - * Sets if dynamic pricing is enabled. |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | - */ |
|
| 962 | - public function set_is_dynamic_pricing( $value ) { |
|
| 957 | + * Sets if dynamic pricing is enabled. |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 961 | + */ |
|
| 962 | + public function set_is_dynamic_pricing( $value ) { |
|
| 963 | 963 | $this->set_prop( 'is_dynamic_pricing', (int) $value ); |
| 964 | 964 | } |
| 965 | 965 | |
| 966 | 966 | /** |
| 967 | - * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param float $value minimum price. |
|
| 971 | - */ |
|
| 972 | - public function set_minimum_price( $value ) { |
|
| 967 | + * Sets the minimum price if dynamic pricing is enabled. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param float $value minimum price. |
|
| 971 | + */ |
|
| 972 | + public function set_minimum_price( $value ) { |
|
| 973 | 973 | $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) ); |
| 974 | 974 | } |
| 975 | 975 | |
| 976 | 976 | /** |
| 977 | - * Sets if this is a recurring item. |
|
| 978 | - * |
|
| 979 | - * @since 1.0.19 |
|
| 980 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | - */ |
|
| 982 | - public function set_is_recurring( $value ) { |
|
| 977 | + * Sets if this is a recurring item. |
|
| 978 | + * |
|
| 979 | + * @since 1.0.19 |
|
| 980 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 981 | + */ |
|
| 982 | + public function set_is_recurring( $value ) { |
|
| 983 | 983 | $this->set_prop( 'is_recurring', (int) $value ); |
| 984 | 984 | } |
| 985 | 985 | |
| 986 | 986 | /** |
| 987 | - * Set the recurring period. |
|
| 988 | - * |
|
| 989 | - * @since 1.0.19 |
|
| 990 | - * @param string $value new period. |
|
| 991 | - */ |
|
| 992 | - public function set_recurring_period( $value ) { |
|
| 987 | + * Set the recurring period. |
|
| 988 | + * |
|
| 989 | + * @since 1.0.19 |
|
| 990 | + * @param string $value new period. |
|
| 991 | + */ |
|
| 992 | + public function set_recurring_period( $value ) { |
|
| 993 | 993 | $this->set_prop( 'recurring_period', $value ); |
| 994 | 994 | } |
| 995 | 995 | |
| 996 | 996 | /** |
| 997 | - * Set the recurring interval. |
|
| 998 | - * |
|
| 999 | - * @since 1.0.19 |
|
| 1000 | - * @param int $value recurring interval. |
|
| 1001 | - */ |
|
| 1002 | - public function set_recurring_interval( $value ) { |
|
| 997 | + * Set the recurring interval. |
|
| 998 | + * |
|
| 999 | + * @since 1.0.19 |
|
| 1000 | + * @param int $value recurring interval. |
|
| 1001 | + */ |
|
| 1002 | + public function set_recurring_interval( $value ) { |
|
| 1003 | 1003 | return $this->set_prop( 'recurring_interval', (int) $value ); |
| 1004 | 1004 | } |
| 1005 | 1005 | |
| 1006 | 1006 | /** |
| 1007 | - * Get the recurring limit. |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int $value The recurring limit. |
|
| 1010 | - * @return int |
|
| 1011 | - */ |
|
| 1012 | - public function set_recurring_limit( $value ) { |
|
| 1007 | + * Get the recurring limit. |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int $value The recurring limit. |
|
| 1010 | + * @return int |
|
| 1011 | + */ |
|
| 1012 | + public function set_recurring_limit( $value ) { |
|
| 1013 | 1013 | $this->set_prop( 'recurring_limit', (int) $value ); |
| 1014 | 1014 | } |
| 1015 | 1015 | |
| 1016 | 1016 | /** |
| 1017 | - * Checks if we have a free trial. |
|
| 1018 | - * |
|
| 1019 | - * @since 1.0.19 |
|
| 1020 | - * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | - */ |
|
| 1022 | - public function set_is_free_trial( $value ) { |
|
| 1017 | + * Checks if we have a free trial. |
|
| 1018 | + * |
|
| 1019 | + * @since 1.0.19 |
|
| 1020 | + * @param int|bool $value whether or not it has a free trial. |
|
| 1021 | + */ |
|
| 1022 | + public function set_is_free_trial( $value ) { |
|
| 1023 | 1023 | $this->set_prop( 'is_free_trial', (int) $value ); |
| 1024 | 1024 | } |
| 1025 | 1025 | |
| 1026 | 1026 | /** |
| 1027 | - * Set the trial period. |
|
| 1028 | - * |
|
| 1029 | - * @since 1.0.19 |
|
| 1030 | - * @param string $value trial period. |
|
| 1031 | - */ |
|
| 1032 | - public function set_trial_period( $value ) { |
|
| 1027 | + * Set the trial period. |
|
| 1028 | + * |
|
| 1029 | + * @since 1.0.19 |
|
| 1030 | + * @param string $value trial period. |
|
| 1031 | + */ |
|
| 1032 | + public function set_trial_period( $value ) { |
|
| 1033 | 1033 | $this->set_prop( 'trial_period', $value ); |
| 1034 | 1034 | } |
| 1035 | 1035 | |
| 1036 | 1036 | /** |
| 1037 | - * Set the trial interval. |
|
| 1038 | - * |
|
| 1039 | - * @since 1.0.19 |
|
| 1040 | - * @param int $value trial interval. |
|
| 1041 | - */ |
|
| 1042 | - public function set_trial_interval( $value ) { |
|
| 1037 | + * Set the trial interval. |
|
| 1038 | + * |
|
| 1039 | + * @since 1.0.19 |
|
| 1040 | + * @param int $value trial interval. |
|
| 1041 | + */ |
|
| 1042 | + public function set_trial_interval( $value ) { |
|
| 1043 | 1043 | $this->set_prop( 'trial_interval', $value ); |
| 1044 | 1044 | } |
| 1045 | 1045 | |
@@ -1047,17 +1047,17 @@ discard block |
||
| 1047 | 1047 | * Create an item. For backwards compatibilty. |
| 1048 | 1048 | * |
| 1049 | 1049 | * @deprecated |
| 1050 | - * @return int item id |
|
| 1050 | + * @return int item id |
|
| 1051 | 1051 | */ |
| 1052 | 1052 | public function create( $data = array() ) { |
| 1053 | 1053 | |
| 1054 | - // Set the properties. |
|
| 1055 | - if ( is_array( $data ) ) { |
|
| 1056 | - $this->set_props( $data ); |
|
| 1057 | - } |
|
| 1054 | + // Set the properties. |
|
| 1055 | + if ( is_array( $data ) ) { |
|
| 1056 | + $this->set_props( $data ); |
|
| 1057 | + } |
|
| 1058 | 1058 | |
| 1059 | - // Save the item. |
|
| 1060 | - return $this->save(); |
|
| 1059 | + // Save the item. |
|
| 1060 | + return $this->save(); |
|
| 1061 | 1061 | |
| 1062 | 1062 | } |
| 1063 | 1063 | |
@@ -1065,7 +1065,7 @@ discard block |
||
| 1065 | 1065 | * Updates an item. For backwards compatibilty. |
| 1066 | 1066 | * |
| 1067 | 1067 | * @deprecated |
| 1068 | - * @return int item id |
|
| 1068 | + * @return int item id |
|
| 1069 | 1069 | */ |
| 1070 | 1070 | public function update( $data = array() ) { |
| 1071 | 1071 | return $this->create( $data ); |
@@ -1081,93 +1081,93 @@ discard block |
||
| 1081 | 1081 | */ |
| 1082 | 1082 | |
| 1083 | 1083 | /** |
| 1084 | - * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | - * |
|
| 1086 | - * @since 1.0.19 |
|
| 1087 | - * @return bool |
|
| 1088 | - */ |
|
| 1089 | - public function user_can_set_their_price() { |
|
| 1084 | + * Checks whether the item has enabled dynamic pricing. |
|
| 1085 | + * |
|
| 1086 | + * @since 1.0.19 |
|
| 1087 | + * @return bool |
|
| 1088 | + */ |
|
| 1089 | + public function user_can_set_their_price() { |
|
| 1090 | 1090 | return (bool) $this->get_is_dynamic_pricing(); |
| 1091 | - } |
|
| 1092 | - |
|
| 1093 | - /** |
|
| 1094 | - * Checks whether the item is recurring. |
|
| 1095 | - * |
|
| 1096 | - * @since 1.0.19 |
|
| 1097 | - * @return bool |
|
| 1098 | - */ |
|
| 1099 | - public function is_recurring() { |
|
| 1091 | + } |
|
| 1092 | + |
|
| 1093 | + /** |
|
| 1094 | + * Checks whether the item is recurring. |
|
| 1095 | + * |
|
| 1096 | + * @since 1.0.19 |
|
| 1097 | + * @return bool |
|
| 1098 | + */ |
|
| 1099 | + public function is_recurring() { |
|
| 1100 | 1100 | return (bool) $this->get_is_recurring(); |
| 1101 | 1101 | } |
| 1102 | 1102 | |
| 1103 | 1103 | /** |
| 1104 | - * Checks whether the item has a free trial. |
|
| 1105 | - * |
|
| 1106 | - * @since 1.0.19 |
|
| 1107 | - * @return bool |
|
| 1108 | - */ |
|
| 1104 | + * Checks whether the item has a free trial. |
|
| 1105 | + * |
|
| 1106 | + * @since 1.0.19 |
|
| 1107 | + * @return bool |
|
| 1108 | + */ |
|
| 1109 | 1109 | public function has_free_trial() { |
| 1110 | 1110 | $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false; |
| 1111 | 1111 | return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this ); |
| 1112 | 1112 | } |
| 1113 | 1113 | |
| 1114 | 1114 | /** |
| 1115 | - * Checks whether the item is free. |
|
| 1116 | - * |
|
| 1117 | - * @since 1.0.19 |
|
| 1118 | - * @return bool |
|
| 1119 | - */ |
|
| 1115 | + * Checks whether the item is free. |
|
| 1116 | + * |
|
| 1117 | + * @since 1.0.19 |
|
| 1118 | + * @return bool |
|
| 1119 | + */ |
|
| 1120 | 1120 | public function is_free() { |
| 1121 | 1121 | $is_free = $this->get_price() == 0; |
| 1122 | 1122 | return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this ); |
| 1123 | 1123 | } |
| 1124 | 1124 | |
| 1125 | 1125 | /** |
| 1126 | - * Checks the item status against a passed in status. |
|
| 1127 | - * |
|
| 1128 | - * @param array|string $status Status to check. |
|
| 1129 | - * @return bool |
|
| 1130 | - */ |
|
| 1131 | - public function has_status( $status ) { |
|
| 1132 | - $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | - return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1126 | + * Checks the item status against a passed in status. |
|
| 1127 | + * |
|
| 1128 | + * @param array|string $status Status to check. |
|
| 1129 | + * @return bool |
|
| 1130 | + */ |
|
| 1131 | + public function has_status( $status ) { |
|
| 1132 | + $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1133 | + return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1134 | 1134 | } |
| 1135 | 1135 | |
| 1136 | 1136 | /** |
| 1137 | - * Checks the item type against a passed in types. |
|
| 1138 | - * |
|
| 1139 | - * @param array|string $type Type to check. |
|
| 1140 | - * @return bool |
|
| 1141 | - */ |
|
| 1142 | - public function is_type( $type ) { |
|
| 1143 | - $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | - return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | - } |
|
| 1137 | + * Checks the item type against a passed in types. |
|
| 1138 | + * |
|
| 1139 | + * @param array|string $type Type to check. |
|
| 1140 | + * @return bool |
|
| 1141 | + */ |
|
| 1142 | + public function is_type( $type ) { |
|
| 1143 | + $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1144 | + return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1145 | + } |
|
| 1146 | 1146 | |
| 1147 | 1147 | /** |
| 1148 | - * Checks whether the item is editable. |
|
| 1149 | - * |
|
| 1150 | - * @since 1.0.19 |
|
| 1151 | - * @return bool |
|
| 1152 | - */ |
|
| 1148 | + * Checks whether the item is editable. |
|
| 1149 | + * |
|
| 1150 | + * @since 1.0.19 |
|
| 1151 | + * @return bool |
|
| 1152 | + */ |
|
| 1153 | 1153 | public function is_editable() { |
| 1154 | 1154 | $is_editable = $this->get_is_editable(); |
| 1155 | 1155 | return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this ); |
| 1156 | - } |
|
| 1156 | + } |
|
| 1157 | 1157 | |
| 1158 | - /** |
|
| 1159 | - * Returns an array of cart fees. |
|
| 1160 | - */ |
|
| 1161 | - public function get_fees() { |
|
| 1158 | + /** |
|
| 1159 | + * Returns an array of cart fees. |
|
| 1160 | + */ |
|
| 1161 | + public function get_fees() { |
|
| 1162 | 1162 | return array(); |
| 1163 | 1163 | } |
| 1164 | 1164 | |
| 1165 | 1165 | /** |
| 1166 | - * Checks whether the item is purchasable. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.19 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1166 | + * Checks whether the item is purchasable. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.19 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | 1171 | public function can_purchase() { |
| 1172 | 1172 | $can_purchase = $this->exists(); |
| 1173 | 1173 | |
@@ -1179,11 +1179,11 @@ discard block |
||
| 1179 | 1179 | } |
| 1180 | 1180 | |
| 1181 | 1181 | /** |
| 1182 | - * Checks whether the item supports dynamic pricing. |
|
| 1183 | - * |
|
| 1184 | - * @since 1.0.19 |
|
| 1185 | - * @return bool |
|
| 1186 | - */ |
|
| 1182 | + * Checks whether the item supports dynamic pricing. |
|
| 1183 | + * |
|
| 1184 | + * @since 1.0.19 |
|
| 1185 | + * @return bool |
|
| 1186 | + */ |
|
| 1187 | 1187 | public function supports_dynamic_pricing() { |
| 1188 | 1188 | return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
| 1189 | 1189 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | } |
| 9 | 9 | |
| 10 | 10 | if ( ! class_exists( 'WP_List_Table' ) ) { |
| 11 | - include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 11 | + include_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php'; |
|
| 12 | 12 | } |
| 13 | 13 | |
| 14 | 14 | /** |
@@ -16,468 +16,468 @@ discard block |
||
| 16 | 16 | */ |
| 17 | 17 | class WPInv_Subscriptions_List_Table extends WP_List_Table { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * URL of this page |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - * @since 1.0.19 |
|
| 24 | - */ |
|
| 25 | - public $base_url; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Query |
|
| 29 | - * |
|
| 30 | - * @var GetPaid_Subscriptions_Query |
|
| 31 | - * @since 1.0.19 |
|
| 32 | - */ |
|
| 33 | - public $query; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Total subscriptions |
|
| 37 | - * |
|
| 38 | - * @var string |
|
| 39 | - * @since 1.0.0 |
|
| 40 | - */ |
|
| 41 | - public $total_count; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Current status subscriptions |
|
| 45 | - * |
|
| 46 | - * @var string |
|
| 47 | - * @since 1.0.0 |
|
| 48 | - */ |
|
| 49 | - public $current_total_count; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Status counts |
|
| 53 | - * |
|
| 54 | - * @var array |
|
| 55 | - * @since 1.0.19 |
|
| 56 | - */ |
|
| 57 | - public $status_counts; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Number of results to show per page |
|
| 61 | - * |
|
| 62 | - * @var int |
|
| 63 | - * @since 1.0.0 |
|
| 64 | - */ |
|
| 65 | - public $per_page = 10; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Constructor function. |
|
| 69 | - */ |
|
| 70 | - public function __construct() { |
|
| 71 | - |
|
| 72 | - parent::__construct( |
|
| 73 | - array( |
|
| 74 | - 'singular' => 'subscription', |
|
| 75 | - 'plural' => 'subscriptions', |
|
| 76 | - ) |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - $this->process_bulk_action(); |
|
| 80 | - |
|
| 81 | - $this->prepare_query(); |
|
| 82 | - |
|
| 83 | - $this->base_url = remove_query_arg( 'status' ); |
|
| 84 | - |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Prepares the display query |
|
| 89 | - */ |
|
| 90 | - public function prepare_query() { |
|
| 91 | - |
|
| 92 | - // Prepare query args. |
|
| 93 | - $query = array( |
|
| 94 | - 'number' => $this->per_page, |
|
| 95 | - 'paged' => $this->get_paged(), |
|
| 96 | - 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? sanitize_text_field( $_GET['status'] ) : 'all', |
|
| 97 | - 'orderby' => ( isset( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'id', |
|
| 98 | - 'order' => ( isset( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'DESC', |
|
| 99 | - 'customer_in' => $this->get_user_in(), |
|
| 100 | - ); |
|
| 101 | - |
|
| 102 | - if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) { |
|
| 103 | - $this->total_count = 0; |
|
| 104 | - $this->current_total_count = 0; |
|
| 105 | - $this->items = array(); |
|
| 106 | - $this->status_counts = array(); |
|
| 107 | - return; |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - // Prepare class properties. |
|
| 111 | - $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 112 | - $this->total_count = $this->query->get_total(); |
|
| 113 | - $this->current_total_count = $this->query->get_total(); |
|
| 114 | - $this->items = $this->query->get_results(); |
|
| 115 | - $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 116 | - |
|
| 117 | - if ( 'all' != $query['status'] ) { |
|
| 118 | - unset( $query['status'] ); |
|
| 119 | - $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Get user in. |
|
| 126 | - * |
|
| 127 | - */ |
|
| 128 | - public function get_user_in() { |
|
| 129 | - |
|
| 130 | - // Abort if no user. |
|
| 131 | - if ( empty( $_GET['s'] ) ) { |
|
| 132 | - return null; |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - // Or invalid user. |
|
| 136 | - $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) ); |
|
| 137 | - |
|
| 138 | - if ( empty( $user ) ) { |
|
| 139 | - return null; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - // Search matching users. |
|
| 143 | - $user = '*' . $user . '*'; |
|
| 144 | - $users = new WP_User_Query( |
|
| 145 | - array( |
|
| 146 | - 'fields' => 'ID', |
|
| 147 | - 'search' => $user, |
|
| 148 | - 'count_total' => false, |
|
| 149 | - ) |
|
| 150 | - ); |
|
| 151 | - |
|
| 152 | - return $users->get_results(); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Gets the list of views available on this table. |
|
| 157 | - * |
|
| 158 | - * The format is an associative array: |
|
| 159 | - * - `'id' => 'link'` |
|
| 160 | - * |
|
| 161 | - * @since 1.0.0 |
|
| 162 | - * |
|
| 163 | - * @return array |
|
| 164 | - */ |
|
| 165 | - public function get_views() { |
|
| 166 | - |
|
| 167 | - $current = isset( $_GET['status'] ) ? sanitize_text_field( $_GET['status'] ) : 'all'; |
|
| 168 | - $views = array( |
|
| 169 | - |
|
| 170 | - 'all' => sprintf( |
|
| 171 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 172 | - esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 173 | - $current === 'all' ? ' class="current"' : '', |
|
| 174 | - __( 'All', 'invoicing' ), |
|
| 175 | - $this->total_count |
|
| 176 | - ), |
|
| 177 | - |
|
| 178 | - ); |
|
| 179 | - |
|
| 180 | - foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 181 | - |
|
| 182 | - $views[ $status ] = sprintf( |
|
| 183 | - '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 184 | - esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 185 | - $current === $status ? ' class="current"' : '', |
|
| 186 | - esc_html( getpaid_get_subscription_status_label( $status ) ), |
|
| 187 | - $count |
|
| 188 | - ); |
|
| 189 | - |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - return $views; |
|
| 193 | - |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * Render most columns |
|
| 198 | - * |
|
| 199 | - * @access private |
|
| 200 | - * @since 1.0.0 |
|
| 201 | - * @return string |
|
| 202 | - */ |
|
| 203 | - public function column_default( $item, $column_name ) { |
|
| 204 | - return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * This is how checkbox column renders. |
|
| 209 | - * |
|
| 210 | - * @param WPInv_Subscription $item |
|
| 211 | - * @return string |
|
| 212 | - */ |
|
| 213 | - public function column_cb( $item ) { |
|
| 214 | - return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Status column |
|
| 219 | - * |
|
| 220 | - * @param WPInv_Subscription $item |
|
| 221 | - * @since 1.0.0 |
|
| 222 | - * @return string |
|
| 223 | - */ |
|
| 224 | - public function column_status( $item ) { |
|
| 225 | - return $item->get_status_label_html(); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - /** |
|
| 229 | - * Subscription column |
|
| 230 | - * |
|
| 231 | - * @param WPInv_Subscription $item |
|
| 232 | - * @since 1.0.0 |
|
| 233 | - * @return string |
|
| 234 | - */ |
|
| 235 | - public function column_subscription( $item ) { |
|
| 236 | - |
|
| 237 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 238 | - |
|
| 239 | - $user = get_userdata( $item->get_customer_id() ); |
|
| 240 | - if ( $user ) { |
|
| 241 | - |
|
| 242 | - $username = sprintf( |
|
| 243 | - '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 244 | - absint( $user->ID ), |
|
| 245 | - ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 246 | - ); |
|
| 247 | - |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 251 | - $column_content = sprintf( |
|
| 252 | - _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 253 | - '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 254 | - '<strong>' . esc_attr( $item->get_id() ) . '</strong>', |
|
| 19 | + /** |
|
| 20 | + * URL of this page |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + * @since 1.0.19 |
|
| 24 | + */ |
|
| 25 | + public $base_url; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Query |
|
| 29 | + * |
|
| 30 | + * @var GetPaid_Subscriptions_Query |
|
| 31 | + * @since 1.0.19 |
|
| 32 | + */ |
|
| 33 | + public $query; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Total subscriptions |
|
| 37 | + * |
|
| 38 | + * @var string |
|
| 39 | + * @since 1.0.0 |
|
| 40 | + */ |
|
| 41 | + public $total_count; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Current status subscriptions |
|
| 45 | + * |
|
| 46 | + * @var string |
|
| 47 | + * @since 1.0.0 |
|
| 48 | + */ |
|
| 49 | + public $current_total_count; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Status counts |
|
| 53 | + * |
|
| 54 | + * @var array |
|
| 55 | + * @since 1.0.19 |
|
| 56 | + */ |
|
| 57 | + public $status_counts; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Number of results to show per page |
|
| 61 | + * |
|
| 62 | + * @var int |
|
| 63 | + * @since 1.0.0 |
|
| 64 | + */ |
|
| 65 | + public $per_page = 10; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Constructor function. |
|
| 69 | + */ |
|
| 70 | + public function __construct() { |
|
| 71 | + |
|
| 72 | + parent::__construct( |
|
| 73 | + array( |
|
| 74 | + 'singular' => 'subscription', |
|
| 75 | + 'plural' => 'subscriptions', |
|
| 76 | + ) |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + $this->process_bulk_action(); |
|
| 80 | + |
|
| 81 | + $this->prepare_query(); |
|
| 82 | + |
|
| 83 | + $this->base_url = remove_query_arg( 'status' ); |
|
| 84 | + |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Prepares the display query |
|
| 89 | + */ |
|
| 90 | + public function prepare_query() { |
|
| 91 | + |
|
| 92 | + // Prepare query args. |
|
| 93 | + $query = array( |
|
| 94 | + 'number' => $this->per_page, |
|
| 95 | + 'paged' => $this->get_paged(), |
|
| 96 | + 'status' => ( isset( $_GET['status'] ) && array_key_exists( $_GET['status'], getpaid_get_subscription_statuses() ) ) ? sanitize_text_field( $_GET['status'] ) : 'all', |
|
| 97 | + 'orderby' => ( isset( $_GET['orderby'] ) ) ? sanitize_text_field( $_GET['orderby'] ) : 'id', |
|
| 98 | + 'order' => ( isset( $_GET['order'] ) ) ? sanitize_text_field( $_GET['order'] ) : 'DESC', |
|
| 99 | + 'customer_in' => $this->get_user_in(), |
|
| 100 | + ); |
|
| 101 | + |
|
| 102 | + if ( is_array( $query['customer_in'] ) && empty( $query['customer_in'] ) ) { |
|
| 103 | + $this->total_count = 0; |
|
| 104 | + $this->current_total_count = 0; |
|
| 105 | + $this->items = array(); |
|
| 106 | + $this->status_counts = array(); |
|
| 107 | + return; |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + // Prepare class properties. |
|
| 111 | + $this->query = new GetPaid_Subscriptions_Query( $query ); |
|
| 112 | + $this->total_count = $this->query->get_total(); |
|
| 113 | + $this->current_total_count = $this->query->get_total(); |
|
| 114 | + $this->items = $this->query->get_results(); |
|
| 115 | + $this->status_counts = getpaid_get_subscription_status_counts( $query ); |
|
| 116 | + |
|
| 117 | + if ( 'all' != $query['status'] ) { |
|
| 118 | + unset( $query['status'] ); |
|
| 119 | + $this->total_count = getpaid_get_subscriptions( $query, 'count' ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Get user in. |
|
| 126 | + * |
|
| 127 | + */ |
|
| 128 | + public function get_user_in() { |
|
| 129 | + |
|
| 130 | + // Abort if no user. |
|
| 131 | + if ( empty( $_GET['s'] ) ) { |
|
| 132 | + return null; |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + // Or invalid user. |
|
| 136 | + $user = wp_unslash( sanitize_text_field( $_REQUEST['s'] ) ); |
|
| 137 | + |
|
| 138 | + if ( empty( $user ) ) { |
|
| 139 | + return null; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + // Search matching users. |
|
| 143 | + $user = '*' . $user . '*'; |
|
| 144 | + $users = new WP_User_Query( |
|
| 145 | + array( |
|
| 146 | + 'fields' => 'ID', |
|
| 147 | + 'search' => $user, |
|
| 148 | + 'count_total' => false, |
|
| 149 | + ) |
|
| 150 | + ); |
|
| 151 | + |
|
| 152 | + return $users->get_results(); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Gets the list of views available on this table. |
|
| 157 | + * |
|
| 158 | + * The format is an associative array: |
|
| 159 | + * - `'id' => 'link'` |
|
| 160 | + * |
|
| 161 | + * @since 1.0.0 |
|
| 162 | + * |
|
| 163 | + * @return array |
|
| 164 | + */ |
|
| 165 | + public function get_views() { |
|
| 166 | + |
|
| 167 | + $current = isset( $_GET['status'] ) ? sanitize_text_field( $_GET['status'] ) : 'all'; |
|
| 168 | + $views = array( |
|
| 169 | + |
|
| 170 | + 'all' => sprintf( |
|
| 171 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 172 | + esc_url( add_query_arg( 'status', false, $this->base_url ) ), |
|
| 173 | + $current === 'all' ? ' class="current"' : '', |
|
| 174 | + __( 'All', 'invoicing' ), |
|
| 175 | + $this->total_count |
|
| 176 | + ), |
|
| 177 | + |
|
| 178 | + ); |
|
| 179 | + |
|
| 180 | + foreach ( array_filter( $this->status_counts ) as $status => $count ) { |
|
| 181 | + |
|
| 182 | + $views[ $status ] = sprintf( |
|
| 183 | + '<a href="%s" %s>%s <span class="count">(%d)</span></a>', |
|
| 184 | + esc_url( add_query_arg( 'status', urlencode( $status ), $this->base_url ) ), |
|
| 185 | + $current === $status ? ' class="current"' : '', |
|
| 186 | + esc_html( getpaid_get_subscription_status_label( $status ) ), |
|
| 187 | + $count |
|
| 188 | + ); |
|
| 189 | + |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + return $views; |
|
| 193 | + |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * Render most columns |
|
| 198 | + * |
|
| 199 | + * @access private |
|
| 200 | + * @since 1.0.0 |
|
| 201 | + * @return string |
|
| 202 | + */ |
|
| 203 | + public function column_default( $item, $column_name ) { |
|
| 204 | + return apply_filters( "getpaid_subscriptions_table_column_$column_name", $item->$column_name ); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * This is how checkbox column renders. |
|
| 209 | + * |
|
| 210 | + * @param WPInv_Subscription $item |
|
| 211 | + * @return string |
|
| 212 | + */ |
|
| 213 | + public function column_cb( $item ) { |
|
| 214 | + return sprintf( '<input type="checkbox" name="id[]" value="%s" />', esc_html( $item->get_id() ) ); |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Status column |
|
| 219 | + * |
|
| 220 | + * @param WPInv_Subscription $item |
|
| 221 | + * @since 1.0.0 |
|
| 222 | + * @return string |
|
| 223 | + */ |
|
| 224 | + public function column_status( $item ) { |
|
| 225 | + return $item->get_status_label_html(); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + /** |
|
| 229 | + * Subscription column |
|
| 230 | + * |
|
| 231 | + * @param WPInv_Subscription $item |
|
| 232 | + * @since 1.0.0 |
|
| 233 | + * @return string |
|
| 234 | + */ |
|
| 235 | + public function column_subscription( $item ) { |
|
| 236 | + |
|
| 237 | + $username = __( '(Missing User)', 'invoicing' ); |
|
| 238 | + |
|
| 239 | + $user = get_userdata( $item->get_customer_id() ); |
|
| 240 | + if ( $user ) { |
|
| 241 | + |
|
| 242 | + $username = sprintf( |
|
| 243 | + '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 244 | + absint( $user->ID ), |
|
| 245 | + ! empty( $user->display_name ) ? esc_html( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 246 | + ); |
|
| 247 | + |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + // translators: $1: is opening link, $2: is subscription id number, $3: is closing link tag, $4: is user's name |
|
| 251 | + $column_content = sprintf( |
|
| 252 | + _x( '%1$s#%2$s%3$s for %4$s', 'Subscription title on admin table. (e.g.: #211 for John Doe)', 'invoicing' ), |
|
| 253 | + '<a href="' . esc_url( admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $item->get_id() ) ) ) . '">', |
|
| 254 | + '<strong>' . esc_attr( $item->get_id() ) . '</strong>', |
|
| 255 | 255 | '</a>', |
| 256 | - $username |
|
| 257 | - ); |
|
| 258 | - |
|
| 259 | - $row_actions = array(); |
|
| 260 | - |
|
| 261 | - // View subscription. |
|
| 262 | - $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ) ); |
|
| 263 | - $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 264 | - |
|
| 265 | - // View invoice. |
|
| 266 | - $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 267 | - |
|
| 268 | - if ( ! empty( $invoice ) ) { |
|
| 269 | - $invoice_url = get_edit_post_link( $invoice ); |
|
| 270 | - $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - $delete_url = esc_url( |
|
| 274 | - wp_nonce_url( |
|
| 275 | - add_query_arg( |
|
| 276 | - array( |
|
| 277 | - 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 278 | - 'id' => $item->get_id(), |
|
| 279 | - ) |
|
| 280 | - ), |
|
| 281 | - 'getpaid-nonce', |
|
| 282 | - 'getpaid-nonce' |
|
| 283 | - ) |
|
| 284 | - ); |
|
| 285 | - $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 286 | - |
|
| 287 | - $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 288 | - |
|
| 289 | - return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - /** |
|
| 293 | - * Renewal date column |
|
| 294 | - * |
|
| 295 | - * @param WPInv_Subscription $item |
|
| 296 | - * @since 1.0.0 |
|
| 297 | - * @return string |
|
| 298 | - */ |
|
| 299 | - public function column_renewal_date( $item ) { |
|
| 300 | - return getpaid_format_date_value( $item->get_expiration() ); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - /** |
|
| 304 | - * Start date column |
|
| 305 | - * |
|
| 306 | - * @param WPInv_Subscription $item |
|
| 307 | - * @since 1.0.0 |
|
| 308 | - * @return string |
|
| 309 | - */ |
|
| 310 | - public function column_start_date( $item ) { |
|
| 311 | - |
|
| 312 | - $gateway = $item->get_parent_invoice()->get_gateway_title(); |
|
| 313 | - |
|
| 314 | - if ( empty( $gateway ) ) { |
|
| 315 | - return getpaid_format_date_value( $item->get_date_created() ); |
|
| 316 | - } |
|
| 317 | - |
|
| 318 | - $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item ); |
|
| 319 | - if ( ! empty( $url ) ) { |
|
| 320 | - |
|
| 321 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 322 | - __( 'Via %s', 'invoicing' ), |
|
| 323 | - '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>' |
|
| 324 | - ); |
|
| 325 | - |
|
| 326 | - } |
|
| 327 | - |
|
| 328 | - return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 329 | - __( 'Via %s', 'invoicing' ), |
|
| 330 | - '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>' |
|
| 331 | - ); |
|
| 332 | - |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - /** |
|
| 336 | - * Amount column |
|
| 337 | - * |
|
| 338 | - * @param WPInv_Subscription $item |
|
| 339 | - * @since 1.0.19 |
|
| 340 | - * @return string |
|
| 341 | - */ |
|
| 342 | - public static function column_amount( $item ) { |
|
| 343 | - $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 344 | - return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * Billing Times column |
|
| 349 | - * |
|
| 350 | - * @param WPInv_Subscription $item |
|
| 351 | - * @since 1.0.0 |
|
| 352 | - * @return string |
|
| 353 | - */ |
|
| 354 | - public function column_renewals( $item ) { |
|
| 355 | - $max_bills = $item->get_bill_times(); |
|
| 356 | - return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? '∞' : $max_bills ); |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * Product ID column |
|
| 361 | - * |
|
| 362 | - * @param WPInv_Subscription $item |
|
| 363 | - * @since 1.0.0 |
|
| 364 | - * @return string |
|
| 365 | - */ |
|
| 366 | - public function column_item( $item ) { |
|
| 367 | - $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 368 | - |
|
| 369 | - if ( empty( $subscription_group ) ) { |
|
| 370 | - return $this->generate_item_markup( $item->get_product_id() ); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 374 | - return implode( ' | ', $markup ); |
|
| 375 | - |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - /** |
|
| 379 | - * Generates the items markup. |
|
| 380 | - * |
|
| 381 | - * @param int $item_id |
|
| 382 | - * @since 1.0.0 |
|
| 383 | - * @return string |
|
| 384 | - */ |
|
| 385 | - public static function generate_item_markup( $item_id ) { |
|
| 386 | - $item = get_post( $item_id ); |
|
| 387 | - |
|
| 388 | - if ( ! empty( $item ) ) { |
|
| 389 | - $link = get_edit_post_link( $item ); |
|
| 390 | - $link = esc_url( $link ); |
|
| 391 | - $name = esc_html( get_the_title( $item ) ); |
|
| 392 | - return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 393 | - } else { |
|
| 394 | - return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - /** |
|
| 400 | - * Retrieve the current page number |
|
| 401 | - * |
|
| 402 | - * @return int |
|
| 403 | - */ |
|
| 404 | - public function get_paged() { |
|
| 405 | - return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - /** |
|
| 409 | - * Setup the final data for the table |
|
| 410 | - * |
|
| 411 | - */ |
|
| 412 | - public function prepare_items() { |
|
| 413 | - |
|
| 414 | - $columns = $this->get_columns(); |
|
| 415 | - $hidden = array(); |
|
| 416 | - $sortable = $this->get_sortable_columns(); |
|
| 417 | - |
|
| 418 | - $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 419 | - |
|
| 420 | - $this->set_pagination_args( |
|
| 421 | - array( |
|
| 422 | - 'total_items' => $this->current_total_count, |
|
| 423 | - 'per_page' => $this->per_page, |
|
| 424 | - 'total_pages' => ceil( $this->current_total_count / $this->per_page ), |
|
| 425 | - ) |
|
| 426 | - ); |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - /** |
|
| 430 | - * Table columns |
|
| 431 | - * |
|
| 432 | - * @return array |
|
| 433 | - */ |
|
| 434 | - public function get_columns() { |
|
| 435 | - $columns = array( |
|
| 436 | - 'cb' => '<input type="checkbox" />', |
|
| 437 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 438 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 439 | - 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 440 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 441 | - 'item' => __( 'Items', 'invoicing' ), |
|
| 442 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 443 | - ); |
|
| 444 | - |
|
| 445 | - return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - /** |
|
| 449 | - * Sortable table columns. |
|
| 450 | - * |
|
| 451 | - * @return array |
|
| 452 | - */ |
|
| 453 | - public function get_sortable_columns() { |
|
| 454 | - $sortable = array( |
|
| 455 | - 'subscription' => array( 'id', true ), |
|
| 456 | - 'start_date' => array( 'created', true ), |
|
| 457 | - 'renewal_date' => array( 'expiration', true ), |
|
| 458 | - 'renewals' => array( 'bill_times', true ), |
|
| 459 | - 'item' => array( 'product_id', true ), |
|
| 460 | - 'status' => array( 'status', true ), |
|
| 461 | - ); |
|
| 462 | - |
|
| 463 | - return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Whether the table has items to display or not |
|
| 468 | - * |
|
| 469 | - * @return bool |
|
| 470 | - */ |
|
| 471 | - public function has_items() { |
|
| 472 | - return ! empty( $this->current_total_count ); |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - /** |
|
| 476 | - * Processes bulk actions. |
|
| 477 | - * |
|
| 478 | - */ |
|
| 479 | - public function process_bulk_action() { |
|
| 480 | - |
|
| 481 | - } |
|
| 256 | + $username |
|
| 257 | + ); |
|
| 258 | + |
|
| 259 | + $row_actions = array(); |
|
| 260 | + |
|
| 261 | + // View subscription. |
|
| 262 | + $view_url = esc_url( add_query_arg( 'id', $item->get_id(), admin_url( 'admin.php?page=wpinv-subscriptions' ) ) ); |
|
| 263 | + $row_actions['view'] = '<a href="' . $view_url . '">' . __( 'View Subscription', 'invoicing' ) . '</a>'; |
|
| 264 | + |
|
| 265 | + // View invoice. |
|
| 266 | + $invoice = get_post( $item->get_parent_invoice_id() ); |
|
| 267 | + |
|
| 268 | + if ( ! empty( $invoice ) ) { |
|
| 269 | + $invoice_url = get_edit_post_link( $invoice ); |
|
| 270 | + $row_actions['invoice'] = '<a href="' . $invoice_url . '">' . __( 'View Invoice', 'invoicing' ) . '</a>'; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + $delete_url = esc_url( |
|
| 274 | + wp_nonce_url( |
|
| 275 | + add_query_arg( |
|
| 276 | + array( |
|
| 277 | + 'getpaid-admin-action' => 'subscription_manual_delete', |
|
| 278 | + 'id' => $item->get_id(), |
|
| 279 | + ) |
|
| 280 | + ), |
|
| 281 | + 'getpaid-nonce', |
|
| 282 | + 'getpaid-nonce' |
|
| 283 | + ) |
|
| 284 | + ); |
|
| 285 | + $row_actions['delete'] = '<a class="text-danger" href="' . $delete_url . '">' . __( 'Delete Subscription', 'invoicing' ) . '</a>'; |
|
| 286 | + |
|
| 287 | + $row_actions = $this->row_actions( apply_filters( 'getpaid_subscription_table_row_actions', $row_actions, $item ) ); |
|
| 288 | + |
|
| 289 | + return "<strong>$column_content</strong>" . $this->column_amount( $item ) . $row_actions; |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + /** |
|
| 293 | + * Renewal date column |
|
| 294 | + * |
|
| 295 | + * @param WPInv_Subscription $item |
|
| 296 | + * @since 1.0.0 |
|
| 297 | + * @return string |
|
| 298 | + */ |
|
| 299 | + public function column_renewal_date( $item ) { |
|
| 300 | + return getpaid_format_date_value( $item->get_expiration() ); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + /** |
|
| 304 | + * Start date column |
|
| 305 | + * |
|
| 306 | + * @param WPInv_Subscription $item |
|
| 307 | + * @since 1.0.0 |
|
| 308 | + * @return string |
|
| 309 | + */ |
|
| 310 | + public function column_start_date( $item ) { |
|
| 311 | + |
|
| 312 | + $gateway = $item->get_parent_invoice()->get_gateway_title(); |
|
| 313 | + |
|
| 314 | + if ( empty( $gateway ) ) { |
|
| 315 | + return getpaid_format_date_value( $item->get_date_created() ); |
|
| 316 | + } |
|
| 317 | + |
|
| 318 | + $url = apply_filters( 'getpaid_remote_subscription_profile_url', '', $item ); |
|
| 319 | + if ( ! empty( $url ) ) { |
|
| 320 | + |
|
| 321 | + return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 322 | + __( 'Via %s', 'invoicing' ), |
|
| 323 | + '<strong><a href="' . esc_url( $url ) . '" target="_blank">' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</a></strong>' |
|
| 324 | + ); |
|
| 325 | + |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + return getpaid_format_date_value( $item->get_date_created() ) . '<br>' . sprintf( |
|
| 329 | + __( 'Via %s', 'invoicing' ), |
|
| 330 | + '<strong>' . esc_html( $item->get_parent_invoice()->get_gateway_title() ) . '</strong>' |
|
| 331 | + ); |
|
| 332 | + |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + /** |
|
| 336 | + * Amount column |
|
| 337 | + * |
|
| 338 | + * @param WPInv_Subscription $item |
|
| 339 | + * @since 1.0.19 |
|
| 340 | + * @return string |
|
| 341 | + */ |
|
| 342 | + public static function column_amount( $item ) { |
|
| 343 | + $amount = getpaid_get_formatted_subscription_amount( $item ); |
|
| 344 | + return "<span class='text-muted form-text mt-2 mb-2'>$amount</span>"; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * Billing Times column |
|
| 349 | + * |
|
| 350 | + * @param WPInv_Subscription $item |
|
| 351 | + * @since 1.0.0 |
|
| 352 | + * @return string |
|
| 353 | + */ |
|
| 354 | + public function column_renewals( $item ) { |
|
| 355 | + $max_bills = $item->get_bill_times(); |
|
| 356 | + return $item->get_times_billed() . ' / ' . ( empty( $max_bills ) ? '∞' : $max_bills ); |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * Product ID column |
|
| 361 | + * |
|
| 362 | + * @param WPInv_Subscription $item |
|
| 363 | + * @since 1.0.0 |
|
| 364 | + * @return string |
|
| 365 | + */ |
|
| 366 | + public function column_item( $item ) { |
|
| 367 | + $subscription_group = getpaid_get_invoice_subscription_group( $item->get_parent_invoice_id(), $item->get_id() ); |
|
| 368 | + |
|
| 369 | + if ( empty( $subscription_group ) ) { |
|
| 370 | + return $this->generate_item_markup( $item->get_product_id() ); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + $markup = array_map( array( $this, 'generate_item_markup' ), array_keys( $subscription_group['items'] ) ); |
|
| 374 | + return implode( ' | ', $markup ); |
|
| 375 | + |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + /** |
|
| 379 | + * Generates the items markup. |
|
| 380 | + * |
|
| 381 | + * @param int $item_id |
|
| 382 | + * @since 1.0.0 |
|
| 383 | + * @return string |
|
| 384 | + */ |
|
| 385 | + public static function generate_item_markup( $item_id ) { |
|
| 386 | + $item = get_post( $item_id ); |
|
| 387 | + |
|
| 388 | + if ( ! empty( $item ) ) { |
|
| 389 | + $link = get_edit_post_link( $item ); |
|
| 390 | + $link = esc_url( $link ); |
|
| 391 | + $name = esc_html( get_the_title( $item ) ); |
|
| 392 | + return wpinv_current_user_can_manage_invoicing() ? "<a href='$link'>$name</a>" : $name; |
|
| 393 | + } else { |
|
| 394 | + return sprintf( __( 'Item #%s', 'invoicing' ), $item_id ); |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + /** |
|
| 400 | + * Retrieve the current page number |
|
| 401 | + * |
|
| 402 | + * @return int |
|
| 403 | + */ |
|
| 404 | + public function get_paged() { |
|
| 405 | + return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1; |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + /** |
|
| 409 | + * Setup the final data for the table |
|
| 410 | + * |
|
| 411 | + */ |
|
| 412 | + public function prepare_items() { |
|
| 413 | + |
|
| 414 | + $columns = $this->get_columns(); |
|
| 415 | + $hidden = array(); |
|
| 416 | + $sortable = $this->get_sortable_columns(); |
|
| 417 | + |
|
| 418 | + $this->_column_headers = array( $columns, $hidden, $sortable ); |
|
| 419 | + |
|
| 420 | + $this->set_pagination_args( |
|
| 421 | + array( |
|
| 422 | + 'total_items' => $this->current_total_count, |
|
| 423 | + 'per_page' => $this->per_page, |
|
| 424 | + 'total_pages' => ceil( $this->current_total_count / $this->per_page ), |
|
| 425 | + ) |
|
| 426 | + ); |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + /** |
|
| 430 | + * Table columns |
|
| 431 | + * |
|
| 432 | + * @return array |
|
| 433 | + */ |
|
| 434 | + public function get_columns() { |
|
| 435 | + $columns = array( |
|
| 436 | + 'cb' => '<input type="checkbox" />', |
|
| 437 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 438 | + 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 439 | + 'renewal_date' => __( 'Next Payment', 'invoicing' ), |
|
| 440 | + 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 441 | + 'item' => __( 'Items', 'invoicing' ), |
|
| 442 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 443 | + ); |
|
| 444 | + |
|
| 445 | + return apply_filters( 'manage_getpaid_subscriptions_table_columns', $columns ); |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + /** |
|
| 449 | + * Sortable table columns. |
|
| 450 | + * |
|
| 451 | + * @return array |
|
| 452 | + */ |
|
| 453 | + public function get_sortable_columns() { |
|
| 454 | + $sortable = array( |
|
| 455 | + 'subscription' => array( 'id', true ), |
|
| 456 | + 'start_date' => array( 'created', true ), |
|
| 457 | + 'renewal_date' => array( 'expiration', true ), |
|
| 458 | + 'renewals' => array( 'bill_times', true ), |
|
| 459 | + 'item' => array( 'product_id', true ), |
|
| 460 | + 'status' => array( 'status', true ), |
|
| 461 | + ); |
|
| 462 | + |
|
| 463 | + return apply_filters( 'manage_getpaid_subscriptions_sortable_table_columns', $sortable ); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Whether the table has items to display or not |
|
| 468 | + * |
|
| 469 | + * @return bool |
|
| 470 | + */ |
|
| 471 | + public function has_items() { |
|
| 472 | + return ! empty( $this->current_total_count ); |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + /** |
|
| 476 | + * Processes bulk actions. |
|
| 477 | + * |
|
| 478 | + */ |
|
| 479 | + public function process_bulk_action() { |
|
| 480 | + |
|
| 481 | + } |
|
| 482 | 482 | |
| 483 | 483 | } |
@@ -44,9 +44,9 @@ discard block |
||
| 44 | 44 | <?php |
| 45 | 45 | |
| 46 | 46 | if ( wpinv_is_gateway_active( $id ) ) { |
| 47 | - echo "<i class='text-success fa fa-check'></i>"; |
|
| 47 | + echo "<i class='text-success fa fa-check'></i>"; |
|
| 48 | 48 | } else { |
| 49 | - echo "<i class='text-dark fa fa-times'></i>"; |
|
| 49 | + echo "<i class='text-dark fa fa-times'></i>"; |
|
| 50 | 50 | } |
| 51 | 51 | |
| 52 | 52 | ?> |
@@ -58,9 +58,9 @@ discard block |
||
| 58 | 58 | $supports = apply_filters( 'getapid_gateway_supports_subscription', $supports, $id ); |
| 59 | 59 | |
| 60 | 60 | if ( $supports ) { |
| 61 | - echo "<i class='text-success fa fa-check'></i>"; |
|
| 61 | + echo "<i class='text-success fa fa-check'></i>"; |
|
| 62 | 62 | } else { |
| 63 | - echo "<i class='text-dark fa fa-times'></i>"; |
|
| 63 | + echo "<i class='text-dark fa fa-times'></i>"; |
|
| 64 | 64 | } |
| 65 | 65 | |
| 66 | 66 | ?> |
@@ -27,7 +27,7 @@ |
||
| 27 | 27 | <input type="checkbox" name="plugins[<?php echo esc_attr( $plugin['slug'] ); ?>]" value="<?php echo esc_attr( $plugin['file'] ); ?>" class="custom-control-input" |
| 28 | 28 | <?php |
| 29 | 29 | if ( is_plugin_active( $plugin['slug'] ) ) { |
| 30 | - echo 'checked';} |
|
| 30 | + echo 'checked';} |
|
| 31 | 31 | ?> |
| 32 | 32 | > |
| 33 | 33 | <label class="custom-control-label" for="ac-setting-updates"></label> |
@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | if ( ! defined( 'ABSPATH' ) ) { |
| 10 | - exit; // Exit if accessed directly |
|
| 10 | + exit; // Exit if accessed directly |
|
| 11 | 11 | } |
| 12 | 12 | |
| 13 | 13 | /** |
@@ -15,22 +15,22 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Meta_Box_Invoice_Shipping_Address { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Output the metabox. |
|
| 20 | - * |
|
| 21 | - * @param WP_Post $post |
|
| 22 | - */ |
|
| 23 | - public static function output( $post ) { |
|
| 18 | + /** |
|
| 19 | + * Output the metabox. |
|
| 20 | + * |
|
| 21 | + * @param WP_Post $post |
|
| 22 | + */ |
|
| 23 | + public static function output( $post ) { |
|
| 24 | 24 | |
| 25 | - // Retrieve shipping address. |
|
| 26 | - $shipping_address = get_post_meta( $post->ID, 'shipping_address', true ); |
|
| 25 | + // Retrieve shipping address. |
|
| 26 | + $shipping_address = get_post_meta( $post->ID, 'shipping_address', true ); |
|
| 27 | 27 | |
| 28 | - // Abort if it is invalid. |
|
| 29 | - if ( ! is_array( $shipping_address ) ) { |
|
| 30 | - return; |
|
| 31 | - } |
|
| 28 | + // Abort if it is invalid. |
|
| 29 | + if ( ! is_array( $shipping_address ) ) { |
|
| 30 | + return; |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | - ?> |
|
| 33 | + ?> |
|
| 34 | 34 | |
| 35 | 35 | <div class="bsui"> |
| 36 | 36 | |
@@ -68,31 +68,31 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | <?php |
| 70 | 70 | |
| 71 | - } |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Prepares a value. |
|
| 75 | - * |
|
| 76 | - * @param array $address |
|
| 77 | - * @param string $key |
|
| 78 | - * @return string |
|
| 79 | - */ |
|
| 80 | - public static function prepare_for_display( $address, $key ) { |
|
| 73 | + /** |
|
| 74 | + * Prepares a value. |
|
| 75 | + * |
|
| 76 | + * @param array $address |
|
| 77 | + * @param string $key |
|
| 78 | + * @return string |
|
| 79 | + */ |
|
| 80 | + public static function prepare_for_display( $address, $key ) { |
|
| 81 | 81 | |
| 82 | - // Prepare the value. |
|
| 83 | - $value = $address[ $key ]; |
|
| 82 | + // Prepare the value. |
|
| 83 | + $value = $address[ $key ]; |
|
| 84 | 84 | |
| 85 | - if ( $key == 'country' ) { |
|
| 86 | - $value = wpinv_country_name( $value ); |
|
| 87 | - } |
|
| 85 | + if ( $key == 'country' ) { |
|
| 86 | + $value = wpinv_country_name( $value ); |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - if ( $key == 'state' ) { |
|
| 90 | - $country = isset( $address['country'] ) ? $address['country'] : wpinv_get_default_country(); |
|
| 91 | - $value = wpinv_state_name( $value, $country ); |
|
| 92 | - } |
|
| 89 | + if ( $key == 'state' ) { |
|
| 90 | + $country = isset( $address['country'] ) ? $address['country'] : wpinv_get_default_country(); |
|
| 91 | + $value = wpinv_state_name( $value, $country ); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - return esc_html( $value ); |
|
| 94 | + return esc_html( $value ); |
|
| 95 | 95 | |
| 96 | - } |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | 98 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | 10 | if ( ! defined( 'ABSPATH' ) ) { |
| 11 | - exit; // Exit if accessed directly |
|
| 11 | + exit; // Exit if accessed directly |
|
| 12 | 12 | } |
| 13 | 13 | |
| 14 | 14 | /** |
@@ -17,10 +17,10 @@ discard block |
||
| 17 | 17 | class GetPaid_Meta_Box_Discount_Details { |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * Output the metabox. |
|
| 21 | - * |
|
| 22 | - * @param WP_Post $post |
|
| 23 | - */ |
|
| 20 | + * Output the metabox. |
|
| 21 | + * |
|
| 22 | + * @param WP_Post $post |
|
| 23 | + */ |
|
| 24 | 24 | public static function output( $post ) { |
| 25 | 25 | |
| 26 | 26 | // Prepare the discount. |
@@ -396,35 +396,35 @@ discard block |
||
| 396 | 396 | } |
| 397 | 397 | |
| 398 | 398 | /** |
| 399 | - * Save meta box data. |
|
| 400 | - * |
|
| 401 | - * @param int $post_id |
|
| 402 | - */ |
|
| 403 | - public static function save( $post_id ) { |
|
| 399 | + * Save meta box data. |
|
| 400 | + * |
|
| 401 | + * @param int $post_id |
|
| 402 | + */ |
|
| 403 | + public static function save( $post_id ) { |
|
| 404 | 404 | |
| 405 | 405 | // Prepare the discount. |
| 406 | 406 | $discount = new WPInv_Discount( $post_id ); |
| 407 | 407 | |
| 408 | 408 | // Load new data. |
| 409 | 409 | $discount->set_props( |
| 410 | - array( |
|
| 411 | - 'code' => isset( $_POST['wpinv_discount_code'] ) ? wpinv_clean( $_POST['wpinv_discount_code'] ) : null, |
|
| 412 | - 'amount' => isset( $_POST['wpinv_discount_amount'] ) ? floatval( $_POST['wpinv_discount_amount'] ) : null, |
|
| 413 | - 'start' => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null, |
|
| 414 | - 'expiration' => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null, |
|
| 415 | - 'is_single_use' => ! empty( $_POST['wpinv_discount_single_use'] ), |
|
| 410 | + array( |
|
| 411 | + 'code' => isset( $_POST['wpinv_discount_code'] ) ? wpinv_clean( $_POST['wpinv_discount_code'] ) : null, |
|
| 412 | + 'amount' => isset( $_POST['wpinv_discount_amount'] ) ? floatval( $_POST['wpinv_discount_amount'] ) : null, |
|
| 413 | + 'start' => isset( $_POST['wpinv_discount_start'] ) ? wpinv_clean( $_POST['wpinv_discount_start'] ) : null, |
|
| 414 | + 'expiration' => isset( $_POST['wpinv_discount_expiration'] ) ? wpinv_clean( $_POST['wpinv_discount_expiration'] ) : null, |
|
| 415 | + 'is_single_use' => ! empty( $_POST['wpinv_discount_single_use'] ), |
|
| 416 | 416 | 'type' => isset( $_POST['wpinv_discount_type'] ) ? wpinv_clean( $_POST['wpinv_discount_type'] ) : null, |
| 417 | - 'is_recurring' => ! empty( $_POST['wpinv_discount_recurring'] ), |
|
| 418 | - 'items' => isset( $_POST['wpinv_discount_items'] ) ? wpinv_clean( $_POST['wpinv_discount_items'] ) : array(), |
|
| 419 | - 'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? wpinv_clean( $_POST['wpinv_discount_excluded_items'] ) : array(), |
|
| 417 | + 'is_recurring' => ! empty( $_POST['wpinv_discount_recurring'] ), |
|
| 418 | + 'items' => isset( $_POST['wpinv_discount_items'] ) ? wpinv_clean( $_POST['wpinv_discount_items'] ) : array(), |
|
| 419 | + 'excluded_items' => isset( $_POST['wpinv_discount_excluded_items'] ) ? wpinv_clean( $_POST['wpinv_discount_excluded_items'] ) : array(), |
|
| 420 | 420 | 'required_items' => isset( $_POST['wpinv_discount_required_items'] ) ? wpinv_clean( $_POST['wpinv_discount_required_items'] ) : array(), |
| 421 | - 'max_uses' => isset( $_POST['wpinv_discount_max_uses'] ) ? intval( $_POST['wpinv_discount_max_uses'] ) : null, |
|
| 422 | - 'min_total' => isset( $_POST['wpinv_discount_min_total'] ) ? floatval( $_POST['wpinv_discount_min_total'] ) : null, |
|
| 423 | - 'max_total' => isset( $_POST['wpinv_discount_max_total'] ) ? floatval( $_POST['wpinv_discount_max_total'] ) : null, |
|
| 424 | - ) |
|
| 421 | + 'max_uses' => isset( $_POST['wpinv_discount_max_uses'] ) ? intval( $_POST['wpinv_discount_max_uses'] ) : null, |
|
| 422 | + 'min_total' => isset( $_POST['wpinv_discount_min_total'] ) ? floatval( $_POST['wpinv_discount_min_total'] ) : null, |
|
| 423 | + 'max_total' => isset( $_POST['wpinv_discount_max_total'] ) ? floatval( $_POST['wpinv_discount_max_total'] ) : null, |
|
| 424 | + ) |
|
| 425 | 425 | ); |
| 426 | 426 | |
| 427 | - $discount->save(); |
|
| 428 | - do_action( 'getpaid_discount_metabox_save', $post_id, $discount ); |
|
| 429 | - } |
|
| 427 | + $discount->save(); |
|
| 428 | + do_action( 'getpaid_discount_metabox_save', $post_id, $discount ); |
|
| 429 | + } |
|
| 430 | 430 | } |
@@ -24,14 +24,14 @@ discard block |
||
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Highlights sub menus. |
|
| 28 | - */ |
|
| 29 | - public function set_admin_menu_class() { |
|
| 30 | - global $current_screen, $parent_file, $submenu_file; |
|
| 27 | + * Highlights sub menus. |
|
| 28 | + */ |
|
| 29 | + public function set_admin_menu_class() { |
|
| 30 | + global $current_screen, $parent_file, $submenu_file; |
|
| 31 | 31 | |
| 32 | 32 | if ( ! empty( $current_screen->id ) && in_array( $current_screen->id, array( 'wpi_discount', 'wpi_payment_form', 'wpi_invoice' ) ) ) { |
| 33 | - $parent_file = 'wpinv'; |
|
| 34 | - $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
| 33 | + $parent_file = 'wpinv'; |
|
| 34 | + $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
| 35 | 35 | } |
| 36 | 36 | |
| 37 | 37 | } |
@@ -165,8 +165,8 @@ discard block |
||
| 165 | 165 | foreach ( wpinv_get_settings_tabs() as $tab_id => $tab_name ) { |
| 166 | 166 | $tab_url = add_query_arg( |
| 167 | 167 | array( |
| 168 | - 'settings-updated' => false, |
|
| 169 | - 'tab' => $tab_id, |
|
| 168 | + 'settings-updated' => false, |
|
| 169 | + 'tab' => $tab_id, |
|
| 170 | 170 | ), |
| 171 | 171 | 'admin.php?page=wpinv-settings' |
| 172 | 172 | ); |
@@ -193,9 +193,9 @@ discard block |
||
| 193 | 193 | $number++; |
| 194 | 194 | $tab_url = add_query_arg( |
| 195 | 195 | array( |
| 196 | - 'settings-updated' => false, |
|
| 197 | - 'tab' => $active_tab, |
|
| 198 | - 'section' => $section_id, |
|
| 196 | + 'settings-updated' => false, |
|
| 197 | + 'tab' => $active_tab, |
|
| 198 | + 'section' => $section_id, |
|
| 199 | 199 | ), |
| 200 | 200 | admin_url( 'admin.php?page=wpinv-settings' ) |
| 201 | 201 | ); |
@@ -21,569 +21,569 @@ |
||
| 21 | 21 | */ |
| 22 | 22 | class GetPaid_REST_Controller extends WP_REST_Controller { |
| 23 | 23 | |
| 24 | - /** |
|
| 24 | + /** |
|
| 25 | 25 | * The namespaces of this controller's route. |
| 26 | 26 | * |
| 27 | 27 | * @since 1.0.19 |
| 28 | 28 | * @var array |
| 29 | 29 | */ |
| 30 | - protected $namespaces; |
|
| 30 | + protected $namespaces; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 32 | + /** |
|
| 33 | 33 | * The official namespace of this controller's route. |
| 34 | 34 | * |
| 35 | 35 | * @since 1.0.19 |
| 36 | 36 | * @var string |
| 37 | 37 | */ |
| 38 | - protected $namespace = 'getpaid/v1'; |
|
| 38 | + protected $namespace = 'getpaid/v1'; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 40 | + /** |
|
| 41 | 41 | * Cached results of get_item_schema. |
| 42 | 42 | * |
| 43 | 43 | * @since 1.0.19 |
| 44 | 44 | * @var array |
| 45 | 45 | */ |
| 46 | - protected $schema; |
|
| 46 | + protected $schema; |
|
| 47 | 47 | |
| 48 | 48 | /** |
| 49 | - * Constructor. |
|
| 50 | - * |
|
| 51 | - * @since 1.0.19 |
|
| 52 | - * |
|
| 53 | - */ |
|
| 54 | - public function __construct() { |
|
| 55 | - |
|
| 56 | - // Offer several namespaces for backwards compatibility. |
|
| 57 | - $this->namespaces = apply_filters( |
|
| 58 | - 'getpaid_rest_api_namespaces', |
|
| 59 | - array( |
|
| 60 | - 'getpaid/v1', |
|
| 61 | - 'invoicing/v1', |
|
| 62 | - 'wpi/v1', |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - // Register REST routes. |
|
| 49 | + * Constructor. |
|
| 50 | + * |
|
| 51 | + * @since 1.0.19 |
|
| 52 | + * |
|
| 53 | + */ |
|
| 54 | + public function __construct() { |
|
| 55 | + |
|
| 56 | + // Offer several namespaces for backwards compatibility. |
|
| 57 | + $this->namespaces = apply_filters( |
|
| 58 | + 'getpaid_rest_api_namespaces', |
|
| 59 | + array( |
|
| 60 | + 'getpaid/v1', |
|
| 61 | + 'invoicing/v1', |
|
| 62 | + 'wpi/v1', |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + // Register REST routes. |
|
| 67 | 67 | add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
| 68 | 68 | |
| 69 | - } |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * Registers routes for each namespace. |
|
| 73 | - * |
|
| 74 | - * @since 1.0.19 |
|
| 75 | - * |
|
| 76 | - */ |
|
| 77 | - public function register_routes() { |
|
| 78 | - |
|
| 79 | - foreach ( $this->namespaces as $namespace ) { |
|
| 80 | - $this->register_namespace_routes( $namespace ); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Registers routes for a namespace. |
|
| 87 | - * |
|
| 88 | - * @since 1.0.19 |
|
| 89 | - * |
|
| 90 | - * @param string $namespace |
|
| 91 | - */ |
|
| 92 | - public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
| 93 | - |
|
| 94 | - getpaid_doing_it_wrong( |
|
| 95 | - __CLASS__ . '::' . __METHOD__, |
|
| 96 | - /* translators: %s: register_namespace_routes() */ |
|
| 97 | - sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
| 98 | - '1.0.19' |
|
| 99 | - ); |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Get normalized rest base. |
|
| 105 | - * |
|
| 106 | - * @return string |
|
| 107 | - */ |
|
| 108 | - protected function get_normalized_rest_base() { |
|
| 109 | - return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * Fill batches. |
|
| 114 | - * |
|
| 115 | - * @param array array of request items. |
|
| 116 | - * @return array |
|
| 117 | - */ |
|
| 118 | - protected function fill_batch_keys( $items ) { |
|
| 119 | - |
|
| 120 | - $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
| 121 | - $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
| 122 | - $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
| 123 | - return $items; |
|
| 124 | - |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * Check batch limit. |
|
| 129 | - * |
|
| 130 | - * @param array $items Request items. |
|
| 131 | - * @return bool|WP_Error |
|
| 132 | - */ |
|
| 133 | - protected function check_batch_limit( $items ) { |
|
| 134 | - $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
| 135 | - $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
| 136 | - |
|
| 137 | - if ( $total > $limit ) { |
|
| 138 | - /* translators: %s: items limit */ |
|
| 139 | - return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - return true; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Bulk create items. |
|
| 147 | - * |
|
| 148 | - * @param array $items Array of items to create. |
|
| 149 | - * @param WP_REST_Request $request Full details about the request. |
|
| 150 | - * @param WP_REST_Server $wp_rest_server |
|
| 151 | - * @return array() |
|
| 152 | - */ |
|
| 153 | - protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
| 154 | - |
|
| 155 | - $query = $request->get_query_params(); |
|
| 156 | - $create = array(); |
|
| 157 | - |
|
| 158 | - foreach ( $items as $item ) { |
|
| 159 | - $_item = new WP_REST_Request( 'POST' ); |
|
| 160 | - |
|
| 161 | - // Default parameters. |
|
| 162 | - $defaults = array(); |
|
| 163 | - $schema = $this->get_public_item_schema(); |
|
| 164 | - foreach ( $schema['properties'] as $arg => $options ) { |
|
| 165 | - if ( isset( $options['default'] ) ) { |
|
| 166 | - $defaults[ $arg ] = $options['default']; |
|
| 167 | - } |
|
| 168 | - } |
|
| 169 | - $_item->set_default_params( $defaults ); |
|
| 170 | - |
|
| 171 | - // Set request parameters. |
|
| 172 | - $_item->set_body_params( $item ); |
|
| 173 | - |
|
| 174 | - // Set query (GET) parameters. |
|
| 175 | - $_item->set_query_params( $query ); |
|
| 176 | - |
|
| 177 | - // Create the item. |
|
| 178 | - $_response = $this->create_item( $_item ); |
|
| 179 | - |
|
| 180 | - // If an error occured... |
|
| 181 | - if ( is_wp_error( $_response ) ) { |
|
| 182 | - |
|
| 183 | - $create[] = array( |
|
| 184 | - 'id' => 0, |
|
| 185 | - 'error' => array( |
|
| 186 | - 'code' => $_response->get_error_code(), |
|
| 187 | - 'message' => $_response->get_error_message(), |
|
| 188 | - 'data' => $_response->get_error_data(), |
|
| 189 | - ), |
|
| 190 | - ); |
|
| 191 | - |
|
| 192 | - continue; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 196 | - |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - return $create; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * Registers routes for each namespace. |
|
| 73 | + * |
|
| 74 | + * @since 1.0.19 |
|
| 75 | + * |
|
| 76 | + */ |
|
| 77 | + public function register_routes() { |
|
| 78 | + |
|
| 79 | + foreach ( $this->namespaces as $namespace ) { |
|
| 80 | + $this->register_namespace_routes( $namespace ); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Registers routes for a namespace. |
|
| 87 | + * |
|
| 88 | + * @since 1.0.19 |
|
| 89 | + * |
|
| 90 | + * @param string $namespace |
|
| 91 | + */ |
|
| 92 | + public function register_namespace_routes( /** @scrutinizer ignore-unused */ $namespace ) { |
|
| 93 | + |
|
| 94 | + getpaid_doing_it_wrong( |
|
| 95 | + __CLASS__ . '::' . __METHOD__, |
|
| 96 | + /* translators: %s: register_namespace_routes() */ |
|
| 97 | + sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), |
|
| 98 | + '1.0.19' |
|
| 99 | + ); |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Get normalized rest base. |
|
| 105 | + * |
|
| 106 | + * @return string |
|
| 107 | + */ |
|
| 108 | + protected function get_normalized_rest_base() { |
|
| 109 | + return preg_replace( '/\(.*\)\//i', '', $this->rest_base ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * Fill batches. |
|
| 114 | + * |
|
| 115 | + * @param array array of request items. |
|
| 116 | + * @return array |
|
| 117 | + */ |
|
| 118 | + protected function fill_batch_keys( $items ) { |
|
| 119 | + |
|
| 120 | + $items['create'] = empty( $items['create'] ) ? array() : $items['create']; |
|
| 121 | + $items['update'] = empty( $items['update'] ) ? array() : $items['update']; |
|
| 122 | + $items['delete'] = empty( $items['delete'] ) ? array() : wp_parse_id_list( $items['delete'] ); |
|
| 123 | + return $items; |
|
| 124 | + |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * Check batch limit. |
|
| 129 | + * |
|
| 130 | + * @param array $items Request items. |
|
| 131 | + * @return bool|WP_Error |
|
| 132 | + */ |
|
| 133 | + protected function check_batch_limit( $items ) { |
|
| 134 | + $limit = apply_filters( 'getpaid_rest_batch_items_limit', 100, $this->get_normalized_rest_base() ); |
|
| 135 | + $total = count( $items['create'] ) + count( $items['update'] ) + count( $items['delete'] ); |
|
| 136 | + |
|
| 137 | + if ( $total > $limit ) { |
|
| 138 | + /* translators: %s: items limit */ |
|
| 139 | + return new WP_Error( 'getpaid_rest_request_entity_too_large', sprintf( __( 'Unable to accept more than %s items for this request.', 'invoicing' ), $limit ), array( 'status' => 413 ) ); |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + return true; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Bulk create items. |
|
| 147 | + * |
|
| 148 | + * @param array $items Array of items to create. |
|
| 149 | + * @param WP_REST_Request $request Full details about the request. |
|
| 150 | + * @param WP_REST_Server $wp_rest_server |
|
| 151 | + * @return array() |
|
| 152 | + */ |
|
| 153 | + protected function batch_create_items( $items, $request, $wp_rest_server ) { |
|
| 154 | + |
|
| 155 | + $query = $request->get_query_params(); |
|
| 156 | + $create = array(); |
|
| 157 | + |
|
| 158 | + foreach ( $items as $item ) { |
|
| 159 | + $_item = new WP_REST_Request( 'POST' ); |
|
| 160 | + |
|
| 161 | + // Default parameters. |
|
| 162 | + $defaults = array(); |
|
| 163 | + $schema = $this->get_public_item_schema(); |
|
| 164 | + foreach ( $schema['properties'] as $arg => $options ) { |
|
| 165 | + if ( isset( $options['default'] ) ) { |
|
| 166 | + $defaults[ $arg ] = $options['default']; |
|
| 167 | + } |
|
| 168 | + } |
|
| 169 | + $_item->set_default_params( $defaults ); |
|
| 170 | + |
|
| 171 | + // Set request parameters. |
|
| 172 | + $_item->set_body_params( $item ); |
|
| 173 | + |
|
| 174 | + // Set query (GET) parameters. |
|
| 175 | + $_item->set_query_params( $query ); |
|
| 176 | + |
|
| 177 | + // Create the item. |
|
| 178 | + $_response = $this->create_item( $_item ); |
|
| 179 | + |
|
| 180 | + // If an error occured... |
|
| 181 | + if ( is_wp_error( $_response ) ) { |
|
| 182 | + |
|
| 183 | + $create[] = array( |
|
| 184 | + 'id' => 0, |
|
| 185 | + 'error' => array( |
|
| 186 | + 'code' => $_response->get_error_code(), |
|
| 187 | + 'message' => $_response->get_error_message(), |
|
| 188 | + 'data' => $_response->get_error_data(), |
|
| 189 | + ), |
|
| 190 | + ); |
|
| 191 | + |
|
| 192 | + continue; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + $create[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 196 | + |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + return $create; |
|
| 200 | + |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * Bulk update items. |
|
| 205 | + * |
|
| 206 | + * @param array $items Array of items to update. |
|
| 207 | + * @param WP_REST_Request $request Full details about the request. |
|
| 208 | + * @param WP_REST_Server $wp_rest_server |
|
| 209 | + * @return array() |
|
| 210 | + */ |
|
| 211 | + protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
| 212 | + |
|
| 213 | + $query = $request->get_query_params(); |
|
| 214 | + $update = array(); |
|
| 215 | + |
|
| 216 | + foreach ( $items as $item ) { |
|
| 217 | + |
|
| 218 | + // Create a dummy request. |
|
| 219 | + $_item = new WP_REST_Request( 'PUT' ); |
|
| 220 | + |
|
| 221 | + // Add body params. |
|
| 222 | + $_item->set_body_params( $item ); |
|
| 223 | + |
|
| 224 | + // Set query (GET) parameters. |
|
| 225 | + $_item->set_query_params( $query ); |
|
| 226 | + |
|
| 227 | + // Update the item. |
|
| 228 | + $_response = $this->update_item( $_item ); |
|
| 229 | + |
|
| 230 | + // If an error occured... |
|
| 231 | + if ( is_wp_error( $_response ) ) { |
|
| 232 | + |
|
| 233 | + $update[] = array( |
|
| 234 | + 'id' => $item['id'], |
|
| 235 | + 'error' => array( |
|
| 236 | + 'code' => $_response->get_error_code(), |
|
| 237 | + 'message' => $_response->get_error_message(), |
|
| 238 | + 'data' => $_response->get_error_data(), |
|
| 239 | + ), |
|
| 240 | + ); |
|
| 241 | + |
|
| 242 | + continue; |
|
| 243 | + |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 247 | + |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + return $update; |
|
| 251 | + |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Bulk delete items. |
|
| 256 | + * |
|
| 257 | + * @param array $items Array of items to delete. |
|
| 258 | + * @param WP_REST_Server $wp_rest_server |
|
| 259 | + * @return array() |
|
| 260 | + */ |
|
| 261 | + protected function batch_delete_items( $items, $wp_rest_server ) { |
|
| 262 | + |
|
| 263 | + $delete = array(); |
|
| 264 | + |
|
| 265 | + foreach ( array_filter( $items ) as $id ) { |
|
| 266 | + |
|
| 267 | + // Prepare the request. |
|
| 268 | + $_item = new WP_REST_Request( 'DELETE' ); |
|
| 269 | + $_item->set_query_params( |
|
| 270 | + array( |
|
| 271 | + 'id' => $id, |
|
| 272 | + 'force' => true, |
|
| 273 | + ) |
|
| 274 | + ); |
|
| 275 | + |
|
| 276 | + // Delete the item. |
|
| 277 | + $_response = $this->delete_item( $_item ); |
|
| 278 | + |
|
| 279 | + if ( is_wp_error( $_response ) ) { |
|
| 280 | + |
|
| 281 | + $delete[] = array( |
|
| 282 | + 'id' => $id, |
|
| 283 | + 'error' => array( |
|
| 284 | + 'code' => $_response->get_error_code(), |
|
| 285 | + 'message' => $_response->get_error_message(), |
|
| 286 | + 'data' => $_response->get_error_data(), |
|
| 287 | + ), |
|
| 288 | + ); |
|
| 289 | + |
|
| 290 | + continue; |
|
| 291 | + } |
|
| 200 | 292 | |
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * Bulk update items. |
|
| 205 | - * |
|
| 206 | - * @param array $items Array of items to update. |
|
| 207 | - * @param WP_REST_Request $request Full details about the request. |
|
| 208 | - * @param WP_REST_Server $wp_rest_server |
|
| 209 | - * @return array() |
|
| 210 | - */ |
|
| 211 | - protected function batch_update_items( $items, $request, $wp_rest_server ) { |
|
| 212 | - |
|
| 213 | - $query = $request->get_query_params(); |
|
| 214 | - $update = array(); |
|
| 215 | - |
|
| 216 | - foreach ( $items as $item ) { |
|
| 217 | - |
|
| 218 | - // Create a dummy request. |
|
| 219 | - $_item = new WP_REST_Request( 'PUT' ); |
|
| 220 | - |
|
| 221 | - // Add body params. |
|
| 222 | - $_item->set_body_params( $item ); |
|
| 223 | - |
|
| 224 | - // Set query (GET) parameters. |
|
| 225 | - $_item->set_query_params( $query ); |
|
| 226 | - |
|
| 227 | - // Update the item. |
|
| 228 | - $_response = $this->update_item( $_item ); |
|
| 229 | - |
|
| 230 | - // If an error occured... |
|
| 231 | - if ( is_wp_error( $_response ) ) { |
|
| 232 | - |
|
| 233 | - $update[] = array( |
|
| 234 | - 'id' => $item['id'], |
|
| 235 | - 'error' => array( |
|
| 236 | - 'code' => $_response->get_error_code(), |
|
| 237 | - 'message' => $_response->get_error_message(), |
|
| 238 | - 'data' => $_response->get_error_data(), |
|
| 239 | - ), |
|
| 240 | - ); |
|
| 241 | - |
|
| 242 | - continue; |
|
| 243 | - |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - $update[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 247 | - |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - return $update; |
|
| 251 | - |
|
| 252 | - } |
|
| 293 | + $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 253 | 294 | |
| 254 | - /** |
|
| 255 | - * Bulk delete items. |
|
| 256 | - * |
|
| 257 | - * @param array $items Array of items to delete. |
|
| 258 | - * @param WP_REST_Server $wp_rest_server |
|
| 259 | - * @return array() |
|
| 260 | - */ |
|
| 261 | - protected function batch_delete_items( $items, $wp_rest_server ) { |
|
| 262 | - |
|
| 263 | - $delete = array(); |
|
| 264 | - |
|
| 265 | - foreach ( array_filter( $items ) as $id ) { |
|
| 266 | - |
|
| 267 | - // Prepare the request. |
|
| 268 | - $_item = new WP_REST_Request( 'DELETE' ); |
|
| 269 | - $_item->set_query_params( |
|
| 270 | - array( |
|
| 271 | - 'id' => $id, |
|
| 272 | - 'force' => true, |
|
| 273 | - ) |
|
| 274 | - ); |
|
| 275 | - |
|
| 276 | - // Delete the item. |
|
| 277 | - $_response = $this->delete_item( $_item ); |
|
| 278 | - |
|
| 279 | - if ( is_wp_error( $_response ) ) { |
|
| 280 | - |
|
| 281 | - $delete[] = array( |
|
| 282 | - 'id' => $id, |
|
| 283 | - 'error' => array( |
|
| 284 | - 'code' => $_response->get_error_code(), |
|
| 285 | - 'message' => $_response->get_error_message(), |
|
| 286 | - 'data' => $_response->get_error_data(), |
|
| 287 | - ), |
|
| 288 | - ); |
|
| 289 | - |
|
| 290 | - continue; |
|
| 291 | - } |
|
| 292 | - |
|
| 293 | - $delete[] = $wp_rest_server->response_to_data( /** @scrutinizer ignore-type */ $_response, false ); |
|
| 294 | - |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - return $delete; |
|
| 298 | - |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * Bulk create, update and delete items. |
|
| 303 | - * |
|
| 304 | - * @param WP_REST_Request $request Full details about the request. |
|
| 305 | - * @return WP_Error|array. |
|
| 306 | - */ |
|
| 307 | - public function batch_items( $request ) { |
|
| 308 | - global $wp_rest_server; |
|
| 309 | - |
|
| 310 | - // Prepare the batch items. |
|
| 311 | - $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
| 312 | - |
|
| 313 | - // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
| 314 | - $limit = $this->check_batch_limit( $items ); |
|
| 315 | - if ( is_wp_error( $limit ) ) { |
|
| 316 | - return $limit; |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - // Process the items. |
|
| 320 | - return array( |
|
| 321 | - 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
| 322 | - 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
| 323 | - 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
| 324 | - ); |
|
| 325 | - |
|
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Add meta query. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param array $args Query args. |
|
| 333 | - * @param array $meta_query Meta query. |
|
| 334 | - * @return array |
|
| 335 | - */ |
|
| 336 | - protected function add_meta_query( $args, $meta_query ) { |
|
| 337 | - if ( empty( $args['meta_query'] ) ) { |
|
| 338 | - $args['meta_query'] = array(); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - $args['meta_query'][] = $meta_query; |
|
| 342 | - |
|
| 343 | - return $args['meta_query']; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Get the batch schema, conforming to JSON Schema. |
|
| 348 | - * |
|
| 349 | - * @return array |
|
| 350 | - */ |
|
| 351 | - public function get_public_batch_schema() { |
|
| 352 | - |
|
| 353 | - return array( |
|
| 354 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 355 | - 'title' => 'batch', |
|
| 356 | - 'type' => 'object', |
|
| 357 | - 'properties' => array( |
|
| 358 | - 'create' => array( |
|
| 359 | - 'description' => __( 'List of created resources.', 'invoicing' ), |
|
| 360 | - 'type' => 'array', |
|
| 361 | - 'context' => array( 'view', 'edit' ), |
|
| 362 | - 'items' => array( |
|
| 363 | - 'type' => 'object', |
|
| 364 | - ), |
|
| 365 | - ), |
|
| 366 | - 'update' => array( |
|
| 367 | - 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
| 368 | - 'type' => 'array', |
|
| 369 | - 'context' => array( 'view', 'edit' ), |
|
| 370 | - 'items' => array( |
|
| 371 | - 'type' => 'object', |
|
| 372 | - ), |
|
| 373 | - ), |
|
| 374 | - 'delete' => array( |
|
| 375 | - 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
| 376 | - 'type' => 'array', |
|
| 377 | - 'context' => array( 'view', 'edit' ), |
|
| 378 | - 'items' => array( |
|
| 379 | - 'type' => 'integer', |
|
| 380 | - ), |
|
| 381 | - ), |
|
| 382 | - ), |
|
| 383 | - ); |
|
| 384 | - |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Returns the value of schema['properties'] |
|
| 389 | - * |
|
| 390 | - * i.e Schema fields. |
|
| 391 | - * |
|
| 392 | - * @since 1.0.19 |
|
| 393 | - * @return array |
|
| 394 | - */ |
|
| 395 | - protected function get_schema_properties() { |
|
| 396 | - |
|
| 397 | - $schema = $this->get_item_schema(); |
|
| 398 | - $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
| 399 | - |
|
| 400 | - // For back-compat, include any field with an empty schema |
|
| 401 | - // because it won't be present in $this->get_item_schema(). |
|
| 402 | - foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
| 403 | - if ( is_null( $field_options['schema'] ) ) { |
|
| 404 | - $properties[ $field_name ] = $field_options; |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - return $properties; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * Filters fields by context. |
|
| 413 | - * |
|
| 414 | - * @param array $fields Array of fields |
|
| 415 | - * @param string|null context view, edit or embed |
|
| 416 | - * @since 1.0.19 |
|
| 417 | - * @return array |
|
| 418 | - */ |
|
| 419 | - protected function filter_response_fields_by_context( $fields, $context ) { |
|
| 420 | - |
|
| 421 | - if ( empty( $context ) ) { |
|
| 422 | - return $fields; |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - foreach ( $fields as $name => $options ) { |
|
| 426 | - if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
| 427 | - unset( $fields[ $name ] ); |
|
| 428 | - } |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - return $fields; |
|
| 432 | - |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - /** |
|
| 436 | - * Filters fields by an array of requested fields. |
|
| 437 | - * |
|
| 438 | - * @param array $fields Array of available fields |
|
| 439 | - * @param array $requested array of requested fields. |
|
| 440 | - * @since 1.0.19 |
|
| 441 | - * @return array |
|
| 442 | - */ |
|
| 443 | - protected function filter_response_fields_by_array( $fields, $requested ) { |
|
| 444 | - |
|
| 445 | - // Trim off any whitespace from the list array. |
|
| 446 | - $requested = array_map( 'trim', $requested ); |
|
| 447 | - |
|
| 448 | - // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
| 449 | - if ( in_array( 'id', $fields, true ) ) { |
|
| 450 | - $requested[] = 'id'; |
|
| 451 | - } |
|
| 452 | - |
|
| 453 | - // Get rid of duplicate fields. |
|
| 454 | - $requested = array_unique( $requested ); |
|
| 455 | - |
|
| 456 | - // Return the list of all included fields which are available. |
|
| 457 | - return array_reduce( |
|
| 458 | - $requested, |
|
| 459 | - function( $response_fields, $field ) use ( $fields ) { |
|
| 460 | - |
|
| 461 | - if ( in_array( $field, $fields, true ) ) { |
|
| 462 | - $response_fields[] = $field; |
|
| 463 | - return $response_fields; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - // Check for nested fields if $field is not a direct match. |
|
| 467 | - $nested_fields = explode( '.', $field ); |
|
| 468 | - |
|
| 469 | - // A nested field is included so long as its top-level property is |
|
| 470 | - // present in the schema. |
|
| 471 | - if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
| 472 | - $response_fields[] = $field; |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - return $response_fields; |
|
| 476 | - }, |
|
| 477 | - array() |
|
| 478 | - ); |
|
| 479 | - |
|
| 480 | - } |
|
| 481 | - |
|
| 482 | - /** |
|
| 483 | - * Gets an array of fields to be included on the response. |
|
| 484 | - * |
|
| 485 | - * Included fields are based on item schema and `_fields=` request argument. |
|
| 486 | - * Copied from WordPress 5.3 to support old versions. |
|
| 487 | - * |
|
| 488 | - * @since 1.0.19 |
|
| 489 | - * @param WP_REST_Request $request Full details about the request. |
|
| 490 | - * @return array Fields to be included in the response. |
|
| 491 | - */ |
|
| 492 | - public function get_fields_for_response( $request ) { |
|
| 493 | - |
|
| 494 | - // Retrieve fields in the schema. |
|
| 495 | - $properties = $this->get_schema_properties(); |
|
| 496 | - |
|
| 497 | - // Exclude fields that specify a different context than the request context. |
|
| 498 | - $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
| 499 | - |
|
| 500 | - // We only need the field keys. |
|
| 501 | - $fields = array_keys( $properties ); |
|
| 502 | - |
|
| 503 | - // Is the user filtering the response fields?? |
|
| 504 | - if ( empty( $request['_fields'] ) ) { |
|
| 505 | - return $fields; |
|
| 506 | - } |
|
| 507 | - |
|
| 508 | - return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
| 509 | - |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Limits an object to the requested fields. |
|
| 514 | - * |
|
| 515 | - * Included fields are based on the `_fields` request argument. |
|
| 516 | - * |
|
| 517 | - * @since 1.0.19 |
|
| 518 | - * @param array $data Fields to include in the response. |
|
| 519 | - * @param array $fields Requested fields. |
|
| 520 | - * @return array Fields to be included in the response. |
|
| 521 | - */ |
|
| 522 | - public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
| 523 | - |
|
| 524 | - // Is the user filtering the response fields?? |
|
| 525 | - if ( empty( $fields ) ) { |
|
| 526 | - return $data; |
|
| 527 | - } |
|
| 528 | - |
|
| 529 | - foreach ( $data as $key => $value ) { |
|
| 530 | - |
|
| 531 | - // Numeric arrays. |
|
| 532 | - if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 533 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
| 534 | - continue; |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - // Generate a new prefix. |
|
| 538 | - $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
| 539 | - |
|
| 540 | - // Check if it was requested. |
|
| 541 | - if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
| 542 | - unset( $data[ $key ] ); |
|
| 543 | - continue; |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - if ( $key != 'meta_data' && is_array( $value ) ) { |
|
| 547 | - $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
| 548 | - } |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + return $delete; |
|
| 298 | + |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * Bulk create, update and delete items. |
|
| 303 | + * |
|
| 304 | + * @param WP_REST_Request $request Full details about the request. |
|
| 305 | + * @return WP_Error|array. |
|
| 306 | + */ |
|
| 307 | + public function batch_items( $request ) { |
|
| 308 | + global $wp_rest_server; |
|
| 309 | + |
|
| 310 | + // Prepare the batch items. |
|
| 311 | + $items = $this->fill_batch_keys( array_filter( $request->get_params() ) ); |
|
| 312 | + |
|
| 313 | + // Ensure that the batch has not exceeded the limit to prevent abuse. |
|
| 314 | + $limit = $this->check_batch_limit( $items ); |
|
| 315 | + if ( is_wp_error( $limit ) ) { |
|
| 316 | + return $limit; |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + // Process the items. |
|
| 320 | + return array( |
|
| 321 | + 'create' => $this->batch_create_items( $items['create'], $request, $wp_rest_server ), |
|
| 322 | + 'update' => $this->batch_update_items( $items['update'], $request, $wp_rest_server ), |
|
| 323 | + 'delete' => $this->batch_delete_items( $items['delete'], $wp_rest_server ), |
|
| 324 | + ); |
|
| 325 | + |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Add meta query. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param array $args Query args. |
|
| 333 | + * @param array $meta_query Meta query. |
|
| 334 | + * @return array |
|
| 335 | + */ |
|
| 336 | + protected function add_meta_query( $args, $meta_query ) { |
|
| 337 | + if ( empty( $args['meta_query'] ) ) { |
|
| 338 | + $args['meta_query'] = array(); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + $args['meta_query'][] = $meta_query; |
|
| 342 | + |
|
| 343 | + return $args['meta_query']; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Get the batch schema, conforming to JSON Schema. |
|
| 348 | + * |
|
| 349 | + * @return array |
|
| 350 | + */ |
|
| 351 | + public function get_public_batch_schema() { |
|
| 352 | + |
|
| 353 | + return array( |
|
| 354 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 355 | + 'title' => 'batch', |
|
| 356 | + 'type' => 'object', |
|
| 357 | + 'properties' => array( |
|
| 358 | + 'create' => array( |
|
| 359 | + 'description' => __( 'List of created resources.', 'invoicing' ), |
|
| 360 | + 'type' => 'array', |
|
| 361 | + 'context' => array( 'view', 'edit' ), |
|
| 362 | + 'items' => array( |
|
| 363 | + 'type' => 'object', |
|
| 364 | + ), |
|
| 365 | + ), |
|
| 366 | + 'update' => array( |
|
| 367 | + 'description' => __( 'List of updated resources.', 'invoicing' ), |
|
| 368 | + 'type' => 'array', |
|
| 369 | + 'context' => array( 'view', 'edit' ), |
|
| 370 | + 'items' => array( |
|
| 371 | + 'type' => 'object', |
|
| 372 | + ), |
|
| 373 | + ), |
|
| 374 | + 'delete' => array( |
|
| 375 | + 'description' => __( 'List of deleted resources.', 'invoicing' ), |
|
| 376 | + 'type' => 'array', |
|
| 377 | + 'context' => array( 'view', 'edit' ), |
|
| 378 | + 'items' => array( |
|
| 379 | + 'type' => 'integer', |
|
| 380 | + ), |
|
| 381 | + ), |
|
| 382 | + ), |
|
| 383 | + ); |
|
| 384 | + |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Returns the value of schema['properties'] |
|
| 389 | + * |
|
| 390 | + * i.e Schema fields. |
|
| 391 | + * |
|
| 392 | + * @since 1.0.19 |
|
| 393 | + * @return array |
|
| 394 | + */ |
|
| 395 | + protected function get_schema_properties() { |
|
| 396 | + |
|
| 397 | + $schema = $this->get_item_schema(); |
|
| 398 | + $properties = isset( $schema['properties'] ) ? $schema['properties'] : array(); |
|
| 399 | + |
|
| 400 | + // For back-compat, include any field with an empty schema |
|
| 401 | + // because it won't be present in $this->get_item_schema(). |
|
| 402 | + foreach ( $this->get_additional_fields() as $field_name => $field_options ) { |
|
| 403 | + if ( is_null( $field_options['schema'] ) ) { |
|
| 404 | + $properties[ $field_name ] = $field_options; |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + return $properties; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * Filters fields by context. |
|
| 413 | + * |
|
| 414 | + * @param array $fields Array of fields |
|
| 415 | + * @param string|null context view, edit or embed |
|
| 416 | + * @since 1.0.19 |
|
| 417 | + * @return array |
|
| 418 | + */ |
|
| 419 | + protected function filter_response_fields_by_context( $fields, $context ) { |
|
| 420 | + |
|
| 421 | + if ( empty( $context ) ) { |
|
| 422 | + return $fields; |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + foreach ( $fields as $name => $options ) { |
|
| 426 | + if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) { |
|
| 427 | + unset( $fields[ $name ] ); |
|
| 428 | + } |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + return $fields; |
|
| 432 | + |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + /** |
|
| 436 | + * Filters fields by an array of requested fields. |
|
| 437 | + * |
|
| 438 | + * @param array $fields Array of available fields |
|
| 439 | + * @param array $requested array of requested fields. |
|
| 440 | + * @since 1.0.19 |
|
| 441 | + * @return array |
|
| 442 | + */ |
|
| 443 | + protected function filter_response_fields_by_array( $fields, $requested ) { |
|
| 444 | + |
|
| 445 | + // Trim off any whitespace from the list array. |
|
| 446 | + $requested = array_map( 'trim', $requested ); |
|
| 447 | + |
|
| 448 | + // Always persist 'id', because it can be needed for add_additional_fields_to_object(). |
|
| 449 | + if ( in_array( 'id', $fields, true ) ) { |
|
| 450 | + $requested[] = 'id'; |
|
| 451 | + } |
|
| 452 | + |
|
| 453 | + // Get rid of duplicate fields. |
|
| 454 | + $requested = array_unique( $requested ); |
|
| 455 | + |
|
| 456 | + // Return the list of all included fields which are available. |
|
| 457 | + return array_reduce( |
|
| 458 | + $requested, |
|
| 459 | + function( $response_fields, $field ) use ( $fields ) { |
|
| 460 | + |
|
| 461 | + if ( in_array( $field, $fields, true ) ) { |
|
| 462 | + $response_fields[] = $field; |
|
| 463 | + return $response_fields; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + // Check for nested fields if $field is not a direct match. |
|
| 467 | + $nested_fields = explode( '.', $field ); |
|
| 468 | + |
|
| 469 | + // A nested field is included so long as its top-level property is |
|
| 470 | + // present in the schema. |
|
| 471 | + if ( in_array( $nested_fields[0], $fields, true ) ) { |
|
| 472 | + $response_fields[] = $field; |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + return $response_fields; |
|
| 476 | + }, |
|
| 477 | + array() |
|
| 478 | + ); |
|
| 479 | + |
|
| 480 | + } |
|
| 481 | + |
|
| 482 | + /** |
|
| 483 | + * Gets an array of fields to be included on the response. |
|
| 484 | + * |
|
| 485 | + * Included fields are based on item schema and `_fields=` request argument. |
|
| 486 | + * Copied from WordPress 5.3 to support old versions. |
|
| 487 | + * |
|
| 488 | + * @since 1.0.19 |
|
| 489 | + * @param WP_REST_Request $request Full details about the request. |
|
| 490 | + * @return array Fields to be included in the response. |
|
| 491 | + */ |
|
| 492 | + public function get_fields_for_response( $request ) { |
|
| 493 | + |
|
| 494 | + // Retrieve fields in the schema. |
|
| 495 | + $properties = $this->get_schema_properties(); |
|
| 496 | + |
|
| 497 | + // Exclude fields that specify a different context than the request context. |
|
| 498 | + $properties = $this->filter_response_fields_by_context( $properties, $request['context'] ); |
|
| 499 | + |
|
| 500 | + // We only need the field keys. |
|
| 501 | + $fields = array_keys( $properties ); |
|
| 502 | + |
|
| 503 | + // Is the user filtering the response fields?? |
|
| 504 | + if ( empty( $request['_fields'] ) ) { |
|
| 505 | + return $fields; |
|
| 506 | + } |
|
| 507 | + |
|
| 508 | + return $this->filter_response_fields_by_array( $fields, wpinv_parse_list( $request['_fields'] ) ); |
|
| 509 | + |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Limits an object to the requested fields. |
|
| 514 | + * |
|
| 515 | + * Included fields are based on the `_fields` request argument. |
|
| 516 | + * |
|
| 517 | + * @since 1.0.19 |
|
| 518 | + * @param array $data Fields to include in the response. |
|
| 519 | + * @param array $fields Requested fields. |
|
| 520 | + * @return array Fields to be included in the response. |
|
| 521 | + */ |
|
| 522 | + public function limit_object_to_requested_fields( $data, $fields, $prefix = '' ) { |
|
| 523 | + |
|
| 524 | + // Is the user filtering the response fields?? |
|
| 525 | + if ( empty( $fields ) ) { |
|
| 526 | + return $data; |
|
| 527 | + } |
|
| 528 | + |
|
| 529 | + foreach ( $data as $key => $value ) { |
|
| 530 | + |
|
| 531 | + // Numeric arrays. |
|
| 532 | + if ( is_numeric( $key ) && is_array( $value ) ) { |
|
| 533 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $prefix ); |
|
| 534 | + continue; |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + // Generate a new prefix. |
|
| 538 | + $new_prefix = empty( $prefix ) ? $key : "$prefix.$key"; |
|
| 539 | + |
|
| 540 | + // Check if it was requested. |
|
| 541 | + if ( ! empty( $key ) && ! $this->is_field_included( $new_prefix, $fields ) ) { |
|
| 542 | + unset( $data[ $key ] ); |
|
| 543 | + continue; |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + if ( $key != 'meta_data' && is_array( $value ) ) { |
|
| 547 | + $data[ $key ] = $this->limit_object_to_requested_fields( $value, $fields, $new_prefix ); |
|
| 548 | + } |
|
| 549 | 549 | } |
| 550 | 550 | |
| 551 | - return $data; |
|
| 552 | - } |
|
| 553 | - |
|
| 554 | - /** |
|
| 555 | - * Given an array of fields to include in a response, some of which may be |
|
| 556 | - * `nested.fields`, determine whether the provided field should be included |
|
| 557 | - * in the response body. |
|
| 558 | - * |
|
| 559 | - * Copied from WordPress 5.3 to support old versions. |
|
| 560 | - * |
|
| 561 | - * @since 1.0.19 |
|
| 562 | - * |
|
| 563 | - * @param string $field A field to test for inclusion in the response body. |
|
| 564 | - * @param array $fields An array of string fields supported by the endpoint. |
|
| 565 | - * @return bool Whether to include the field or not. |
|
| 566 | - * @see rest_is_field_included() |
|
| 567 | - */ |
|
| 568 | - public function is_field_included( $field, $fields ) { |
|
| 569 | - if ( in_array( $field, $fields, true ) ) { |
|
| 570 | - return true; |
|
| 571 | - } |
|
| 572 | - |
|
| 573 | - foreach ( $fields as $accepted_field ) { |
|
| 574 | - // Check to see if $field is the parent of any item in $fields. |
|
| 575 | - // A field "parent" should be accepted if "parent.child" is accepted. |
|
| 576 | - if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
| 577 | - return true; |
|
| 578 | - } |
|
| 579 | - // Conversely, if "parent" is accepted, all "parent.child" fields |
|
| 580 | - // should also be accepted. |
|
| 581 | - if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
| 582 | - return true; |
|
| 583 | - } |
|
| 584 | - } |
|
| 585 | - |
|
| 586 | - return false; |
|
| 587 | - } |
|
| 551 | + return $data; |
|
| 552 | + } |
|
| 553 | + |
|
| 554 | + /** |
|
| 555 | + * Given an array of fields to include in a response, some of which may be |
|
| 556 | + * `nested.fields`, determine whether the provided field should be included |
|
| 557 | + * in the response body. |
|
| 558 | + * |
|
| 559 | + * Copied from WordPress 5.3 to support old versions. |
|
| 560 | + * |
|
| 561 | + * @since 1.0.19 |
|
| 562 | + * |
|
| 563 | + * @param string $field A field to test for inclusion in the response body. |
|
| 564 | + * @param array $fields An array of string fields supported by the endpoint. |
|
| 565 | + * @return bool Whether to include the field or not. |
|
| 566 | + * @see rest_is_field_included() |
|
| 567 | + */ |
|
| 568 | + public function is_field_included( $field, $fields ) { |
|
| 569 | + if ( in_array( $field, $fields, true ) ) { |
|
| 570 | + return true; |
|
| 571 | + } |
|
| 572 | + |
|
| 573 | + foreach ( $fields as $accepted_field ) { |
|
| 574 | + // Check to see if $field is the parent of any item in $fields. |
|
| 575 | + // A field "parent" should be accepted if "parent.child" is accepted. |
|
| 576 | + if ( strpos( $accepted_field, "$field." ) === 0 ) { |
|
| 577 | + return true; |
|
| 578 | + } |
|
| 579 | + // Conversely, if "parent" is accepted, all "parent.child" fields |
|
| 580 | + // should also be accepted. |
|
| 581 | + if ( strpos( $field, "$accepted_field." ) === 0 ) { |
|
| 582 | + return true; |
|
| 583 | + } |
|
| 584 | + } |
|
| 585 | + |
|
| 586 | + return false; |
|
| 587 | + } |
|
| 588 | 588 | |
| 589 | 589 | } |