eduapi-port 0.1.0

A library for unofficial API for EduPage.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

const Class = require("./Class");
const Edupage = require("./Edupage");
const {ENTITY_TYPE} = require("./enums");
const Parent = require("./Parent");
const User = require("./User");

/**
 * @typedef {import("../lib/RawData").RawDataObject} RawDataObject
 */

class Student extends User {
	/**
	 * Creates an instance of Student.
	 * @param {RawDataObject} [data={}]
	 * @param {Edupage} [edupage=null]
	 * @memberof Student
	 */
	constructor(data = {}, edupage = null) {
		super(data, edupage);

		/**
		 * Edupage instance associated to this object
		 * @type {Edupage} 
		 */
		this.edupage = edupage;

		/**
		 * @type {number}
		 */
		this.number = +data.number;

		/**
		 * @type {number}
		 */
		this.numberInClass = +data.numberinclass;

		/**
		 * @type {string}
		 */
		this.parent1Id = data.parent1id;

		/**
		 * @type {string}
		 */
		this.parent2Id = data.parent2id;

		/**
		 * @type {string}
		 */
		this.parent3Id = data.parent3id;

		/**
		 * @type {string}
		 */
		this.userString = ENTITY_TYPE.STUDENT + this.id;


		/**
		 * @type {Parent}
		 */
		this.parent1 = data.parent1id ? new Parent({id: data.parent1id}, edupage) : null;

		/**
		 * @type {Parent}
		 */
		this.parent2 = data.parent2id ? new Parent({id: data.parent2id}, edupage) : null;

		/**
		 * @type {Parent}
		 */
		this.parent3 = data.parent3id ? new Parent({id: data.parent3id}, edupage) : null;


		/**
		 * @type {Class}
		 */
		this.class = null;

		if(this.edupage) Student.prototype.init.call(this);
	}

	/**
	 * 
	 * @param {Edupage} [edupage=null]
	 * @memberof Parent
	 */
	init(edupage = null) {
		if(edupage) this.edupage = edupage;

		this.class = this.edupage.classes.find(e => e.id == this._data.classid);
		this.parent1 = this.parent1 ? this.edupage.parents.find(e => e.id == this.parent1.id) : this.parent1;
		this.parent2 = this.parent2 ? this.edupage.parents.find(e => e.id == this.parent2.id) : this.parent2;
		this.parent3 = this.parent3 ? this.edupage.parents.find(e => e.id == this.parent3.id) : this.parent3;
	}

	/**
	 *
	 * @param {boolean} [parents=false]
	 * @return {string} 
	 * @memberof Student
	 */
	getUserString(parents = false) {
		return parents ?
			this.userString.split(/(?<=[a-z])(?=[0-9])/).join("Only") :
			this.userString;
	}
}

module.exports = Student;