/** Datei: plugins/contacts/library/ARUNOX/Plugins/Contacts/API/v1/Routes.php **/ * @copyright 2025 ARUNOX * @version 1.1.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Contacts\API\v1; use ARUNOX\Core\Hooks; use ARUNOX\Core\Router; use ARUNOX\Plugins\REST; class Routes { public static function register() : void { /* ### MAIN ROUTES ############################## # */ Router::addAll( Controller::class ); /* ### MENU ROUTES ############################## # */ Hooks::add('router::get->api.v1.rest.routes', function( $routes ) { $routes[] = [ "path" => "/contacts", "label" => "Kontakte", "icon" => "bi bi-journal-bookmark-fill", "menu" => "content", ]; return $routes; }); } } /** Datei: plugins/contacts/library/ARUNOX/Plugins/Contacts/API/v1/Controller.php **/ * @copyright 2025 ARUNOX * @version 1.1.0 * * @since 1.0.0 File is created */ namespace ARUNOX\Plugins\Contacts\API\v1; use ARUNOX\HTTP; use ARUNOX\API\PHP; use ARUNOX\Plugins; use ARUNOX\Core\Hooks; use ARUNOX\Plugins\REST; use ARUNOX\Plugins\Contacts; use ARUNOX\API\BaseController; use ARUNOX\Database\Attribute; use ARUNOX\Database\BaseEntity; #[PHP\Attributes\Controller\Label( "Kontakt", "Kontakte" )] #[PHP\Attributes\Controller\Icon( REST\Generator\Config\Icon::PersonVcard )] #[PHP\Attributes\Controller\Route( "contacts" )] class Controller extends BaseController { /* ### PUBLIC GET FUNCTIONS ##################################### # */ /** * @api * @method GET * * @route.path /contacts * @route.description Listet alle Kontakte */ public static function getAll() : array { return Contacts\Model::getAll(); } /** * @api * @method GET * * @route.path /contacts/{hashid} * @route.description Gibt einen einzelnen Kontakts anhand der ID zurück */ public static function get( int|string $hashid ) : BaseEntity | HTTP\Response { if( $result = Contacts\Model::get( $hashid ) ) return $result; return REST\Response::autoResponse( 404, static::getNotify("notfound") ); } /* ### PUBLIC SAVE FUNCTIONS #################################### # */ /** * @api * @method PUT * * @route.path /contacts/{hashid} * @route.description Speichert Änderungen an einem bestehenden Kontakts */ public static function save( int|string $hashid, array $data ) : HTTP\Response { if( $result = Contacts\Model::get( $hashid ) ) { if( $result->save( $data ) ) { return REST\Response::autoResponse( 200, static::getNotify("saved") ); } return REST\Response::autoResponse( 500, static::getNotify("notsaved") ); } return REST\Response::autoResponse( 404, static::getNotify("notfound") ); } /** * @api * @method POST * * @route.path /contacts * @route.description Erstellt einen neuen Kontakt */ public static function create( array $data ) : HTTP\Response { if( $hashid = Contacts\Model::save( $data ) ) { $result = Contacts\Model::get( $hashid ); return REST\Response::autoResponse( 200, static::getNotify("created" ), [ "data" => $result ] ); } return REST\Response::autoResponse( 500, static::getNotify("notfound") ); } /** * @api * @method DELETE * * @route.path /contacts/{hashid} * @route.description Löscht einen Kontakt anhand der ID */ public static function delete( int|string $hashid ) : HTTP\Response { if( Contacts\Model::delete( $hashid ) ) { return REST\Response::autoResponse( 200, static::getNotify("deleted") ); } return REST\Response::autoResponse( 500, static::getNotify("notfound") ); } /** * @api * @method PATCH * * @route.path /contacts/{hashid}/status * @route.description Wechselt den Status (aktiv/inaktiv) eines Kontakts */ public static function toggleStatus( int|string $hashid ) : HTTP\Response { if( $result = Contacts\Model::get( $hashid ) ) { $result->toggleStatus( TRUE ); return REST\Response::autoResponse( 200, static::getNotify("statuschanged.{$result->status->getValue()}" ), [ "data" => $result ] ); } return REST\Response::autoResponse( 404, static::getNotify("notfound") ); } /** * @api * @method PATCH * * @route.path /contacts/{hashid}/invoice * @route.description Wechselt den Status (aktiv/inaktiv) eines Kontakts */ public static function toggleInvoice( int|string $hashid ) : HTTP\Response { if( $result = Contacts\Model::get( $hashid ) ) { $result->toggleInvoice( TRUE ); return REST\Response::autoResponse( 200, static::getNotify("statuschanged.{$result->status->getValue()}" ), [ "data" => $result ] ); } return REST\Response::autoResponse( 404, static::getNotify("notfound") ); } /* ### PUBLIC VALIDATE FUNCTIONS ################################ # */ /* ### PUBLIC REST FUNCTIONS #################################### # */ /* ### PUBLIC REST RESPONSE FUNCTIONS ########################### # */ /** * @internal rest * @method PUT * * @route.path /contacts/{hashid} * @route.description REST-Antwort nach dem Speichern eines Kontakts */ public static function restResponseSave( int|string $hashid, array $data ) : HTTP\Response { $result = static::save( $hashid, $data ); if( $result->isStatus( 200 ) ) { $data = Contacts\Model::get( $hashid ); REST\Response::closeModals(); REST\Response::addUpdater( [ "data/table/row", $hashid ], $data ); } return static::restResponse( $result ); } /** * @internal rest * @method POST * * @route.path /contacts * @route.description REST-Antwort nach dem Erstellen eines Kontakts (inkl. Notifikation, Redirect etc.) */ public static function restResponseCreate( array $data ) : HTTP\Response { $result = static::create( $data ); if( $result->isStatus( 200 ) ) { REST\Response::closeModals(); REST\Response::redirect( "/contacts/{$result->getBody("data", "hashid")}" ); } return static::restResponse( $result ); } /** * @internal rest * @method DELETE * * @route.path /contacts/{hashid} * @route.description REST-Antwort nach dem Löschen eines Kontakts */ public static function restResponseDelete( int|string $hashid ) : HTTP\Response { REST\Response::closeModals(); $result = static::delete( $hashid ); if( $result->isStatus( 200 ) ) { REST\Response::redirect( "/contacts" ); } return static::restResponse( $result ); } /** * @internal rest * @method PATCH * * @route.path /contacts/{hashid}/status * @route.description REST-Antwort zur Status-Umschaltung eines Kontakts (z. B. für Notifications) */ public static function restResponseToggleStatus( int|string $hashid ) : HTTP\Response { $result = static::toggleStatus( $hashid ); if( $result->isStatus( 200 ) ) { $data = $result->getBody("data"); REST\Response::addUpdater( [ "data/table/row", $hashid ], $data ); } return static::restResponse( $result ); } /** * @internal rest * @method PATCH * * @route.path /contacts/{hashid}/invoice * @route.description REST-Antwort zur Status-Umschaltung eines Kontakts (z. B. für Notifications) */ public static function restResponseToggleInvoice( int|string $hashid ) : HTTP\Response { $result = static::toggleInvoice( $hashid ); if( $result->isStatus( 200 ) ) { $data = $result->getBody("data"); REST\Response::addUpdater( [ "data/table/row", $hashid ], $data ); } return static::restResponse( $result ); } /* ### PUBLIC REST CONFIG FUNCTIONS ############################# # */ /** * @internal rest * @method GET * * @route.path /contacts * @route.description REST-Konfiguration für Kontakt-Tabelle */ public static function restConfigOverview() : REST\Generator\Base\BaseGenerator { return REST\Response::addWrapper( "overview", static::getPlural() ) ->replaceContent( static::restConfigTable() ); } /** * @internal rest * @method GET * * @route.path /contacts/{hashid} * @route.alternative.0 /contacts/{hashid}#kontext * @route.alternative.1 /contacts/{hashid}#chat * @route.alternative.2 /contacts/{hashid}#telefon * @route.description REST-Konfiguration für Detailansicht eines Kontakts */ public static function restConfigDetails( int|string $hashid ) : REST\Generator\Base\BaseGenerator { if( Contacts\Model::isSubContact( $hashid ) ) { $origin = Contacts\Model::getParent( $hashid, "hashid" ); return Contacts\Contacts\API\v1\Controller::restConfigDetails( $origin, $hashid ); } $data = Contacts\Model::get( $hashid ); return REST\Response::addWrapper( "details", static::getSingular( "%t bearbeiten" ) ) ->setBacklink( "/contacts" ) ->get() ->setApi( "/contacts/{$hashid}" ) ->setAction( "/contacts/{$hashid}", "PUT" ) ->addTab( "Kontaktdaten", "contactdata" )->get() ->setIcon( "bi-person-vcard" ) ->addHeadline( "Kontakt", 2 ) ->addField(...Hooks::filter( "rest.generator::control.type->text", [], "company_name", FALSE, "contacts" )) ->addField(...Hooks::filter( "rest.generator::control.type->text", [], "firstname", FALSE, "contacts" )) ->addField(...Hooks::filter( "rest.generator::control.type->text", [], "lastname", FALSE, "contacts" )) ->addField(...Hooks::filter( "rest.generator::control.type->select", [ "options" => Attribute\Status::getAll(), ], "status", TRUE, FALSE, "contacts" )) ->parent() ->addTab( "Ansprechpartner", "contacts" )->get() ->setIcon( "bi-people" ) ->addContent( Contacts\Contacts\API\v1\Controller::restConfigTable( $hashid ) ) ->parent() ->addTab( "Adressen", "addresses" )->get() ->setIcon( "bi-geo-alt" ) ->addContent( Contacts\Addresses\API\v1\Controller::restConfigTable( $hashid ) ) ->parent() ->addCallable( [ Plugins\Logs\API\v1\Controller::class, "restConfigTab" ], $hashid ) ->addCallable( [ Plugins\Calendars\Entries\API\v1\Controller::class, "restConfigTab" ], $hashid ) ->addCallable( [ Plugins\Calendars\Tasks\API\v1\Controller::class, "restConfigTab" ], $hashid ) ->addTab( "Speichern" )->get() ->setColor( REST\Generator\Config\Color::Primary ) ->setIcon( "bi bi-save" ) ->setType( "submit" ); } /** * @internal rest * @method GET * * @route.path /contacts/create * @route.description REST-Konfiguration für das Erstellen eines Kontakts (Formular) */ public static function restConfigCreate() : REST\Generator\Base\BaseGenerator { return REST\Response::addModal( "details", static::getSingular( "%t erstellen" ) ) ->get() ->setAction( "/contacts", "POST" ) ->addButton(...Hooks::filter( "rest.generator::button.type->submit", [], "Erstellen", "contacts" )) ->addField(...Hooks::filter( "rest.generator::control.type->text", [], "name", TRUE, "contacts" )); } /** * @internal rest * @method GET * * @route.path /contacts/{hashid}/delete * @route.description REST-Konfiguration für die Lösch-Bestätigung eines Kontakts */ public static function restConfigDeletePrepared( string $hashid ) : REST\Generator\Base\BaseGenerator { return parent::restConfigDeletePrepared( $hashid ); } /* ### PUBLIC REST EXTENSION FUNCTIONS ########################## # */ public static function restConfigTable() : REST\Generator\Base\BaseGenerator { $table = REST\Generator\Data\Table::create() ->setApi( "/contacts" ) ->setAction( "/contacts/{hashid}" ) ->setOrder( "name", "asc" ) ->setSearch( TRUE ) ->addButton(...Hooks::filter( "rest.generator::button.name->create", [], "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->status", [], "status", [], "contacts", "hashid" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->icon", [ "label" => Contacts\Category::label(), "icon" => Contacts\Category::icon(), "options" => Contacts\Category::getAll(), ], "category", [], "contacts", "hashid" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->status", [ "label" => Contacts\Invoice::label(), "icon" => Contacts\Invoice::icon(), "options" => Contacts\Invoice::getAll(), ], "invoice", [], "contacts", "hashid" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "company_name", TRUE, TRUE, TRUE, "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "firstname", TRUE, TRUE, TRUE, "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "lastname", TRUE, TRUE, TRUE, "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->text", [], "email", TRUE, TRUE, TRUE, "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->icon", [ "label" => Contacts\Reachability::label(), "icon" => Contacts\Reachability::icon(), "options" => Contacts\Reachability::getAll(), ], "reachability", [], "contacts", "hashid" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->datetime", [], "date_edit", FALSE, FALSE, TRUE, "contacts" )) ->addColumn(...Hooks::filter( "rest.generator::column.type->actions", [], [], FALSE, "contacts" ))->get() ->addButton(...Hooks::filter( "rest.generator::action.name->edit", [], "contacts", "hashid" )) ->addButton(...Hooks::filter( "rest.generator::action.name->delete", [], "contacts", "hashid" )) ; $buttons = $table->top()->getButtons(); foreach( Contacts\Type::getAll() as $type ) { $type["name"] = "type"; $buttons->addDropdown( ...Hooks::filter( "rest.generator::button.name->create", $type, "contacts" ) ); } return $table; } }