Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sultanimbayev/ieit.reports.webframework

File downloading framework for ASP.NET MVC
https://github.com/sultanimbayev/ieit.reports.webframework

api csharp dotnet file-download net45

Last synced: 21 days ago
JSON representation

File downloading framework for ASP.NET MVC

Awesome Lists containing this project

README 

        
# IEIT.Reports.WebFramework



Framework for file downloading in ASP.NET MVC.



## Installing



Install using NuGet package manager:



```

PM> Install-Package IEIT.Reports.WebFramework.Api

```



## How to use



Create a class at any place in your web project and add the namespaces:

```C#

using IEIT.Reports.WebFramework.Core.Attributes;

using IEIT.Reports.WebFramework.Core.Interfaces;

```



Then:

 1. Add the `Report` attribute to the class.

 2. Implement the `IReport` interface in your class. 



Example:



```C#

[Report]

public class MyFileReport: IReport

{

    public void GenerateFiles(NameValueCollection queryParams, string inDir)

    {

        var name = queryParams["name"] ?? "there";

        var path = Path.Combine(inDir, "newFile.txt");

        File.WriteAllText(path, $"Hello {name}!");

    }



}

```



After doing this, you can download your file via the `/api/Files/DownloadForm/MyFile?name=Sultan` url.



`queryParams` - GET Parameters of the request



`inDir` - directory path where your files that are to be downloaded, should be created.



> When you use `[Report]` attribute without parameters, download link is formed using the name 

> of the class which lies under `[Report]` attribute. If you want to overwrite this name pass a string

> to `[Report]` attribute. For example  `[Report("NotMyFile")]`.



If you want to place this class in a different project than the controller is placed you have to add a reference to that project, and install the 

IEIT.Reports.WebFramework.Core package to it.



### How does it work?



After installation, `ReportExportController.cs` were created in `~\Controllers\` directory. In which you will find the following constant:



> where `~` is the home directory of your web project.



```C#

private const string API_ROUTE_BASE = "api/Files/DownloadForm/";

```



It is the url for downloading. Remember it to download and check your files that you make downloadable.



Created controller contains all logic that does all of this stuff. Detail are hidden in the methods of this library.

If you are interested how does it work, you can go through the code here, in GitHub.



### ReturnsZip attribute



If you create one file in the `inDir` directory, then, this file is sent to the client.

But, if you create there two or more files it will send a .zip archive containig that files.

Use ReturnsZip attribute to define the name of the archive.



Example:

```C#

[Report]

[ReturnsZip("My archive")]

public class MyFileReport: IReport

{

    //...

}

```



If you don't define the name of an archive it the name will be "Выходные данные" as default.



> If you have placed the `ReturnsZip` attribute, then it does not matter that do you create one file or more, it 

> will send all files in the archive anyway.



### DisplayName attribute



If you want to declare and share the display names of the reports you create, then, you can use this attribute.



Example:

```C#

[Report]

[DisplayName(DisplayLanguage.English, "Download my files")]

public class MyFileReport: IReport

{

    //...

}

```



Use the `LangUtils` class to get the names you have assigned.

`LangUtils` is placed in the `IEIT.Reports.WebFramework.Api.Resolvers` namespace.



For example, if you want to get the display name of the report in the example above:

```C#

var name = LangUtils.GetDisplayName("MyFile", DisplayLanguage.English);

Console.WriteLine($"Name of the report is: {name}");

```



You can include multiple `DisplayName` attributes on a class with different value of `DisplayLanguage`.

It means that you can make display name of the report in several languages.



You can also, take the display names of all report classes with their corresponding class name:

```C#

var names = LangUtils.GetDisplayNames(DisplayLanguage.English);

foreach(var pair in names)

{

	Console.WriteLine($"Display name: {pair.Value}, class name: {pair.Key}");

}

```