Skip to content
This repository was archived by the owner on Apr 24, 2020. It is now read-only.

Commit c5b4f60

Browse files
stevebaumanstevebauman
committed
Added TaskTrigger class to handle task trigger generation
1 parent 0d154f6 commit c5b4f60

File tree

3 files changed

+231
-36
lines changed

3 files changed

+231
-36
lines changed

‎app/System/GeneratesXml.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
namespace App\System;
4+
5+
use Spatie\ArrayToXml\ArrayToXml;
6+
7+
trait GeneratesXml
8+
{
9+
/**
10+
* The XML template.
11+
*
12+
* @return array
13+
*/
14+
abstract public function template();
15+
16+
/**
17+
* The root XML attributes.
18+
*
19+
* @return array
20+
*/
21+
public function rootAttributes()
22+
{
23+
return [];
24+
}
25+
26+
/**
27+
* Generates XML based on the template.
28+
*
29+
* @return string
30+
*/
31+
public function toXml()
32+
{
33+
return ArrayToXml::convert(
34+
$this->template(),
35+
$this->rootAttributes(),
36+
$replaceSpacesByUnderScoresInKeyNames = true,
37+
$xmlEncoding = 'UTF-16',
38+
$xmlVersion = '1.0',
39+
['formatOutput' => true]
40+
);
41+
}
42+
}

‎app/System/ScheduledTask.php

+57-36
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
use Illuminate\Support\Str;
66
use Illuminate\Support\Fluent;
77
use Illuminate\Support\Facades\File;
8-
use Spatie\ArrayToXml\ArrayToXml;
98
use Symfony\Component\Process\PhpExecutableFinder;
109

