Skip to content

Commit 526d969

Browse files
jay-oswaldjay-oswald
committed
Add placeholder phpdocs
1 parent 183827f commit 526d969

File tree

80 files changed

+1601
-70
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+1601
-70
lines changed

‎classes/azure_file_system.php

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727

2828
use tool_objectfs\local\store\azure\file_system;
2929

30+
/**
31+
* Unknown?
32+
*/
3033
class azure_file_system extends file_system {
3134

3235
}

‎classes/digitalocean_file_system.php

+4
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,17 @@
1919
*
2020
* @package tool_objectfs
2121
* @author Brian Yanosik <[email protected]>
22+
* @copyright Catalyst IT
2223
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2324
*/
2425

2526
namespace tool_objectfs;
2627

2728
use tool_objectfs\local\store\digitalocean\file_system;
2829

30+
/**
31+
* Unknown?
32+
*/
2933
class digitalocean_file_system extends file_system {
3034

3135
}

‎classes/local/manager.php

+16-6
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,15 @@
3030

3131
defined('MOODLE_INTERNAL') || die();
3232

33+
/**
34+
* [Description manager]
35+
*/
3336
class manager {
3437

3538
/**
36-
* @param $config
39+
* set_objectfs_config
40+
* @param stdClass $config
41+
* @return void
3742
*/
3843
public static function set_objectfs_config($config) {
3944
foreach ($config as $key => $value) {
@@ -42,6 +47,7 @@ public static function set_objectfs_config($config) {
4247
}
4348

4449
/**
50+
* get_objectfs_config
4551
* @return stdClass
4652
* @throws \dml_exception
4753
*/
@@ -114,8 +120,9 @@ public static function get_objectfs_config() {
114120
}
115121

116122
/**
117-
* @param $config
118-
* @return bool
123+
* get_client
124+
* @param stdClass $config
125+
* @return mixed|bool
119126
*/
120127
public static function get_client($config) {
121128
$clientclass = self::get_client_classname_from_fs($config->filesystem);
@@ -128,8 +135,9 @@ public static function get_client($config) {
128135
}
129136

130137
/**
131-
* @param $contenthash
132-
* @param $newlocation
138+
* update_object_by_hash
139+
* @param string $contenthash
140+
* @param string $newlocation
133141
* @param int|null $filesize Size of the file in bytes. Falls back to stored value if not provided.
134142
* @return mixed|stdClass
135143
* @throws \dml_exception
@@ -172,8 +180,9 @@ public static function update_object_by_hash($contenthash, $newlocation, $filesi
172180
}
173181

174182
/**
183+
* update_object
175184
* @param stdClass $object
176-
* @param $newlocation
185+
* @param string $newlocation
177186
* @return stdClass
178187
* @throws \dml_exception
179188
*/
@@ -192,6 +201,7 @@ public static function update_object(stdClass $object, $newlocation) {
192201
}
193202

194203
/**
204+
* cloudfront_pem_exists
195205
* @return string
196206
* @throws \coding_exception
197207
* @throws \dml_exception

‎classes/local/object_manipulator/candidates/candidates_factory.php

+6-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
use tool_objectfs\local\object_manipulator\recoverer;
3434
use tool_objectfs\local\object_manipulator\orphaner;
3535

36+
/**
37+
* Candiates Factory
38+
*/
3639
class candidates_factory {
3740

3841
/** @var array $manipulatormap */
@@ -46,8 +49,10 @@ class candidates_factory {
4649
];
4750

4851
/**
49-
* @param $manipulator
52+
* Finder
53+
* @param mixed $manipulator
5054
* @param stdClass $config
55+
*
5156
* @return mixed
5257
* @throws moodle_exception
5358
*/

‎classes/local/object_manipulator/candidates/candidates_finder.php

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
use moodle_exception;
2828
use stdClass;
2929

30+
/**
31+
* Candiates Finder
32+
*/
3033
class candidates_finder {
3134

3235
/** @var string $finder */
@@ -43,13 +46,15 @@ public function __construct($manipulator, stdClass $config) {
4346
}
4447

4548
/**
49+
* get
4650
* @return array
4751
*/
4852
public function get() {
4953
return $this->finder->get();
5054
}
5155

5256
/**
57+
* get_query_name
5358
* @return string
5459
*/
5560
public function get_query_name() {

‎classes/local/object_manipulator/candidates/checker_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@
2424

2525
namespace tool_objectfs\local\object_manipulator\candidates;
2626

27+
/**
28+
* chcker_candiates
29+
*/
2730
class checker_candidates extends manipulator_candidates_base {
2831

29-
/** @var string $queryname */
32+
/**
33+
* queryname
34+
* @var string
35+
*/
3036
protected $queryname = 'get_check_candidates';
3137

3238
/**
33-
* @inheritDoc
39+
* get_candiates_sql
3440
* @return string
3541
*/
3642
public function get_candidates_sql() {
@@ -43,7 +49,7 @@ public function get_candidates_sql() {
4349
}
4450

4551
/**
46-
* @inheritDoc
52+
* get_candidates_sql_params
4753
* @return array
4854
*/
4955
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/candidates/deleter_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@
2424

2525
namespace tool_objectfs\local\object_manipulator\candidates;
2626

27+
/**
28+
* deleter_candidates
29+
*/
2730
class deleter_candidates extends manipulator_candidates_base {
2831

29-
/** @var string $queryname */
32+
/**
33+
* queryname
34+
* @var string
35+
*/
3036
protected $queryname = 'get_delete_candidates';
3137

3238
/**
33-
* @inheritDoc
39+
* get_candiates_sql
3440
* @return string
3541
*/
3642
public function get_candidates_sql() {
@@ -43,7 +49,7 @@ public function get_candidates_sql() {
4349
}
4450

4551
/**
46-
* @inheritDoc
52+
* get_candiates_sql_params
4753
* @return array
4854
*/
4955
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/candidates/manipulator_candidates.php

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public function get_candidates_sql();
5050
public function get_candidates_sql_params();
5151

5252
/**
53+
* get
5354
* @return array
5455
* @throws dml_exception
5556
*/

‎classes/local/object_manipulator/candidates/manipulator_candidates_base.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
use dml_exception;
2828
use stdClass;
2929

30+
/**
31+
* manipulator_candidates_base
32+
*/
3033
abstract class manipulator_candidates_base implements manipulator_candidates {
3134

3235
/** @var stdClass $config */
@@ -41,14 +44,15 @@ public function __construct(stdClass $config) {
4144
}
4245

4346
/**
44-
* @inheritDoc
47+
* get_query_name
4548
* @return string
4649
*/
4750
public function get_query_name() {
4851
return $this->queryname;
4952
}
5053

5154
/**
55+
* get
5256
* @return array
5357
* @throws dml_exception
5458
*/

‎classes/local/object_manipulator/candidates/orphaner_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@
2424

2525
namespace tool_objectfs\local\object_manipulator\candidates;
2626

27+
/**
28+
* orphaner_candidates
29+
*/
2730
class orphaner_candidates extends manipulator_candidates_base {
2831

29-
/** @var string $queryname */
32+
/**
33+
* queryname
34+
* @var string
35+
*/
3036
protected $queryname = 'get_orphan_candidates';
3137

3238
/**
33-
* @inheritDoc
39+
* get_candidates_sql
3440
* @return string
3541
*/
3642
public function get_candidates_sql() {
@@ -42,7 +48,7 @@ public function get_candidates_sql() {
4248
}
4349

4450
/**
45-
* @inheritDoc
51+
* get_candidates_sql_params
4652
* @return array
4753
*/
4854
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/candidates/puller_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@
2424

2525
namespace tool_objectfs\local\object_manipulator\candidates;
2626

27+
/**
28+
* puller_candidates
29+
*/
2730
class puller_candidates extends manipulator_candidates_base {
2831

29-
/** @var string $queryname */
32+
/**
33+
* queryname
34+
* @var string
35+
*/
3036
protected $queryname = 'get_pull_candidates';
3137

3238
/**
33-
* @inheritDoc
39+
* get_candidates_sql
3440
* @return string
3541
*/
3642
public function get_candidates_sql() {
@@ -42,7 +48,7 @@ public function get_candidates_sql() {
4248
}
4349

4450
/**
45-
* @inheritDoc
51+
* get_candidates_sql_params
4652
* @return array
4753
*/
4854
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/candidates/pusher_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,19 @@
2626

2727
defined('MOODLE_INTERNAL') || die();
2828

29+
/**
30+
* pusher_candidates
31+
*/
2932
class pusher_candidates extends manipulator_candidates_base {
3033

31-
/** @var string $queryname */
34+
/**
35+
* queryname
36+
* @var string
37+
*/
3238
protected $queryname = 'get_push_candidates';
3339

3440
/**
35-
* @inheritDoc
41+
* get_candidates_sql
3642
* @return string
3743
*/
3844
public function get_candidates_sql() {
@@ -46,7 +52,7 @@ public function get_candidates_sql() {
4652
}
4753

4854
/**
49-
* @inheritDoc
55+
* get_candidates_sql_params
5056
* @return array
5157
*/
5258
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/candidates/recoverer_candidates.php

+9-3
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,19 @@
2424

2525
namespace tool_objectfs\local\object_manipulator\candidates;
2626

27+
/**
28+
* recoverer_candidates
29+
*/
2730
class recoverer_candidates extends manipulator_candidates_base {
2831

29-
/** @var string $queryname */
32+
/**
33+
* queryname
34+
* @var string
35+
*/
3036
protected $queryname = 'get_recover_candidates';
3137

3238
/**
33-
* @inheritDoc
39+
* get_candidates_sql
3440
* @return string
3541
*/
3642
public function get_candidates_sql() {
@@ -41,7 +47,7 @@ public function get_candidates_sql() {
4147
}
4248

4349
/**
44-
* @inheritDoc
50+
* get_candidates_sql_params
4551
* @return array
4652
*/
4753
public function get_candidates_sql_params() {

‎classes/local/object_manipulator/checker.php

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
use tool_objectfs\local\store\object_file_system;
3030
use tool_objectfs\log\aggregate_logger;
3131

32+
/**
33+
* checker
34+
*/
3235
class checker extends manipulator {
3336

3437
/**
@@ -45,6 +48,7 @@ public function __construct(object_file_system $filesystem, stdClass $config, ag
4548
}
4649

4750
/**
51+
* manipulate_object
4852
* @param stdClass $objectrecord
4953
* @return int
5054
*/

0 commit comments

Comments
 (0)