Skip to content

Commit 5aa2cb4

Browse files
ContexContex
committed
First release of the API, undocumented.
1 parent 40c21f6 commit 5aa2cb4

File tree

4 files changed

+349
-1
lines changed

4 files changed

+349
-1
lines changed

‎HEADER.txt

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/*
2+
* This file is part of XenForoAPI <http://www.contex.me/>.
3+
*
4+
* XenForoAPI is free software: you can redistribute it and/or modify
5+
* it under the terms of the GNU Lesser General Public License as published by
6+
* the Free Software Foundation, either version 3 of the License, or
7+
* (at your option) any later version.
8+
*
9+
* XenForoAPI is distributed in the hope that it will be useful,
10+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
* GNU Lesser General Public License for more details.
13+
*
14+
* You should have received a copy of the GNU Lesser General Public License
15+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/

‎LICENSE.txt

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
XenForoAPI
22
==========
33

4-
This class can be used to use XenForo's function in other projects. One class to rule them all.
4+
This class can be used to use XenForo's function in other PHP projects. One class to rule them all.
5+
6+
Copyright (c) 2011-2012, Contex <http://www.contex.me>
7+
8+
XenForoAPI is licensed under GNU LESSER GENERAL PUBLIC LICENSE Version 3.

‎me/contex/php/xenforo/XenForoAPI/XenForoAPI.php

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
<?php
2+
/*
3+
* This file is part of XenForoAPI <http://www.contex.me/>.
4+
*
5+
* XenForoAPI is free software: you can redistribute it and/or modify
6+
* it under the terms of the GNU Lesser General Public License as published by
7+
* the Free Software Foundation, either version 3 of the License, or
8+
* (at your option) any later version.
9+
*
10+
* XenForoAPI is distributed in the hope that it will be useful,
11+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
* GNU Lesser General Public License for more details.
14+
*
15+
* You should have received a copy of the GNU Lesser General Public License
16+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
17+
*/
18+
$xf = new XenForoAPI("/home/contex/www/");
19+
echo $xf->getLatestUser()->getID() . "<br>";
20+
if (!$xf->getUser(1)->validateAuthentication("test")) {
21+
echo "Failed login!<br>";
22+
} else {
23+
echo "Passed login!<br>";
24+
}
25+
echo $xf->countTotalUsers() . "<br>";
26+
echo $xf->getLatestUser()->getID();
27+
28+
class XenForoAPI {
29+
private $xfDir, $startTime;
30+
private $models;
31+
32+
public function __construct($directory) {
33+
$this->xfDir = $directory;
34+
$this->startTime = microtime(true);
35+
require($this->xfDir . '/library/XenForo/Autoloader.php');
36+
XenForo_Autoloader::getInstance()->setupAutoloader($this->xfDir. '/library');
37+
XenForo_Application::initialize($this->xfDir . '/library', $this->xfDir);
38+
XenForo_Application::set('page_start_time', $this->startTime);
39+
$this->models = new XenForoModels();
40+
$this->models->setUserModel(XenForo_Model::create('XenForo_Model_User'));
41+
$this->models->setUserFieldModel(XenForo_Model::create('XenForo_Model_UserField'));
42+
}
43+
44+
public function getModels() {
45+
return $this->models;
46+
}
47+
48+
public function getUserModel() {
49+
return $this->models->getUserModel();
50+
}
51+
52+
public function getUserFieldModel() {
53+
return $this->models->getUserFieldModel();
54+
}
55+
56+
public function getLatestUser() {
57+
return new XenForoUser($this->models, $this->models->getUserModel()->getLatestUser());
58+
}
59+
60+
public function getTotalUsersCount() {
61+
return $this->models->getUserModel()->countTotalUsers();
62+
}
63+
64+
public function getUser($userInput) {
65+
if (is_int($userInput)) {
66+
return new XenForoUser($this->models, $this->models->getUserModel()->getUserById($userInput));
67+
} else if($this->models->getUserModel()->couldBeEmail($userInput)) {
68+
return new XenForoUser($this->models, $this->models->getUserModel()->getUserByEmail($userInput));
69+
} else {
70+
return new XenForoUser($this->models, $this->models->getUserModel()->getUserByName($userInput));
71+
}
72+
}
73+
}
74+
75+
class XenForoModels {
76+
private $userModel, $userFieldModel;
77+
78+
public function setUserModel($userModel) {
79+
$this->userModel = $userModel;
80+
}
81+
82+
public function getUserModel() {
83+
return $this->userModel;
84+
}
85+
86+
public function setUserFieldModel($userFieldModel) {
87+
$this->userFieldModel = $userFieldModel;
88+
}
89+
90+
public function getUserFieldModel() {
91+
return $this->userFieldModel;
92+
}
93+
}
94+
95+
class XenForoUser {
96+
private $models, $data;
97+
98+
public function __construct($models, $data) {
99+
$this->models = $models;
100+
$this->data = $data;
101+
}
102+
103+
public function getData() {
104+
return $this->data;
105+
}
106+
107+
public function getAuthenticationRecord() {
108+
return $this->models->getUserModel()->getUserAuthenticationRecordByUserId($this->getID());
109+
}
110+
111+
public function validateAuthentication($password) {
112+
return $this->models->getUserModel()->validateAuthentication($this->getUsername(), $password);
113+
}
114+
115+
public function getUnreadAlertsCount() {
116+
return $this->models->getUserModel()->getUnreadAlertsCount($this->getID());
117+
}
118+
119+
public function getID() {
120+
return $this->data['user_id'];
121+
}
122+
123+
public function getUsername() {
124+
return $this->data['username'];
125+
}
126+
127+
public function getEmail() {
128+
return $this->data['email'];
129+
}
130+
131+
public function getGender() {
132+
return $this->data['gender'];
133+
}
134+
135+
public function getCustomTitle() {
136+
return $this->data['custom_title'];
137+
}
138+
139+
public function getLanguageID() {
140+
return $this->data['language_id'];
141+
}
142+
143+
public function getStyleID() {
144+
return $this->data['style_id'];
145+
}
146+
147+
public function getTimezone() {
148+
return $this->data['timezone'];
149+
}
150+
151+
public function isVisible() {
152+
return $this->data['visible'];
153+
}
154+
155+
public function getGroupID() {
156+
return $this->data['user_group_id'];
157+
}
158+
159+
public function getSecondaryGroupIDs() {
160+
return $this->data['secondary_group_ids'];
161+
}
162+
}
163+
?>

0 commit comments

Comments
 (0)