Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AIDAPP-372]: Introduce sub categories that can be created and applied to knowledge base articles #351

Merged
merged 8 commits into from
Dec 11, 2024
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php

/*
<COPYRIGHT>

Copyright © 2016-2024, Canyon GBS LLC. All rights reserved.

Aiding App™ is licensed under the Elastic License 2.0. For more details,
see <https://github.com/canyongbs/aidingapp/blob/main/LICENSE.>

Notice:

- You may not provide the software to third parties as a hosted or managed
service, where the service provides users with access to any substantial set of
the features or functionality of the software.
- You may not move, change, disable, or circumvent the license key functionality
in the software, and you may not remove or obscure any functionality in the
software that is protected by the license key.
- You may not alter, remove, or obscure any licensing, copyright, or other notices
of the licensor in the software. Any use of the licensor’s trademarks is subject
to applicable law.
- Canyon GBS LLC respects the intellectual property rights of others and expects the
same in return. Canyon GBS™ and Aiding App™ are registered trademarks of
Canyon GBS LLC, and we are committed to enforcing and protecting our trademarks
vigorously.
- The software solution, including services, infrastructure, and code, is offered as a
Software as a Service (SaaS) by Canyon GBS LLC.
- Use of this software implies agreement to the license terms and conditions as stated
in the Elastic License 2.0.

For more information or inquiries please visit our website at
<https://www.canyongbs.com> or contact us via email at [email protected].

</COPYRIGHT>
*/

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

return new class () extends Migration {
public function up(): void
{
Schema::table('knowledge_base_categories', function (Blueprint $table) {
$table->foreignUuid('parent_id')->nullable()->constrained('knowledge_base_categories');
});
}

public function down(): void
{
Schema::table('knowledge_base_categories', function (Blueprint $table) {
$table->dropConstrainedForeignId('parent_id');
});
}
};
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
use AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource\Pages\ViewKnowledgeBaseCategory;
use AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource\Pages\CreateKnowledgeBaseCategory;
use AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource\Pages\ListKnowledgeBaseCategories;
use AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource\RelationManagers\SubCategoriesRelationManager;

class KnowledgeBaseCategoryResource extends Resource
{
Expand All @@ -65,4 +66,11 @@ public static function getPages(): array
'edit' => EditKnowledgeBaseCategory::route('/{record}/edit'),
];
}

public static function getRelations(): array
{
return [
SubCategoriesRelationManager::class,
];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ public function form(Form $form): Form
]);
}

public static function getNavigationLabel(): string
{
return 'Edit';
}