11-
abstract class ScheduledTask extends Fluent
10+
class ScheduledTask extends Fluent
1211
{
12+
use GeneratesXml;
13+
1314
/**
1415
* The format to use for the scheduled task dates.
1516
*
@@ -26,7 +27,7 @@ public function create()
2627
{
2728
$path = $this->path();
2829

29-
File::put($path, $this->generate());
30+
File::put($path, $this->toXml());
3031

3132
return $path;
3233
}
@@ -62,20 +63,60 @@ public function command()
6263
}
6364

6465
/**
65-
* Generate the XML document.
66+
* Get the triggers for the scheduled task.
6667
*
67-
* @return string
68+
* @return TaskTrigger[]
69+
*/
70+
public function triggers()
71+
{
72+
return [
73+
// We will enable a registration trigger to trigger the task
74+
// as soon as it's imported. Then, the boot trigger will
75+
// take over if the server is ever restarted.
76+
TaskTrigger::registration([
77+
'Repetition' => [
78+
'Interval' => $this->interval,
79+
'StopAtDurationEnd' => 'false',
80+
],
81+
'StartBoundary' => $this->getStartDate(),
82+
]),
83+
TaskTrigger::boot([
84+
'Repetition' => [
85+
'Interval' => $this->interval,
86+
'StopAtDurationEnd' => 'false',
87+
],
88+
'StartBoundary' => $this->getStartDate(),
89+
]),
90+
// We will create a daily calendar trigger to regularly try starting
91+
// the task in case it fails. This trigger should begin once the
92+
// task is imported for the first time.
93+
TaskTrigger::calendar([
94+
'Repetition' => [
95+
'Interval' => $this->interval,
96+
'StopAtDurationEnd' => 'false',
97+
],
98+
'StartBoundary' => $this->getStartDate(),
99+
'ScheduleByDay' => [
100+
'DaysInterval' => 1
101+
],
102+
]),
103+
];
104+
}
105+
106+
/**
107+
* Get the scheduled task triggers mapped via key.
108+
*
109+
* @return array
68110
*/
69-
public function generate()
111+
protected function getMappedTriggers()
70112
{
71-
return ArrayToXml::convert(
72-
$this->template(),
73-
$this->rootAttributes(),
74-
$replaceSpacesByUnderScoresInKeyNames = true,
75-
$xmlEncoding = 'UTF-16',
76-
$xmlVersion = '1.0',
77-
['formatOutput' => true]
78-
);
113+
$triggers = [];
114+
115+
foreach ($this->triggers() as $trigger) {
116+
$triggers[$trigger->getRootElementName()] = $trigger->toArray();
117+
}
118+
119+
return $triggers;
79120
}
80121

81122
/**
@@ -85,7 +126,7 @@ public function generate()
85126
*/
86127
protected function getStartDate()
87128
{
88-
return $this->get('start', now()->format($this->dateFormat));
129+
return $this->get('start', now()->subMinute()->format($this->dateFormat));
89130
}
90131

91132
/**
@@ -102,27 +143,7 @@ protected function template()
102143
'Description' => $this->description,
103144
'URI' => Str::start($this->name, '\\'),
104145
],
105-
'Triggers' => [
106-
// We will enable a registration trigger to trigger the task as soon
107-
// as it's imported. Then, the calendar trigger will take over.
108-
'RegistrationTrigger' => [
109-
'Enabled' => 'true',
110-
],
111-
// We will create a daily calendar trigger to regularly try starting
112-
// the task in case it fails. This trigger should begin once the
113-
// task is imported for the first time.
114-
'CalendarTrigger' => [
115-
'Repetition' => [
116-
'Interval' => $this->interval,
117-
'StopAtDurationEnd' => 'false',
118-
],
119-
'StartBoundary' => $this->getStartDate(),
120-
'Enabled' => 'true',
121-
'ScheduleByDay' => [
122-
'DaysInterval' => 1
123-
],
124-
],
125-
],
146+
'Triggers' => $this->getMappedTriggers(),
126147
'Principals' => [
127148
'Principal' => [
128149
'_attributes' => [

‎app/System/TaskTrigger.php

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<?php
2+
3+
namespace App\System;
4+
5+
use Illuminate\Support\Fluent;
6+
7+
class TaskTrigger extends Fluent
8+
{
9+
/**
10+
* The default task attributes.
11+
*
12+
* @var array
13+
*/
14+
protected $attributes = [
15+
'Enabled' => 'true',
16+
];
17+
18+
/**
19+
* Get the root element name of the trigger.
20+
*
21+
* @var string|null
22+
*/
23+
protected $rootElementName;
24+
25+
/**
26+
* Generate a calendar trigger.
27+
*
28+
* @param array $attributes
29+
*
30+
* @return static
31+
*/
32+
public static function calendar(array $attributes = [])
33+
{
34+
return (new static($attributes))->setRootElementName('CalendarTrigger');
35+
}
36+
37+
/**
38+
* Generate a boot trigger.
39+
*
40+
* @param array $attributes
41+
*
42+
* @return static
43+
*/
44+
public static function boot(array $attributes = [])
45+
{
46+
return (new static($attributes))->setRootElementName('BootTrigger');
47+
}
48+
49+
/**
50+
* Generate a logon trigger.
51+
*
52+
* @param array $attributes
53+
*
54+
* @return static
55+
*/
56+
public static function logon(array $attributes = [])
57+
{
58+
return (new static($attributes))->setRootElementName('LogonTrigger');
59+
}
60+
61+
/**
62+
* Generate an idle trigger.
63+
*
64+
* @param array $attributes
65+
*
66+
* @return static
67+
*/
68+
public static function idle(array $attributes = [])
69+
{
70+
return (new static($attributes))->setRootElementName('IdleTrigger');
71+
}
72+
73+
/**
74+
* Generate an event trigger.
75+
*
76+
* @param array $attributes
77+
*
78+
* @return static
79+
*/
80+
public static function event(array $attributes = [])
81+
{
82+
return (new static($attributes))->setRootElementName('EventTrigger');
83+
}
84+
85+
/**
86+
* Generate a registration trigger.
87+
*
88+
* @param array $attributes
89+
*
90+
* @return static
91+
*/
92+
public static function registration(array $attributes = [])
93+
{
94+
return (new static($attributes))->setRootElementName('RegistrationTrigger');
95+
}
96+
97+
/**
98+
* Generate a state change trigger.
99+
*
100+
* @param array $attributes
101+
*
102+
* @return static
103+
*/
104+
public static function sessionStateChange(array $attributes = [])
105+
{
106+
return (new static($attributes))->setRootElementName('SessionStateChangeTrigger');
107+
}
108+
109+
/**
110+
* Set the root task element name.
111+
*
112+
* @param string $name
113+
*
114+
* @return $this
115+
*/
116+
public function setRootElementName($name)
117+
{
118+
$this->rootElementName = $name;
119+
120+
return $this;
121+
}
122+
123+
/**
124+
* Get the task root element name.
125+
*
126+
* @return string|null
127+
*/
128+
public function getRootElementName()
129+
{
130+
return $this->rootElementName;
131+
}
132+
}

0 commit comments

Comments
 (0)