Mibew/docs.mibew.org
1
0
Fork 0
mirror of https://github.com/Mibew/docs.mibew.org.git synced 2025-05-01 22:56:41 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Highlight client application in docs

Browse Source
This commit is contained in:
Fedor A. Fetisov 2017-11-02 01:34:21 +03:00
parent 8940a9792b
commit 902f323cfe
2 changed files with 33 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/development/core-architecture.md
View File

@ -7,10 +7,10 @@ nav_sort: 0
# Core Architecture # Core Architecture
The **Core** of **Mibew Messenger** can be divided into three basic parts: the The **Core** of **Mibew Messenger** can be divided into three basic parts: the
**Server** side application, client side applications and the **Widget**. This **Server** side application, **Client** side applications and the **Widget**.
page does not describe low-level organization of the parts, but provides their This page does not describe low-level organization of the parts, but provides
overview, describes their purpose and illustrates how they interacts with each their overview, describes their purpose and illustrates how they interacts with
other. each other.
## Server side application ## Server side application
@ -54,7 +54,7 @@ separately. At the moment the most important subsystems are:
## Client side applications ## Client side applications
Client side applications are written in JavaScript. They're built on top of **Client** side applications are written in JavaScript. They're built on top of
[Marionette.js](http://marionettejs.com/) framework and utilize several other [Marionette.js](http://marionettejs.com/) framework and utilize several other
third party libraries: third party libraries:
@ -62,28 +62,29 @@ third party libraries:
* [Underscore.js](http://underscorejs.org/) is used to simplify routine * [Underscore.js](http://underscorejs.org/) is used to simplify routine
JavaScript operations. JavaScript operations.
* [Backbone.js](http://backbonejs.org/) is the base of Marionette.js framework. * [Backbone.js](http://backbonejs.org/) is the base of Marionette.js framework.
* [Handlebars.js](http://handlebarsjs.com/) is the client side template engine. * [Handlebars.js](http://handlebarsjs.com/) is the **Client** side template
engine.
* [Vex](http://github.hubspot.com/vex/docs/welcome/) provides beautiful and * [Vex](http://github.hubspot.com/vex/docs/welcome/) provides beautiful and
customizable dialog popups. customizable dialog popups.
* [Validator.js](https://github.com/chriso/validator.js) simplifies data * [Validator.js](https://github.com/chriso/validator.js) simplifies data
validation at the client side. validation at the **Client** side.
As it was pointed above a client side application is a Marionette.js As it was pointed above a **Client** side application is a Marionette.js
application that performs a limited number of tasks. One should note that not application that performs a limited number of tasks. One should note that not
all JavaScript files in **Mibew Messenger** are related to client side all JavaScript files in **Mibew Messenger** are related to **Client** side
applications. At the moment there are three client side applications: applications. At the moment there are three **Client** side applications:
* **Chat application**. * **Chat application**.
* **Users application**. * **Users application**.
* **Thread log application**. * **Thread log application**.
**Chat application** implements all client side logic for both user and **Chat application** implements all **Client** side logic for both user and
operator chat windows. The application communicates with the **Server** side operator chat windows. The application communicates with the **Server** side
application using the special RPC-like protocol. application using the special RPC-like protocol.
**Users application** implements all client side logic for the page with the **Users application** implements all **Client** side logic for the page with
list of awaiting users. The application communicates with the **Server** side the list of awaiting users. The application communicates with the **Server**
application using the special RPC-like protocol. side application using the special RPC-like protocol.
**Thread log application** is a stub application that only renders thread log. **Thread log application** is a stub application that only renders thread log.
This application does not exchange data with the **Server** side application. This application does not exchange data with the **Server** side application.
@ -94,7 +95,7 @@ This application does not exchange data with the **Server** side application.
This is just an overview of the interaction. It does not contain a full This is just an overview of the interaction. It does not contain a full
description of low level stuff that powers the interaction. description of low level stuff that powers the interaction.
Interaction between a client side application and the **Server** side Interaction between a **Client** side application and the **Server** side
application is an RPC-like interaction. Let's call interacting parties application is an RPC-like interaction. Let's call interacting parties
Alice and Bob. Each data package that is transferred from Alice to Bob Alice and Bob. Each data package that is transferred from Alice to Bob
may contain requests for functions invocation and results of previous Bob's may contain requests for functions invocation and results of previous Bob's
@ -104,7 +105,7 @@ Alice can synchronously call several functions at Bob's side. Each function can
use results of previously called functions as its arguments. Such behaviour use results of previously called functions as its arguments. Such behaviour
provides unlimited flexibility and reduces the number of transferred packages. provides unlimited flexibility and reduces the number of transferred packages.
A part of a client side application (namely `Mibew.Server` object which is A part of a **Client** side application (namely `Mibew.Server` object which is
defined in `js/source/default/server.js`) sends AJAX request to the web server defined in `js/source/default/server.js`) sends AJAX request to the web server
of **Mibew Messenger** at regular intervals. Also there is an option to send of **Mibew Messenger** at regular intervals. Also there is an option to send
such request immediately. such request immediately.
@ -112,12 +113,12 @@ such request immediately.
Encoded package is sent as the body of HTTP(S) POST request. The **Server** Encoded package is sent as the body of HTTP(S) POST request. The **Server**
side application invokes all requested functions and generates the response side application invokes all requested functions and generates the response
package in JSON format. If the **Server** side application needs to call package in JSON format. If the **Server** side application needs to call
something at the client side, requests for these calls should be included in something at the **Client** side, requests for these calls should be included
the response package. in the response package.
At the **Server** side `\Mibew\RequestProcessor\ClientSideProcessor` class is At the **Server** side `\Mibew\RequestProcessor\ClientSideProcessor` class is
responsible for the interaction. Actually it's an abstract class, so requests responsible for the interaction. Actually it's an abstract class, so requests
from different client side applications are served by different requests from different **Client** side applications are served by different requests
processors: processors:
* `\Mibew\RequestProcessor\ThreadProcessor` is used to interact with the * `\Mibew\RequestProcessor\ThreadProcessor` is used to interact with the

26
src/development/server-side-events.md
View File

@ -326,7 +326,7 @@ The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::PAGE_ADD_JS_PLUGIN_OPTIONS` constant. `\Mibew\EventDispatcher\Events::PAGE_ADD_JS_PLUGIN_OPTIONS` constant.
This event is triggered before options of JavaScript plugins are attached to a This event is triggered before options of JavaScript plugins are attached to a
page. It provides plugins an ability to pass some data to the client side. page. It provides plugins an ability to pass some data to the **Client** side.
An associative array with the following items is passed to event handlers: An associative array with the following items is passed to event handlers:
* _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class. * _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class.
@ -349,7 +349,7 @@ array with the following items is passed to event handlers:
* _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class, * _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class,
incoming request object. incoming request object.
* _'response'_: an instance of `\Symfony\Component\HttpFoundation\Response` * _'response'_: an instance of `\Symfony\Component\HttpFoundation\Response`
class, if a plugin wants to send a custom response to a client it should class, if a plugin wants to send a custom response to a **Client** it should
attach a response object to this field. attach a response object to this field.
@ -364,7 +364,7 @@ the following items is passed to event handlers:
* _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class, * _'request'_: an instance of `\Symfony\Component\HttpFoundation\Request` class,
incoming request object. incoming request object.
* _'response'_: an instance of `\Symfony\Component\HttpFoundation\Response` * _'response'_: an instance of `\Symfony\Component\HttpFoundation\Response`
class, if a plugin wants to send a custom response to a client it should class, if a plugin wants to send a custom response to a **Client** it should
attach a response object to this field. attach a response object to this field.
@ -389,7 +389,7 @@ associative array with the following items is passed to event handlers:
The event can be referenced using the value of The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::THREAD_FUNCTION_CALL` constant. `\Mibew\EventDispatcher\Events::THREAD_FUNCTION_CALL` constant.
This event is triggered if an API function is called at the client side in This event is triggered if an API function is called at the **Client** side in
the **Chat application**, but the system is not aware of this function. the **Chat application**, but the system is not aware of this function.
Plugins can implement custom API functions by attaching handlers to this event. Plugins can implement custom API functions by attaching handlers to this event.
@ -526,7 +526,7 @@ The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::USERS_UPDATE_THREADS_ALTER` constant. `\Mibew\EventDispatcher\Events::USERS_UPDATE_THREADS_ALTER` constant.
This event is triggered before the list of threads is sent to the This event is triggered before the list of threads is sent to the
**Users application** on the client side. It provides plugins an ability to **Users application** on the **Client** side. It provides plugins an ability to
alter the list. A plugin can attach some custom fields to each thread or even alter the list. A plugin can attach some custom fields to each thread or even
completely replace the whole list. An associative array with the following completely replace the whole list. An associative array with the following
items is passed to event handlers: items is passed to event handlers:
@ -542,9 +542,9 @@ The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::USERS_UPDATE_VISITORS_LOAD` constant. `\Mibew\EventDispatcher\Events::USERS_UPDATE_VISITORS_LOAD` constant.
This event is triggered before the list of active site visitors is loaded to be This event is triggered before the list of active site visitors is loaded to be
sent to the **Users application** on the client side. It provides plugins an sent to the **Users application** on the **Client** side. It provides plugins
ability to load, sort and/or trim the visitors list. An associative array with an ability to load, sort and/or trim the visitors list. An associative array
the following items is passed to event handlers: with the following items is passed to event handlers:
* _'visitors'_: array of visitors, each item is the data related to a single * _'visitors'_: array of visitors, each item is the data related to a single
visitor. Each visitor array must contain at least following keys: visitor. Each visitor array must contain at least following keys:
@ -562,10 +562,10 @@ The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::USERS_UPDATE_VISITORS_ALTER` constant. `\Mibew\EventDispatcher\Events::USERS_UPDATE_VISITORS_ALTER` constant.
This event is triggered before the list of active site visitors list is sent to This event is triggered before the list of active site visitors list is sent to
the **Users application** on the client side. It provides plugins an ability to the **Users application** on the **Client** side. It provides plugins an
alter the list. A plugin can attach some custom fields to each visitor or even ability to alter the list. A plugin can attach some custom fields to each
completely replace the whole list. An associative array with the following visitor or even completely replace the whole list. An associative array with
items is passed to event handlers: the following items is passed to event handlers:
* _'visitors'_: array of visitors, each item is the data related to a single * _'visitors'_: array of visitors, each item is the data related to a single
visitor. See "[Load visitors](#load-visitors-event)" event and visitor. See "[Load visitors](#load-visitors-event)" event and
@ -578,7 +578,7 @@ items is passed to event handlers:
The event can be referenced using the value of The event can be referenced using the value of
`\Mibew\EventDispatcher\Events::USERS_FUNCTION_CALL` constant. `\Mibew\EventDispatcher\Events::USERS_FUNCTION_CALL` constant.
This event is triggered if an API function is called at the client side in This event is triggered if an API function is called at the **Client** side in
the **Users application**, but the system is not aware of this function. the **Users application**, but the system is not aware of this function.
Plugins can implement custom API functions by attaching handlers to this event. Plugins can implement custom API functions by attaching handlers to this event.