mathewparet /
laravel-invites
| Total Complexity | 45 |
| Total Lines | 296 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like LaravelInvites often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use LaravelInvites, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class LaravelInvites |
||
| 31 | { |
||
| 32 | private $number_of_invites = 1; |
||
| 33 | private $data = []; |
||
| 34 | |||
| 35 | private function initializeData() |
||
| 36 | { |
||
| 37 | $this->data = ['allow_count' => 1]; |
||
| 38 | } |
||
| 39 | |||
| 40 | public function __construct() |
||
| 41 | { |
||
| 42 | $this->initializeData(); |
||
| 43 | } |
||
| 44 | |||
| 45 | public function get() |
||
| 46 | { |
||
| 47 | if(!blank(optional($this->data)['email'])) |
||
| 48 | $result = Invite::valid()->whereEmail($this->data['email'])->first(); |
||
| 49 | else |
||
| 50 | $result = Invite::valid()->get(); |
||
| 51 | |||
| 52 | $this->initializeData(); |
||
| 53 | |||
| 54 | return $result; |
||
| 55 | } |
||
| 56 | |||
| 57 | public function for($email=null) |
||
| 58 | { |
||
| 59 | if(!$email) |
||
| 60 | { |
||
| 61 | unset($this->data['email']); |
||
| 62 | return $this; |
||
| 63 | } |
||
| 64 | |||
| 65 | $validator = Validator::make(compact('email'),[ |
||
| 66 | 'email'=>'required|email' |
||
| 67 | ]); |
||
| 68 | if($validator->fails()) |
||
| 69 | throw new InvalidEmailIdException; |
||
| 70 | |||
| 71 | $this->data['email'] = $email; |
||
| 72 | |||
| 73 | return $this; |
||
| 74 | } |
||
| 75 | |||
| 76 | private function prepareSingle() |
||
| 77 | { |
||
| 78 | $invite = Invite::create($this->data); |
||
| 79 | |||
| 80 | if($invite->email && config('laravelinvites.mail.enabled', true)) |
||
|
|
|||
| 81 | Mail::to($invite->email)->send(new InvitationMail($invite)); |
||
| 82 | |||
| 83 | return $invite; |
||
| 84 | } |
||
| 85 | |||
| 86 | public function validFrom($date = null) |
||
| 87 | { |
||
| 88 | $this->data['valid_from'] = $date ? : now(); |
||
| 89 | |||
| 90 | return $this; |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Generate the requested invitations |
||
| 95 | * |
||
| 96 | * @return \mathewparet\LaravelInvites\Model\Invite::clss $invite |
||
| 97 | */ |
||
| 98 | private function prepare() |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Generate invitations |
||
| 115 | * |
||
| 116 | * @param intiger $number_of_invites | default = 1 |
||
| 117 | * |
||
| 118 | * @return mixed array of invitations generated |
||
| 119 | */ |
||
| 120 | public function generate($number_of_invites = 1) |
||
| 121 | { |
||
| 122 | if(optional($this->data)['email'] && !blank($this->data['email'])) |
||
| 123 | { |
||
| 124 | if($number_of_invites > 1) |
||
| 125 | throw new AnEmailCanHaveOnlyOneInvitation; |
||
| 126 | |||
| 127 | $validator = Validator::make($this->data,[ |
||
| 128 | 'email'=>'unique:'.config('laravelinvites.table').',email' |
||
| 129 | ]); |
||
| 130 | |||
| 131 | if($validator->fails()) |
||
| 132 | throw new AnEmailCanHaveOnlyOneInvitation; |
||
| 133 | } |
||
| 134 | |||
| 135 | $this->number_of_invites = $number_of_invites; |
||
| 136 | |||
| 137 | $invitations = $this->prepare(); |
||
| 138 | |||
| 139 | $this->initializeData(); |
||
| 140 | |||
| 141 | return $invitations; |
||
| 142 | } |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Set the number of uses allowed for this invite |
||
| 146 | * |
||
| 147 | * @param integer $num_allowed |
||
| 148 | * |
||
| 149 | * @return $this |
||
| 150 | */ |
||
| 151 | public function allow($num_allowed = 1) |
||
| 152 | { |
||
| 153 | $this->data['allowed_count'] = $num_allowed; |
||
| 154 | |||
| 155 | return $this; |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Generate a single invitiation to be used only by a specific email |
||
| 160 | * |
||
| 161 | * @param string $email |
||
| 162 | * |
||
| 163 | * @return mixed the invitation record |
||
| 164 | */ |
||
| 165 | public function generateFor($email) |
||
| 166 | { |
||
| 167 | $this->for($email); |
||
| 168 | |||
| 169 | return $this->generate(1); |
||
| 170 | } |
||
| 171 | |||
| 172 | /** |
||
| 173 | * Set expiry to never expire |
||
| 174 | * |
||
| 175 | * @return reference to self |
||
| 176 | */ |
||
| 177 | public function withoutExpiry() |
||
| 178 | { |
||
| 179 | $this->data['valid_upto'] = null; |
||
| 180 | |||
| 181 | return $this; |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Set an expiry date |
||
| 186 | * |
||
| 187 | * @param \Carbon\Carbon $data |
||
| 188 | */ |
||
| 189 | public function setExpiry(Carbon $date) |
||
| 190 | { |
||
| 191 | $this->data['valid_upto'] = $date; |
||
| 192 | |||
| 193 | return $this; |
||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Find an invitation by code |
||
| 198 | * |
||
| 199 | * @param string $code |
||
| 200 | * |
||
| 201 | * @return \mathewparet\LaravelInvites\Model\Invite $invite |
||
| 202 | */ |
||
| 203 | public function find($code) |
||
| 204 | { |
||
| 205 | return Invite::whereCode($code)->firstOrFail(); |
||
| 206 | } |
||
| 207 | |||
| 208 | private function getEmailParameter($parameters) |
||
| 209 | { |
||
| 210 | return $parameters[0] ? : 'email' ; |
||
| 211 | } |
||
| 212 | |||
| 213 | public function validate($attribute, $value, $parameters, $validator) |
||
| 214 | { |
||
| 215 | $emailFieldName = $this->getEmailParameter($parameters); |
||
| 216 | |||
| 217 | try { |
||
| 218 | $email = $validator->data[$emailFieldName]; |
||
| 219 | |||
| 220 | $this->check($code, $email); |
||
| 221 | return true; |
||
| 222 | } |
||
| 223 | catch(InvalidInvitationCodeException $e) |
||
| 224 | { |
||
| 225 | $validator->errors()->add($emailFieldName, ':attribute is invalid'); |
||
| 226 | return false; |
||
| 227 | } |
||
| 228 | catch(InvitationNotYetActiveException $e) |
||
| 229 | { |
||
| 230 | $validator->errors()->add($emailFieldName, ':attribute is not valid yet'); |
||
| 231 | return false; |
||
| 232 | } |
||
| 233 | catch(InvitationExpiredException $e) |
||
| 234 | { |
||
| 235 | $validator->errors()->add($emailFieldName, ':attribute expired'); |
||
| 236 | return false; |
||
| 237 | } |
||
| 238 | catch(InvitationNotValidWithEmailException $e) |
||
| 239 | { |
||
| 240 | $validator->errors()->add($emailFieldName, ':attribute is not valid with the provided '.$emailFieldName); |
||
| 241 | return false; |
||
| 242 | } |
||
| 243 | catch(MaximumUseOfCodeException $e) |
||
| 244 | { |
||
| 245 | $validator->errors()->add($emailFieldName, ':attribute has been used for the maximum possible times'); |
||
| 246 | return false; |
||
| 247 | } |
||
| 248 | } |
||
| 249 | |||
| 250 | /** |
||
| 251 | * Check whether an invitation is valid with the provided email |
||
| 252 | * |
||
| 253 | * @param string $code |
||
| 254 | * @param string $email to be checked against |
||
| 255 | */ |
||
| 256 | |||
| 257 | public function isValid($code, $email = null) |
||
| 268 | } |
||
| 269 | } |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Check the validity of the invitiation code |
||
| 273 | * |
||
| 274 | * @param string $code |
||
| 275 | * @param string $email |
||
| 276 | */ |
||
| 277 | public function check($code, $email=null) |
||
| 278 | { |
||
| 279 | $invite = Invite::whereCode($code)->first(); |
||
| 280 | |||
| 281 | if(!$invite) |
||
| 282 | throw new InvalidInvitationCodeException; |
||
| 283 | |||
| 284 | if($invite->valid_from > now()) |
||
| 285 | throw new InvitationNotYetActiveException($invite->valid_from); |
||
| 286 | |||
| 287 | if($invite->valid_upto && $invite->valid_upto <= now()) |
||
| 288 | throw new InvitationExpiredException($invite->valid_upto); |
||
| 289 | |||
| 290 | if($invite->used_count > ($invite->allowed_count-1)) |
||
| 291 | throw new MaximumUseOfCodeException($invite->allowed_count); |
||
| 292 | |||
| 293 | if($invite->email !== $email && !blank($invite->email)) |
||
| 294 | throw new InvitationNotValidWithEmailException($email, $invite->email); |
||
| 295 | |||
| 296 | return true; |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * Redeem the invitation code. Make sure the form field is validated before this calls to avoid exceptions |
||
| 301 | * |
||
| 302 | * @param string $code |
||
| 303 | * @param string $email (optional) |
||
| 304 | * |
||
| 305 | * @return mixed |
||
| 306 | */ |
||
| 307 | |||
| 308 | public function redeem($code, $email = null) |
||
| 309 | { |
||
| 310 | $this->check($code, $email); |
||
| 311 | |||
| 312 | $this->find($code)->redeem(); |
||
| 313 | |||
| 314 | return true; |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Set a validity start date for the invitation |
||
| 319 | * |
||
| 320 | * @param \Carbon\Carbon $date |
||
| 321 | */ |
||
| 322 | public function notBefore(Carbon $date) |
||
| 326 | } |
||
| 327 | |||
| 328 | } |
Loading history...
Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct.