Skip to content

Commit f09fdaf

Browse files
neelkanthkneelkanthk
neelkanthk
and
neelkanthk
authored
refactor: Some code and documentation updates (#985)
* Some housekeeping and documentation updates * Code style fixes * Code style fixes * Code style fixes * Code style fixes * Change in APIRequest Class Co-authored-by: neelkanthk <[email protected]>
1 parent e3d2aab commit f09fdaf

14 files changed

+230
-80
lines changed

‎src/Criteria/LimitOffsetCriteria.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ public function __construct(Request $request)
2727
*/
2828
public function apply($model, \Prettus\Repository\Contracts\RepositoryInterface $repository)
2929
{
30-
$limit = $this->request->get('limit', null);
31-
$offset = $this->request->get('offset', null);
30+
$limit = (int) $this->request->get('limit', null);
31+
$offset = (int) $this->request->get('offset', null);
3232

3333
if ($limit) {
3434
$model = $model->limit($limit);

‎src/Events/GeneratorFileCreated.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ class GeneratorFileCreated
1111
{
1212
use SerializesModels;
1313

14+
/**
15+
* Type of event.
16+
*
17+
* @var string
18+
*/
1419
public $type;
20+
21+
/**
22+
* Event payload.
23+
*
24+
* @var array
25+
*/
1526
public $data;
1627

1728
/**

‎src/Events/GeneratorFileCreating.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ class GeneratorFileCreating
1111
{
1212
use SerializesModels;
1313

14+
/**
15+
* Type of event.
16+
*
17+
* @var string
18+
*/
1419
public $type;
20+
21+
/**
22+
* Event payload.
23+
*
24+
* @var array
25+
*/
1526
public $data;
1627

1728
/**

‎src/Events/GeneratorFileDeleted.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ class GeneratorFileDeleted
1111
{
1212
use SerializesModels;
1313

14+
/**
15+
* Type of event.
16+
*
17+
* @var string
18+
*/
1419
public $type;
20+
21+
/**
22+
* Event payload.
23+
*
24+
* @var array
25+
*/
1526
public $data;
1627

1728
/**

‎src/Events/GeneratorFileDeleting.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ class GeneratorFileDeleting
1111
{
1212
use SerializesModels;
1313

14+
/**
15+
* Type of event.
16+
*
17+
* @var string
18+
*/
1419
public $type;
20+
21+
/**
22+
* Event payload.
23+
*
24+
* @var array
25+
*/
1526
public $data;
1627

1728
/**

‎src/Generators/API/APIControllerGenerator.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
2424
$this->fileName = $this->commandData->modelName.'APIController.php';
2525
}
2626

27+
/**
28+
* Generate API Controller Class.
29+
*
30+
* @return void
31+
*/
2732
public function generate()
2833
{
2934
if ($this->commandData->getOption('repositoryPattern')) {
@@ -73,6 +78,11 @@ private function fillDocs($templateData)
7378
return $templateData;
7479
}
7580

81+
/**
82+
* Delete API Controller.
83+
*
84+
* @return void
85+
*/
7686
public function rollback()
7787
{
7888
if ($this->rollbackFile($this->path, $this->fileName)) {

‎src/Generators/API/APIRequestGenerator.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,22 @@ public function __construct(CommandData $commandData)
2929
$this->updateFileName = 'Update'.$this->commandData->modelName.'APIRequest.php';
3030
}
3131

32+
/**
33+
* Generate API Request Class.
34+
*
35+
* @return void
36+
*/
3237
public function generate()
3338
{
3439
$this->generateCreateRequest();
3540
$this->generateUpdateRequest();
3641
}
3742

43+
/**
44+
* Generate Create Request.
45+
*
46+
* @return void
47+
*/
3848
private function generateCreateRequest()
3949
{
4050
$templateData = get_template('api.request.create_request', 'laravel-generator');
@@ -47,6 +57,11 @@ private function generateCreateRequest()
4757
$this->commandData->commandInfo($this->createFileName);
4858
}
4959

60+
/**
61+
* Generate Update Request.
62+
*
63+
* @return void
64+
*/
5065
private function generateUpdateRequest()
5166
{
5267
$modelGenerator = new ModelGenerator($this->commandData);
@@ -63,6 +78,11 @@ private function generateUpdateRequest()
6378
$this->commandData->commandInfo($this->updateFileName);
6479
}
6580

81+
/**
82+
* Delete the generated Request Classes.
83+
*
84+
* @return void
85+
*/
6686
public function rollback()
6787
{
6888
if ($this->rollbackFile($this->path, $this->createFileName)) {

‎src/Generators/API/APIResourceGenerator.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
2424
$this->fileName = $this->commandData->modelName.'Resource.php';
2525
}
2626

27+
/**
28+
* Generate API Resources.
29+
*
30+
* @return void
31+
*/
2732
public function generate()
2833
{
2934
$templateData = get_template('api.resource.api_resource', 'laravel-generator');

‎src/Generators/API/APIRoutesGenerator.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ public function __construct(CommandData $commandData)
3636
$this->routesTemplate = fill_template($this->commandData->dynamicVars, $routesTemplate);
3737
}
3838

39+
/**
40+
* Generate API Routes.
41+
*
42+
* @return void
43+
*/
3944
public function generate()
4045
{
4146
$this->routeContents .= "\n\n".$this->routesTemplate;
@@ -51,6 +56,11 @@ public function generate()
5156
$this->commandData->commandComment("\n".$this->commandData->config->mCamelPlural.' api routes added.');
5257
}
5358

59+
/**
60+
* Remove API Routes.
61+
*
62+
* @return void
63+
*/
5464
public function rollback()
5565
{
5666
if (Str::contains($this->routeContents, $this->routesTemplate)) {

‎src/Generators/MigrationGenerator.php‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,22 @@ private function generateFields()
4747
$createdAtField = null;
4848
$updatedAtField = null;
4949

50-
foreach ($this->commandData->fields as $field) {
51-
if ($field->name == 'created_at') {
52-
$createdAtField = $field;
53-
continue;
54-
} else {
55-
if ($field->name == 'updated_at') {
56-
$updatedAtField = $field;
50+
if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
51+
foreach ($this->commandData->fields as $field) {
52+
if ($field->name == 'created_at') {
53+
$createdAtField = $field;
5754
continue;
55+
} else {
56+
if ($field->name == 'updated_at') {
57+
$updatedAtField = $field;
58+
continue;
59+
}
5860
}
59-
}
6061

61-
$fields[] = $field->migrationText;
62-
if (!empty($field->foreignKeyText)) {
63-
$foreignKeys[] = $field->foreignKeyText;
62+
$fields[] = $field->migrationText;
63+
if (!empty($field->foreignKeyText)) {
64+
$foreignKeys[] = $field->foreignKeyText;
65+
}
6466
}
6567
}
6668

@@ -91,18 +93,20 @@ public function rollback()
9193

9294
$files = [];
9395

94-
foreach ($allFiles as $file) {
95-
$files[] = $file->getFilename();
96-
}
96+
if (!empty($allFiles)) {
97+
foreach ($allFiles as $file) {
98+
$files[] = $file->getFilename();
99+
}
97100

98-
$files = array_reverse($files);
101+
$files = array_reverse($files);
99102

100-
foreach ($files as $file) {
101-
if (Str::contains($file, $fileName)) {
102-
if ($this->rollbackFile($this->path, $file)) {
103-
$this->commandData->commandComment('Migration file deleted: '.$file);
103+
foreach ($files as $file) {
104+
if (Str::contains($file, $fileName)) {
105+
if ($this->rollbackFile($this->path, $file)) {
106+
$this->commandData->commandComment('Migration file deleted: '.$file);
107+
}
108+
break;
104109
}
105-
break;
106110
}
107111
}
108112
}

0 commit comments

Comments
 (0)