protected function getHeaderActions(): array
{
return [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
use Filament\Tables\Columns\TextColumn;
use App\Filament\Tables\Columns\IdColumn;
use Filament\Resources\Pages\ListRecords;
use Illuminate\Database\Eloquent\Builder;
use App\Features\KnowledgeBaseSubcategory;
use Filament\Tables\Actions\BulkActionGroup;
use Filament\Tables\Actions\DeleteBulkAction;
use AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource;
Expand All @@ -55,6 +57,9 @@ class ListKnowledgeBaseCategories extends ListRecords
public function table(Table $table): Table
{
return $table
->modifyQueryUsing(
fn (Builder $query) => $query->when(KnowledgeBaseSubcategory::active(), fn (Builder $query) => $query->doesntHave('parentCategory'))
)
->columns([
IdColumn::make(),
TextColumn::make('name')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ public function infolist(Infolist $infolist): Infolist
]);
}

public static function getNavigationLabel(): string
{
return 'View';
}

protected function getHeaderActions(): array
{
return [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
<?php

/*
<COPYRIGHT>

Copyright © 2016-2024, Canyon GBS LLC. All rights reserved.

Aiding App™ is licensed under the Elastic License 2.0. For more details,
see <https://github.com/canyongbs/aidingapp/blob/main/LICENSE.>

Notice:

- You may not provide the software to third parties as a hosted or managed
service, where the service provides users with access to any substantial set of
the features or functionality of the software.
- You may not move, change, disable, or circumvent the license key functionality
in the software, and you may not remove or obscure any functionality in the
software that is protected by the license key.
- You may not alter, remove, or obscure any licensing, copyright, or other notices
of the licensor in the software. Any use of the licensor’s trademarks is subject
to applicable law.
- Canyon GBS LLC respects the intellectual property rights of others and expects the
same in return. Canyon GBS™ and Aiding App™ are registered trademarks of
Canyon GBS LLC, and we are committed to enforcing and protecting our trademarks
vigorously.
- The software solution, including services, infrastructure, and code, is offered as a
Software as a Service (SaaS) by Canyon GBS LLC.
- Use of this software implies agreement to the license terms and conditions as stated
in the Elastic License 2.0.

For more information or inquiries please visit our website at
<https://www.canyongbs.com> or contact us via email at [email protected].

</COPYRIGHT>
*/

namespace AidingApp\KnowledgeBase\Filament\Resources\KnowledgeBaseCategoryResource\RelationManagers;

use Filament\Forms\Form;
use Filament\Tables\Table;
use Filament\Infolists\Infolist;
use Filament\Forms\Components\Textarea;
use Filament\Tables\Actions\EditAction;
use Filament\Tables\Actions\ViewAction;
use Filament\Tables\Columns\IconColumn;
use Filament\Forms\Components\TextInput;
use Filament\Tables\Actions\ActionGroup;
use Filament\Tables\Actions\CreateAction;
use Filament\Tables\Actions\DeleteAction;
use Illuminate\Database\Eloquent\Builder;
use Filament\Infolists\Components\Section;
use Filament\Infolists\Components\TextEntry;
use Filament\Tables\Actions\AssociateAction;
use Filament\Tables\Actions\BulkActionGroup;
use App\Filament\Forms\Components\IconSelect;
use Filament\Tables\Actions\DeleteBulkAction;
use Filament\Tables\Actions\DissociateAction;
use Filament\Tables\Actions\DissociateBulkAction;
use App\Filament\Tables\Columns\OpenSearch\TextColumn;
use Filament\Resources\RelationManagers\RelationManager;
use AidingApp\KnowledgeBase\Models\KnowledgeBaseCategory;

class SubCategoriesRelationManager extends RelationManager
{
protected static string $relationship = 'subCategories';

protected static ?string $inverseRelationship = 'parentCategory';

public function infolist(Infolist $infolist): Infolist
{
return $infolist
->schema([
Section::make()
->schema([
TextEntry::make('name')
->label('Name'),
TextEntry::make('icon')
->state(fn (KnowledgeBaseCategory $record): string => (string) str($record->icon)->after('heroicon-o-')->headline())
->icon(fn (KnowledgeBaseCategory $record): string => $record->icon)
->hidden(fn (KnowledgeBaseCategory $record): bool => blank($record->icon)),
TextEntry::make('description')
->label('Description')
->columnSpanFull(),
TextEntry::make('slug')
->hidden(fn (KnowledgeBaseCategory $record): bool => blank($record->slug)),
])
->columns(),
]);
}

public function form(Form $form): Form
{
return $form
->schema([
TextInput::make('name')
->label('Name')
->required()
->string(),
IconSelect::make('icon'),
TextInput::make('slug')
->regex('/^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$/')
->unique(ignoreRecord: true)
->maxLength(255)
->required()
->dehydrateStateUsing(fn (string $state): string => strtolower($state)),
Textarea::make('description')
->label('Description')
->nullable()
->string()
->columnSpanFull(),
]);
}

public function table(Table $table): Table
{
return $table
->recordTitleAttribute('name')
->heading('Subcategories')
->columns([
TextColumn::make('name'),
TextColumn::make('slug'),
IconColumn::make('icon')
->icon(fn (string $state): string => $state)
->tooltip(fn (?string $state): ?string => filled($state) ? (string) str($state)->after('heroicon-o-')->headline() : null),
])
->headerActions([
CreateAction::make()
->label('New Subcategory')
->modalHeading('Create knowledge base subcategory'),
AssociateAction::make()
->modalHeading('Associate knowledge base subcategory')
->preloadRecordSelect()
->recordSelectOptionsQuery(
fn (Builder $query) => $query->where('id', '!=', $this->getOwnerRecord()->getKey())
->doesntHave('parentCategory')
->doesntHave('subCategories')
),
])
->actions([
ActionGroup::make([
ViewAction::make(),
EditAction::make(),
DissociateAction::make(),
DeleteAction::make(),
]),
])
->bulkActions([
BulkActionGroup::make([
DissociateBulkAction::make(),
DeleteBulkAction::make(),
]),
]);
}
}
11 changes: 11 additions & 0 deletions app-modules/knowledge-base/src/Models/KnowledgeBaseCategory.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use AidingApp\Audit\Models\Concerns\Auditable as AuditableTrait;

/**
Expand All @@ -65,6 +66,16 @@ public function knowledgeBaseItems(): HasMany
return $this->hasMany(KnowledgeBaseItem::class, 'category_id');
}

public function parentCategory(): BelongsTo
{
return $this->belongsTo(self::class, 'parent_id', 'id');
}

public function subCategories(): HasMany
{
return $this->hasMany(self::class, 'parent_id');
}

protected function serializeDate(DateTimeInterface $date): string
{
return $date->format(config('project.datetime_format') ?? 'Y-m-d H:i:s');
Expand Down
Loading