/** * @see \dbeurive\Backend\Database\EntryPoints\AbstractEntryPoint */ public function getDescription() { $doc = new Description\Procedure(); $doc->setDescription("This procedure is used to authenticate a user based on a provided set of login and password.")->setRequests([self::SQL_AUTHENTICATE])->addTags(Tags::AUTHENTICATION)->setMandatoryInputFields(self::$__mandatoryFields)->addOutputField('user.*')->addOutputDataValue(OutputValues::OUTPUT_VALUE_IS_AUTHENTICATED, 'This flag indicates whether the user has been successfully authenticated or not. TRUE: authentication succeed, FALSE: authentication failed.')->addEntityActionsRelationship(Entities::USER, Actions::AUTHENTICATE); // Note that the following methods are not called: // - addRequest // - addMandatoryInputField // - addOptionalInputField // - setOptionalInputFields // - addMandatoryInputParam // - setMandatoryInputParams // - addOptionalInputParam // - setOptionalInputParams // - setOutputFields // - setOutputIsMulti return $doc; }
/** * @see \dbeurive\Backend\Database\EntryPoints\AbstractEntryPoint */ public function getDescription() { $doc = new Description\Procedure(); $doc->setDescription("This procedure is used to delete a user.")->setRequests([self::SQL_DELETE])->setMandatoryInputFields(self::$__mandatoryFields)->addTags(Tags::ADMIN)->addOutputValue(OutputValues::OUTPUT_VALUE_IS_DELETED)->addEntityActionsRelationship(Entities::USER, Actions::DELETE)->addEntityActionsRelationship(Entities::USER_PROFILE, Actions::DELETE)->addMandatoryInputParam('suspend'); // Note that the following methods are not called: // - addRequest // - setMandatoryInputFields // - setOptionalInputFields // - setMandatoryInputParams // - setOptionalInputParams // - setOutputFields // - addEntityActionsRelationship // - addMandatoryInputParam // - addOptionalInputParam // - addOutputDataValue // - setOutputIsMulti return $doc; }