High Level Feature ListThis section

High Level Feature List
This section describes some of the features that are provided by the framework.

Autoloading: the framework can automatically load its classes.
Controllers: The "C" part of MVC, handles basic routing of requests, setup and output. There is a generic controller provided, plus ones geared towards blocks, modules and administrative pages.
DB: Another layer of database abstraction that include tables, records, queues and table dumping.
Exporting: An export handler that can export data to various formats. Currently supported formats are CSV, TSV, Excel and ODS.
Formatting: Reusable and configurable formats that can transform data.
Helper design pattern: A simple way to dynamically use library type classes. Key Helpers include:
Buffer: Helps to buffer output.
HTML: Helps generate HTML for routine tasks, like auto-complete.
Load: Helps to load classes. Great for when you need to dynamically instantiate classes, like for plugins.
Recent activity: Generate Moodle's recent activity list.
Tag: Quick access to Tag.
Test Web Services: Helps with testing web services in unit testing.
Filtering: Easy way to display filtering options to a user which then generate SQL to limit results. The filtering options are persistent through the user's session.
Notify: Easy session based notification system. Most common use-case: set the message, redirect and display the message.
Heading: Assists with printing headings with or without help icon.
Table: Tabular data display with sorting. The columns are configurable objects.
Paging: Paging bar and SQL limits.

Tabs: API wrapper over Moodle's tab API. Attempts to automate and simplify tab creation/management.
Tag: HTML tag generation.
Distributed locking: Provide a locking mechanism to ensure that only one process is performing a specific task at one time. Current back end is Redis.
Model: Provide very basic abstract model classes.
Model repository mapper: Abstract class for mapping models to the DB and visa versa. See http://martinfowler.com/eaaCatalog/dataMapper.html
Plugin: Simple class for Sub-plugins.
Preferences: user session preferences that are course and plugin aware.
Report: Combines filtering, table, columns, formatting, exporting, paging and preferences for simple report generation.
Server: A set of classes for providing a web service endpoint. Currently only the REST server is provided. Other classes involved are request validation and server response.
Var: Static variable storage.
Fixture: A fixture API for setting up and tearing down fixtures like users, courses, enrollments in unit tests.
Framework Files
local/mr
All of the framework's files are located inside of this local plugin.
Setup Guide
The local/mr plugin install normally. To get additional features, follow these steps:

Display framework documentation
Add the following code to your config.php: define('MR_DOCS', 1);
This will display the following link: Site Administration > MR Framework > Docs
Quick Start Guide
It is very easy to start using the Moodlerooms Framework. Just include the following line in the PHP script to automatically load any of the Moodlerooms Framework classes:

require($CFG->dirroot.'/local/mr/bootstrap.php');
That's it! Now you can start using the framework:

$tag = new mr_html_tag();
echo $tag->b('Hello World!');
Framework Design Patterns
This section describes some of the reasoning behind the design of the major components of the framework.

