luna_lms.storage.file_storage.FileStorage

class documentation

class FileStorage(Storage):

Constructor: FileStorage()

View In Hierarchy

This class stores data in a folder hierarchy on disk.

Method __init__ Initialise FileStorage.
Method delete_course Delete the course identified by course_title. Return a message in case of success.
Method delete_learning_content Delete the learning content identified by learning_content_id. Return a message in case of success.
Method delete_variant Attempt to delete the variant identified by variant_id. Return a message in case of success.
Method find_courses Search for courses, and return a tuple (dict, {}), with dict mapping their titles to their IDs, and IDs to titles.
Method get_course_titles Return a list of titles of existing courses.
Method get_directory Return a tuple (directory_name, html) with the name of the first directory found in the learning content, and the content of the first HTML file found in there. Both elements may be empty.
Method get_html Return the content of the first HTML file found in the learning content, or an empty string.
Method get_image Return the URI to the first image found in the learning content, or an empty string.
Method get_step_titles Return a dictionary mapping step identifiers to their titles.
Method get_steps Return a list of step identifiers for a course in arbitrary order.
Method get_steps_ordered Return a list of step identifiers for a course in order.
Method get_variant_metadata Return the metadata of the variant as a dict.
Method get_variants Return a list of all variants for a learning content in a course.
Method get_variants_ids Return a list of identifiers of all variants for a learning content in a course.
Method write_course Create a new course. Return a message indicating success or failure.
Method write_learning_content Create a new learning content. Return a message indicating success or failure.
Method write_learning_contents_list Write an re-ordered list of learning contents into the course. Return a message indicating success or failure.
Method write_variant Write a variant consisting of a single or multiple files, and create the according meta files.

Inherited from Storage:

Method get_cached_item Return an item from the course's cache as a dict.
Method get_content Return the variant data for the content of the step as specified by variant_format, or empty data.
Method get_course_metadata Return the metadata of the course as a dict.
Method get_format Return the format identifier of the first format that matches the tag list in tags for the course.
def __init__(self):

Initialise FileStorage.

def delete_course(self, course_title):
overrides luna_lms.storage.storage.Storage.delete_course

Delete the course identified by course_title. Return a message in case of success.

def delete_learning_content(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.delete_learning_content

Delete the learning content identified by learning_content_id. Return a message in case of success.

def delete_variant(self, course_title, learning_content_id, variant_id):
overrides luna_lms.storage.storage.Storage.delete_variant

Attempt to delete the variant identified by variant_id. Return a message in case of success.

def find_courses(self):
overrides luna_lms.storage.storage.Storage.find_courses

Search for courses, and return a tuple (dict, {}), with dict mapping their titles to their IDs, and IDs to titles.

def get_course_titles(self):
overrides luna_lms.storage.storage.Storage.get_course_titles

Return a list of titles of existing courses.

def get_directory(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.get_directory

Return a tuple (directory_name, html) with the name of the first directory found in the learning content, and the content of the first HTML file found in there. Both elements may be empty.

def get_html(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.get_html

Return the content of the first HTML file found in the learning content, or an empty string.

def get_image(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.get_image

Return the URI to the first image found in the learning content, or an empty string.

def get_step_titles(self, course_title):
overrides luna_lms.storage.storage.Storage.get_step_titles

Return a dictionary mapping step identifiers to their titles.

def get_steps(self, course_title):
overrides luna_lms.storage.storage.Storage.get_steps

Return a list of step identifiers for a course in arbitrary order.

def get_steps_ordered(self, course_title):
overrides luna_lms.storage.storage.Storage.get_steps_ordered

Return a list of step identifiers for a course in order.

def get_variant_metadata(self, course_title, learning_content_id, variant):
overrides luna_lms.storage.storage.Storage.get_variant_metadata

Return the metadata of the variant as a dict. Example: { "identifier": "aa2835f3-c3e4-495a-bea8-3e283979e6e6", "format": "text/html", "type": "variant" }

def get_variants(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.get_variants

Return a list of all variants for a learning content in a course.

def get_variants_ids(self, course_title, learning_content_id):
overrides luna_lms.storage.storage.Storage.get_variants_ids

Return a list of identifiers of all variants for a learning content in a course.

def write_course(self, title):
overrides luna_lms.storage.storage.Storage.write_course

Create a new course. Return a message indicating success or failure.

def write_learning_content(self, course_title, learning_content_title):
overrides luna_lms.storage.storage.Storage.write_learning_content

Create a new learning content. Return a message indicating success or failure.

def write_learning_contents_list(self, course_title, learning_contents_list):
overrides luna_lms.storage.storage.Storage.write_learning_contents_list

Write an re-ordered list of learning contents into the course. Return a message indicating success or failure.

def write_variant(self, course_id, learning_content_id, content, filename):
overrides luna_lms.storage.storage.Storage.write_variant

Write a variant consisting of a single or multiple files, and create the according meta files. Return the MIME type of the last file written.