These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | use Illuminate\Console\Command; |
||
4 | use Indatus\Dispatcher\Drivers\Cron\Scheduler; |
||
5 | use Indatus\Dispatcher\Scheduling\ScheduledCommandInterface; |
||
6 | use Symfony\Component\Console\Input\InputOption; |
||
7 | use Symfony\Component\Console\Input\InputArgument; |
||
8 | |||
9 | class ScrapeEarningsCommand extends Command implements ScheduledCommandInterface { |
||
10 | |||
11 | /** |
||
12 | * The console command name. |
||
13 | * |
||
14 | * @var string |
||
15 | */ |
||
16 | protected $name = 'scrape:earnings'; |
||
17 | |||
18 | /** |
||
19 | * The console command description. |
||
20 | * |
||
21 | * @var string |
||
22 | */ |
||
23 | protected $description = 'Scrape earnings data'; |
||
24 | |||
25 | /** |
||
26 | * Execute the console command. |
||
27 | * |
||
28 | * @return mixed |
||
29 | */ |
||
30 | public function fire() { |
||
31 | $days = $this->getDatesToScrape(); |
||
32 | $delay = 2; |
||
33 | |||
34 | /** @type Carbon $day */ |
||
35 | foreach($days as $day) { |
||
36 | $delay += rand(1, 5); |
||
37 | Queue::later($delay, 'EarningsScraperWorker', ['day' => $day->toDateTimeString()]); |
||
38 | } |
||
39 | } |
||
40 | |||
41 | /** |
||
42 | * Generate days to scrape. Either based on date (w/ weekend option) or yesterday. |
||
43 | * If yesterday is a weekend it's auto-implied. |
||
44 | * For weekends get the previous week's Fri-Sun based on Mon-Sun week. |
||
45 | * |
||
46 | * @return array |
||
47 | */ |
||
48 | public function getDatesToScrape() { |
||
49 | // Base to scrape from |
||
50 | if($this->argument('date')) { |
||
51 | $base = Carbon::parse($this->argument('date'), 'America/Los_Angeles'); |
||
52 | } else { |
||
53 | $base = Carbon::yesterday('America/Los_Angeles'); |
||
54 | } |
||
55 | |||
56 | // Get the weekend range if required |
||
57 | if($this->option('weekend') || (!$this->argument('date') && $base->isWeekend())) { |
||
58 | if($base->dayOfWeek < Carbon::FRIDAY) { |
||
59 | return [ |
||
60 | $base->copy()->modify('Friday last week'), |
||
61 | $base->copy()->modify('Saturday last week'), |
||
62 | $base->copy()->modify('Sunday last week'), |
||
63 | ]; |
||
64 | } else { |
||
65 | return [ |
||
66 | $base->copy()->modify('Friday this week'), |
||
67 | $base->copy()->modify('Saturday this week'), |
||
68 | $base->copy()->modify('Sunday this week'), |
||
69 | ]; |
||
70 | } |
||
71 | } else { |
||
72 | return [$base]; |
||
73 | } |
||
74 | } |
||
75 | |||
76 | /** |
||
77 | * Get the console command arguments. |
||
78 | * |
||
79 | * @return array |
||
80 | */ |
||
81 | 9 | protected function getArguments() { |
|
82 | return [ |
||
83 | 9 | ['date', InputArgument::OPTIONAL, 'Date of which to scrape. Can be anything understood by strtotime', null], |
|
84 | 9 | ]; |
|
85 | } |
||
86 | |||
87 | /** |
||
88 | * Get the console command options. |
||
89 | * |
||
90 | * @return array |
||
91 | */ |
||
92 | 9 | protected function getOptions() { |
|
93 | return [ |
||
94 | 9 | ['weekend', null, InputOption::VALUE_NONE, 'Whether to scrape the whole weekend', null], |
|
95 | 9 | ]; |
|
96 | } |
||
97 | |||
98 | /** |
||
99 | * User to run the command as |
||
100 | * @return string Defaults to false to run as default user |
||
101 | */ |
||
102 | public function user() { |
||
103 | return false; |
||
0 ignored issues
–
show
|
|||
104 | } |
||
105 | |||
106 | /** |
||
107 | * When a command should run |
||
108 | * |
||
109 | * @param Scheduler|\Indatus\Dispatcher\Scheduling\Schedulable $scheduler |
||
110 | * |
||
111 | * @return \Indatus\Dispatcher\Scheduling\Schedulable|\Indatus\Dispatcher\Scheduling\Schedulable[] |
||
112 | */ |
||
113 | public function schedule(\Indatus\Dispatcher\Scheduling\Schedulable $scheduler) { |
||
114 | /* |
||
115 | * Scheduler based on GMT while earnings scraper is based on Los Angeles |
||
116 | * |
||
117 | * Skip Saturday & Sunday (Weekend Estimates) |
||
118 | */ |
||
119 | return [ |
||
120 | $scheduler->getNewSchedulerClass()->daily()->everyWeekday()->hours([18]), |
||
121 | $scheduler->getNewSchedulerClass()->daily()->daysOfTheWeek(Scheduler::TUESDAY .'-'. Scheduler::SATURDAY)->hours([0, 5]), |
||
122 | ]; |
||
123 | } |
||
124 | |||
125 | /** |
||
126 | * Environment(s) under which the given command should run |
||
127 | * Defaults to '*' for all environments |
||
128 | * @return string|array |
||
129 | */ |
||
130 | public function environment() { |
||
131 | return '*'; |
||
132 | } |
||
133 | } |
||
134 |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.