239 lines
11 KiB
C#
239 lines
11 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using Umbraco.Core.Models;
|
|
|
|
namespace Umbraco.Core.Services
|
|
{
|
|
/// <summary>
|
|
/// Defines the File Service, which is an easy access to operations involving <see cref="IFile"/> objects like Scripts, Stylesheets and Templates
|
|
/// </summary>
|
|
public interface IFileService : IService
|
|
{
|
|
IEnumerable<string> GetPartialViewSnippetNames(params string[] filterNames);
|
|
void DeletePartialViewFolder(string folderPath);
|
|
void DeletePartialViewMacroFolder(string folderPath);
|
|
IPartialView GetPartialView(string path);
|
|
IPartialView GetPartialViewMacro(string path);
|
|
Attempt<IPartialView> CreatePartialView(IPartialView partialView, string snippetName = null, int userId = 0);
|
|
Attempt<IPartialView> CreatePartialViewMacro(IPartialView partialView, string snippetName = null, int userId = 0);
|
|
bool DeletePartialView(string path, int userId = 0);
|
|
bool DeletePartialViewMacro(string path, int userId = 0);
|
|
Attempt<IPartialView> SavePartialView(IPartialView partialView, int userId = 0);
|
|
Attempt<IPartialView> SavePartialViewMacro(IPartialView partialView, int userId = 0);
|
|
bool ValidatePartialView(PartialView partialView);
|
|
bool ValidatePartialViewMacro(PartialView partialView);
|
|
|
|
/// <summary>
|
|
/// Gets a list of all <see cref="Stylesheet"/> objects
|
|
/// </summary>
|
|
/// <returns>An enumerable list of <see cref="Stylesheet"/> objects</returns>
|
|
IEnumerable<Stylesheet> GetStylesheets(params string[] names);
|
|
|
|
/// <summary>
|
|
/// Gets a <see cref="Stylesheet"/> object by its name
|
|
/// </summary>
|
|
/// <param name="name">Name of the stylesheet incl. extension</param>
|
|
/// <returns>A <see cref="Stylesheet"/> object</returns>
|
|
Stylesheet GetStylesheetByName(string name);
|
|
|
|
/// <summary>
|
|
/// Saves a <see cref="Stylesheet"/>
|
|
/// </summary>
|
|
/// <param name="stylesheet"><see cref="Stylesheet"/> to save</param>
|
|
/// <param name="userId">Optional id of the user saving the stylesheet</param>
|
|
void SaveStylesheet(Stylesheet stylesheet, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Deletes a stylesheet by its name
|
|
/// </summary>
|
|
/// <param name="path">Name incl. extension of the Stylesheet to delete</param>
|
|
/// <param name="userId">Optional id of the user deleting the stylesheet</param>
|
|
void DeleteStylesheet(string path, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Validates a <see cref="Stylesheet"/>
|
|
/// </summary>
|
|
/// <param name="stylesheet"><see cref="Stylesheet"/> to validate</param>
|
|
/// <returns>True if Stylesheet is valid, otherwise false</returns>
|
|
bool ValidateStylesheet(Stylesheet stylesheet);
|
|
|
|
/// <summary>
|
|
/// Gets a list of all <see cref="Script"/> objects
|
|
/// </summary>
|
|
/// <returns>An enumerable list of <see cref="Script"/> objects</returns>
|
|
IEnumerable<Script> GetScripts(params string[] names);
|
|
|
|
/// <summary>
|
|
/// Gets a <see cref="Script"/> object by its name
|
|
/// </summary>
|
|
/// <param name="name">Name of the script incl. extension</param>
|
|
/// <returns>A <see cref="Script"/> object</returns>
|
|
Script GetScriptByName(string name);
|
|
|
|
/// <summary>
|
|
/// Saves a <see cref="Script"/>
|
|
/// </summary>
|
|
/// <param name="script"><see cref="Script"/> to save</param>
|
|
/// <param name="userId">Optional id of the user saving the script</param>
|
|
void SaveScript(Script script, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Deletes a script by its name
|
|
/// </summary>
|
|
/// <param name="path">Name incl. extension of the Script to delete</param>
|
|
/// <param name="userId">Optional id of the user deleting the script</param>
|
|
void DeleteScript(string path, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Validates a <see cref="Script"/>
|
|
/// </summary>
|
|
/// <param name="script"><see cref="Script"/> to validate</param>
|
|
/// <returns>True if Script is valid, otherwise false</returns>
|
|
bool ValidateScript(Script script);
|
|
|
|
/// <summary>
|
|
/// Creates a folder for scripts
|
|
/// </summary>
|
|
/// <param name="folderPath"></param>
|
|
/// <returns></returns>
|
|
void CreateScriptFolder(string folderPath);
|
|
|
|
/// <summary>
|
|
/// Deletes a folder for scripts
|
|
/// </summary>
|
|
/// <param name="folderPath"></param>
|
|
void DeleteScriptFolder(string folderPath);
|
|
|
|
/// <summary>
|
|
/// Gets a list of all <see cref="ITemplate"/> objects
|
|
/// </summary>
|
|
/// <returns>An enumerable list of <see cref="ITemplate"/> objects</returns>
|
|
IEnumerable<ITemplate> GetTemplates(params string[] aliases);
|
|
|
|
/// <summary>
|
|
/// Gets a list of all <see cref="ITemplate"/> objects
|
|
/// </summary>
|
|
/// <returns>An enumerable list of <see cref="ITemplate"/> objects</returns>
|
|
IEnumerable<ITemplate> GetTemplates(int masterTemplateId);
|
|
|
|
/// <summary>
|
|
/// Gets a <see cref="ITemplate"/> object by its alias.
|
|
/// </summary>
|
|
/// <param name="alias">The alias of the template.</param>
|
|
/// <returns>The <see cref="ITemplate"/> object matching the alias, or null.</returns>
|
|
ITemplate GetTemplate(string alias);
|
|
|
|
/// <summary>
|
|
/// Gets a <see cref="ITemplate"/> object by its identifier.
|
|
/// </summary>
|
|
/// <param name="id">The identifer of the template.</param>
|
|
/// <returns>The <see cref="ITemplate"/> object matching the identifier, or null.</returns>
|
|
ITemplate GetTemplate(int id);
|
|
|
|
/// <summary>
|
|
/// Gets a <see cref="ITemplate"/> object by its guid identifier.
|
|
/// </summary>
|
|
/// <param name="id">The guid identifier of the template.</param>
|
|
/// <returns>The <see cref="ITemplate"/> object matching the identifier, or null.</returns>
|
|
ITemplate GetTemplate(Guid id);
|
|
|
|
/// <summary>
|
|
/// Gets the template descendants
|
|
/// </summary>
|
|
/// <param name="alias"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<ITemplate> GetTemplateDescendants(string alias);
|
|
|
|
/// <summary>
|
|
/// Gets the template descendants
|
|
/// </summary>
|
|
/// <param name="masterTemplateId"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<ITemplate> GetTemplateDescendants(int masterTemplateId);
|
|
|
|
/// <summary>
|
|
/// Gets the template children
|
|
/// </summary>
|
|
/// <param name="alias"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<ITemplate> GetTemplateChildren(string alias);
|
|
|
|
/// <summary>
|
|
/// Gets the template children
|
|
/// </summary>
|
|
/// <param name="masterTemplateId"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<ITemplate> GetTemplateChildren(int masterTemplateId);
|
|
|
|
/// <summary>
|
|
/// Returns a template as a template node which can be traversed (parent, children)
|
|
/// </summary>
|
|
/// <param name="alias"></param>
|
|
/// <returns></returns>
|
|
TemplateNode GetTemplateNode(string alias);
|
|
|
|
/// <summary>
|
|
/// Given a template node in a tree, this will find the template node with the given alias if it is found in the hierarchy, otherwise null
|
|
/// </summary>
|
|
/// <param name="anyNode"></param>
|
|
/// <param name="alias"></param>
|
|
/// <returns></returns>
|
|
TemplateNode FindTemplateInTree(TemplateNode anyNode, string alias);
|
|
|
|
/// <summary>
|
|
/// Saves a <see cref="ITemplate"/>
|
|
/// </summary>
|
|
/// <param name="template"><see cref="ITemplate"/> to save</param>
|
|
/// <param name="userId">Optional id of the user saving the template</param>
|
|
void SaveTemplate(ITemplate template, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Creates a template for a content type
|
|
/// </summary>
|
|
/// <param name="contentTypeAlias"></param>
|
|
/// <param name="contentTypeName"></param>
|
|
/// <param name="userId"></param>
|
|
/// <returns>
|
|
/// The template created
|
|
/// </returns>
|
|
Attempt<OperationStatus<ITemplate, OperationStatusType>> CreateTemplateForContentType(string contentTypeAlias, string contentTypeName, int userId = 0);
|
|
|
|
ITemplate CreateTemplateWithIdentity(string name, string content, ITemplate masterTemplate = null, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Deletes a template by its alias
|
|
/// </summary>
|
|
/// <param name="alias">Alias of the <see cref="ITemplate"/> to delete</param>
|
|
/// <param name="userId">Optional id of the user deleting the template</param>
|
|
void DeleteTemplate(string alias, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// Validates a <see cref="ITemplate"/>
|
|
/// </summary>
|
|
/// <param name="template"><see cref="ITemplate"/> to validate</param>
|
|
/// <returns>True if Script is valid, otherwise false</returns>
|
|
bool ValidateTemplate(ITemplate template);
|
|
|
|
/// <summary>
|
|
/// Saves a collection of <see cref="Template"/> objects
|
|
/// </summary>
|
|
/// <param name="templates">List of <see cref="Template"/> to save</param>
|
|
/// <param name="userId">Optional id of the user</param>
|
|
void SaveTemplate(IEnumerable<ITemplate> templates, int userId = 0);
|
|
|
|
/// <summary>
|
|
/// This checks what the default rendering engine is set in config but then also ensures that there isn't already
|
|
/// a template that exists in the opposite rendering engine's template folder, then returns the appropriate
|
|
/// rendering engine to use.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
/// <remarks>
|
|
/// The reason this is required is because for example, if you have a master page file already existing under ~/masterpages/Blah.aspx
|
|
/// and then you go to create a template in the tree called Blah and the default rendering engine is MVC, it will create a Blah.cshtml
|
|
/// empty template in ~/Views. This means every page that is using Blah will go to MVC and render an empty page.
|
|
/// This is mostly related to installing packages since packages install file templates to the file system and then create the
|
|
/// templates in business logic. Without this, it could cause the wrong rendering engine to be used for a package.
|
|
/// </remarks>
|
|
RenderingEngine DetermineTemplateRenderingEngine(ITemplate template);
|
|
}
|
|
} |