MVC
Model-View-Controller (MVC) is a popular coding design pattern. From my understanding (Mark Nielsen's), it is popular because its design facilitates the re-use of code, which in turn reduces the size of the code base, which in turn results in multiple benefits through the life cycle of the software. The Moodlerooms Framework works off of this design pattern.

Controller

Controllers handle the application logic by responding to user actions, processing those actions (generally by using models) and then generating output to the user by means of views.

The Moodlerooms Framework provides the controller through the base mr_controller class. The controller is responsible for routing HTTP requests, security checks and general variable setup. Each controller endpoint is responsible for whatever processing that needs to occur and, if needed, setup and return the view for sending to the user.

Advantages of controllers:

Stores application logic.
Easy to create a consistent look and feel throughout a plugin.
Easier to implement security restrictions. Through a single method, a controller can protect all of its actions from unprivileged users. This can be a blanket restriction or fine grained access for each action.
Controllers allow one to focus on the task at hand instead of all the overhead of generating a secure and full featured Moodle page.
Controllers help to organize code into smaller functional snippets instead of large files with very large if/else if and switch statements that tend to produce security holes and nasty bugs.

Kết quả (Việt) 1:

Danh sách tính năng cao cấpPhần này mô tả một số các tính năng được cung cấp bởi các khuôn khổ.Tự động: khuôn khổ có thể tự động nạp các lớp học của mình.Bộ điều khiển: Phần "C" của MVC, xử lý các định tuyến cơ bản yêu cầu, thiết lập và sản lượng. Đó là một bộ điều khiển chung cung cấp, cộng thêm cái hướng tới khối, mô-đun và các trang hành chính.DB: Một lớp trừu tượng cơ sở dữ liệu bao gồm các bảng, Hồ sơ, hàng đợi và bảng bán phá giá.Xuất khẩu: Một xuất khẩu xử lý mà có thể xuất dữ liệu sang định dạng khác nhau. Hiện đang được hỗ trợ các định dạng là CSV, TSV, Excel và ODS.Định dạng: Tái sử dụng và cấu hình các định dạng mà có thể chuyển đổi dữ liệu.Mẫu thiết kế Helper: cách đơn giản để tự động sử dụng thư viện kiểu lớp học. Phím trợ giúp bao gồm:Vùng đệm: Giúp bộ đệm đầu ra.HTML: Giúp tạo ra HTML cho các nhiệm vụ thường xuyên, như tự động hoàn thành.Tải trọng: Giúp tải các lớp học. Tuyệt vời nhất khi bạn cần phải tự động nhanh chóng các lớp, như cho các plugin.Hoạt động gần đây: tạo ra các danh sách hoạt động gần đây của Moodle.Từ khóa: Nhanh chóng truy cập vào thẻ.Các dịch vụ Web thử nghiệm: Giúp thử nghiệm dịch vụ web trong đơn vị thử nghiệm.Bộ lọc: Cách dễ dàng để hiển thị các bộ lọc tùy chọn cho người dùng sau đó tạo SQL để giới hạn kết quả. Bộ lọc tùy chọn có liên tục thông qua các phiên làm việc của người dùng.Thông báo: Phiên giao dịch dễ dàng dựa trên hệ thống thông báo. Trường hợp sử dụng phổ biến nhất: thiết lập thư, chuyển hướng và hiển thị các tin nhắn.Tiêu đề: Hỗ trợ in ấn đề mục có hoặc không có giúp đỡ các biểu tượng.Bảng: Bảng dữ liệu Hiển thị với phân loại. Các cột có thể cấu hình đối tượng.Phân trang: Paging bar và SQL giới hạn.Tab: API wrapper qua Moodle's tab API. Nỗ lực để tự động hóa và đơn giản hóa các tab tạo/quản lý.Từ khóa: HTML tag thế hệ.Phân phối khóa: cung cấp một cơ chế khóa để đảm bảo rằng chỉ có một quá trình thực hiện một nhiệm vụ cụ thể tại một thời gian. Kết thúc trở lại hiện tại là Redis.Model: Cung cấp các lớp học mô hình trừu tượng rất cơ bản.Mô hình kho mapper: tóm tắt lớp cho ánh xạ kiểu để DB và visa ngược lại. Xem http://martinfowler.com/eaaCatalog/dataMapper.htmlPlugin: Đơn giản lớp cho Sub-plugins.Sở thích: phiên họp sở thích người dùng khóa và plugin nhận thức.Báo cáo: Kết hợp lọc, bảng, cột, định dạng, xuất khẩu, phân trang và các tùy chọn cho các thế hệ báo cáo đơn giản.Máy chủ: Một tập hợp các lớp học cung cấp một dịch vụ web endpoint. Hiện nay chỉ còn lại máy chủ được cung cấp. Tham gia các lớp học khác là yêu cầu xác nhận và máy chủ phản ứng.Var: Tĩnh biến lưu trữ.Nhân vật: Một vật cố API để thiết lập và xé xuống đồ đạc như người dùng, các khóa học, enrollments trong các đơn vị xét nghiệm.Khung tranhLocal/mrTất cả trong khuôn khổ các tập tin được đặt bên trong của plugin này địa phương.Hướng dẫn thiết lậpLocal/mr plugin cài đặt bình thường. Để có được tính năng bổ sung, hãy làm theo các bước sau:Màn hình hiển thị khung tài liệu hướng dẫnThêm mã sau đây để config.php của bạn: define ('MR_DOCS', 1);Điều này sẽ hiển thị các liên kết sau: quản trị trang web > MR Framework > DocumentsHướng dẫn bắt đầu nhanhRất dễ dàng để bắt đầu sử dụng các khuôn khổ Moodlerooms. Chỉ cần bao gồm các dòng sau trong PHP script để tự động tải bất kỳ của các lớp học Moodlerooms Framework:yêu cầu ($CFG -> dirroot.' / local/mr/bootstrap.php');Đó là nó! Bây giờ bạn có thể bắt đầu sử dụng các khuôn khổ:$tag = mới mr_html_tag();echo $tag -> b ('Hello World!');Mẫu thiết kế khuôn khổPhần này mô tả một số trong lý do đằng sau thiết kế của các thành phần chính của khuôn khổ.MVCModel-View-Controller (MVC) là một mẫu mã thiết kế phổ biến. Từ hiểu biết của tôi (Mark Nielsen's), nó là phổ biến vì thiết kế của nó tạo điều kiện cho việc tái sử dụng mã, lần lượt giảm kích thước của các cơ sở mã, mà lần lượt dẫn đến nhiều lợi ích thông qua chu trình sống của phần mềm. Moodlerooms khuôn khổ hoạt động giảm giá của mẫu thiết kế này.Bộ điều khiểnBộ điều khiển xử lý các logic ứng dụng đáp ứng với hành động người dùng, chế biến những hành động (thường bằng cách sử dụng các mô hình) và sau đó tạo ra cho người dùng bằng cách xem.Trong khuôn khổ Moodlerooms cung cấp các bộ điều khiển thông qua các lớp cơ sở mr_controller. Bộ điều khiển chịu trách nhiệm cho việc định tuyến yêu cầu HTTP, kiểm tra an ninh và bảo trì các chung biến. Mỗi điều khiển endpoint có trách nhiệm xử lý bất cứ điều gì cần phải xảy ra, và nếu cần thiết, thiết lập và quay trở lại giao diện để gửi cho người dùng.Ưu điểm của bộ điều khiển:Cửa hàng ứng dụng logic.Dễ dàng để tạo ra một cái nhìn phù hợp và cảm thấy trong suốt một plugin.Dễ dàng hơn để thực hiện hạn chế bảo mật. Thông qua một phương pháp duy nhất, một bộ điều khiển có thể bảo vệ tất cả các hành động của mình từ những người dùng không có đặc quyền. Điều này có thể là một hạn chế chăn hoặc fine grained truy cập cho mỗi hành động.Bộ điều khiển cho phép một để tập trung vào công việc ở bàn tay thay vì tất cả chi phí của việc tạo một an toàn và đầy đủ nổi bật Moodle trang.Bộ điều khiển giúp tổ chức mã vào nhỏ hơn chức năng đoạn thay vì các tập tin lớn với rất lớn nếu/khác nếu và chuyển báo cáo có xu hướng để sản xuất các lỗ hổng bảo mật và lỗi khó chịu.

Kết quả (Việt) 2:

Cấp cao Các tính năng
Phần này mô tả một số các tính năng được cung cấp bởi khuôn khổ. Tự động load: khuôn khổ có thể tự động tải các lớp học của mình. Bộ điều khiển: "C" một phần của MVC, xử lý định tuyến cơ bản các yêu cầu, thiết lập và đầu ra. Có một điều khiển chung được cung cấp, cộng với những người hướng tới khối, mô-đun và các trang chính. DB: Một lớp cơ sở dữ liệu trừu tượng bao gồm bảng biểu, hồ sơ, hàng đợi và bàn bán phá giá. Xuất khẩu: Một xử lý xuất khẩu, có thể xuất dữ liệu sang các định dạng khác nhau. Các định dạng hiện đang được hỗ trợ là CSV, TSV, Excel và ODS. Định dạng: định dạng Reusable và cấu hình có thể chuyển đổi dữ liệu. Mẫu thiết kế Helper: Một cách đơn giản để tự động sử dụng các lớp học kiểu thư viện. Helpers chính bao gồm: Buffer: Giúp để đệm đầu ra. HTML: Giúp tạo ra HTML cho các nhiệm vụ thường xuyên, như tự động hoàn tất. Load: Giúp để tải các lớp học. Tuyệt vời cho khi bạn cần phải tự động khởi tạo các lớp học, như cho các plugins. Gần đây hoạt động:. Tạo danh sách các hoạt động gần đây của Moodle Tag: Nhanh chóng truy cập Tag. Thử nghiệm dịch vụ Web: Giúp với các dịch vụ thử nghiệm web trong kiểm tra đơn vị. Filtering: Cách dễ dàng để hiển thị bộ lọc lựa chọn cho người sử dụng mà sau đó tạo ra SQL để giới hạn kết quả. Các tùy chọn lọc được liên tục thông qua các phiên làm việc của người dùng. Thông báo: Dễ phiên hệ thống thông báo dựa. Phổ biến nhất trường hợp sử dụng:. Thiết lập các tin nhắn, chuyển hướng và hiển thị các thông Tiêu đề:. Giúp với các tiêu đề in ấn có hoặc không có sự giúp đỡ biểu tượng Table: dạng bảng hiển thị dữ liệu với phân loại. Các cột là các đối tượng cấu hình. Paging: Paging thanh và SQL giới hạn. Tabs: API wrapper qua API tab của Moodle. Những cố gắng để tự động hóa và đơn giản hóa việc tạo tab / quản lý. Tag:. HTML tag thế hệ khóa phân phối: Cung cấp một cơ chế khóa để đảm bảo rằng chỉ có một quá trình đang thực hiện một nhiệm vụ cụ thể tại một thời gian. Kết thúc trở lại hiện nay là Redis. Mẫu:. Cung cấp các lớp mô hình trừu tượng rất cơ bản kho lưu trữ mẫu mapper: Tóm tắt lớp học cho các mô hình ánh xạ đến DB và ngược lại. Xem http://martinfowler.com/eaaCatalog/dataMapper.html Plugin:. Lớp đơn giản cho Sub-plugins Preferences: sở thích của người dùng phiên đó là khóa học và các plugin biết. Báo cáo: Kết hợp lọc, bảng, cột, định dạng, xuất khẩu, phân trang và ưu đãi cho đơn giản báo cáo thế hệ. server: một tập hợp các lớp học để cung cấp một điểm cuối dịch vụ web. Hiện nay chỉ có các máy chủ REST của được cung cấp. Các lớp học khác có liên quan là yêu cầu xác nhận và máy chủ đáp ứng. Var: lưu trữ biến tĩnh. Lịch thi đấu:. Một API cố định cho việc thiết lập và rách xuống đồ đạc như người dùng, khóa học, tuyển sinh trong các bài kiểm tra đơn vị khung tập tin địa phương / mr Tất cả các tập tin của khung được đặt bên trong của địa phương này plugin. cài đặt Hướng dẫn các địa phương / mr Plugin cài đặt bình thường. Để có được tính năng bổ sung, hãy làm theo các bước sau: tài liệu khung hiển thị Thêm mã sau đây để config.php của bạn: define ( 'MR_DOCS', 1); này sẽ hiển thị các liên kết sau đây: Quản trị trang web> MR Khung> Documents Quick Start Guide Đây là rất dễ dàng để bắt đầu sử dụng các khung Moodlerooms. Chỉ cần bao gồm các dòng sau trong script PHP để tự động nạp các lớp Moodlerooms Framework: yêu cầu; ($ CFG-> dirroot '/ local / mr / bootstrap.php'.) Đó là nó! Bây giờ bạn có thể bắt đầu sử dụng các khuôn khổ: $ tag = new mr_html_tag (); echo $ tag-> b ( 'Hello World!'); Thiết kế khung Patterns Phần này mô tả một số lý do đằng sau việc thiết kế các thành phần chính của khuôn khổ . MVC Model-View-Controller (MVC) là một mã hóa mẫu thiết kế phổ biến. Từ sự hiểu biết của tôi (Mark Nielsen), nó là phổ biến vì thiết kế của nó tạo điều kiện cho việc tái sử dụng mã, do đó làm giảm kích thước của các cơ sở mã, mà trong kết quả lần lượt ở nhiều lợi ích thông qua vòng đời của phần mềm. Các Moodlerooms Khung làm việc tắt của mẫu thiết kế này. Bộ điều khiển Bộ điều khiển xử lý các ứng dụng logic bằng cách trả lời các hành động của người dùng, chế biến những hành động (thường bằng cách sử dụng các mô hình) và sau đó tạo ra cho người dùng bằng các quan điểm. Các Moodlerooms Framework cung cấp bộ điều khiển thông qua lớp cơ sở mr_controller. Bộ điều khiển chịu trách nhiệm cho việc định tuyến các yêu cầu HTTP, kiểm tra an ninh và thiết lập biến nói chung. Mỗi thiết bị đầu cuối điều khiển chịu trách nhiệm xử lý bất cứ điều gì mà cần phải xảy ra, và nếu cần thiết, thiết lập và trở về xem để gửi cho người sử dụng. Ưu điểm của bộ điều khiển: . Ứng dụng logic Cửa hàng dễ dàng để tạo ra một cái nhìn nhất quán và xuyên suốt trong một plugin. Dễ dàng hơn để thực hiện các hạn chế bảo mật. Thông qua một phương pháp duy nhất, một bộ điều khiển có thể bảo vệ tất cả các hành động của mình từ những người dùng không có đặc quyền. Đây có thể là một hạn chế chăn hoặc truy cập hạt mịn cho mỗi hành động. Bộ điều khiển cho phép một để tập trung vào các nhiệm vụ chính thay vì tất cả những phí của việc tạo ra một trang Moodle tính năng an toàn và đầy đủ. Bộ điều khiển giúp tổ chức các mã vào đoạn chức năng nhỏ hơn thay vì tập tin lớn với rất lớn nếu / else if và switch báo cáo rằng có xu hướng tạo lỗ hổng bảo mật và lỗi khó chịu.