PHP 클래스 WebsiteAPI, Halite

상속: extends API

파일 보기 프로젝트 열기: HaliteChallenge/Halite 1 사용 예제들

공개 메소드들

메소드	설명
__construct ( $request )

보호된 메소드들

메소드	설명
announcement ( )	* Announcement Endpoint
botFile ( )	* Bot File Endpoint
email ( )	* Email Endpoint
emailList ( )	* Email List Endpoint
errorLog ( )	* Error Log Endpoint
forums ( )	* Forums Endpoint
game ( )	* Game Endpoint
history ( )	* User History Endpoint
notification ( )	* User Notification Endpoint
session ( )	* Session Endpoint
stats ( )	* Stats endpoint
user ( )	* User Endpoint
worker ( )	* Worker Endpoint

비공개 메소드들

메소드	설명
getForumsID ( $userID )	Gets the id of one of our users in the discourse forums system
getLoggedInUser ( )
getOrganizationForEmail ( $email )
getUsers ( $query, $privateInfo = false )
isLoggedIn ( )
logOutForums ( $forumsID )	Log a users out of forums.halite.io
sanitizeHTTPParameters ( )	* Apply MYSQL sanitization to all incoming parameters

메소드 상세

__construct() 공개 메소드

public __construct ( $request )

announcement() 보호된 메소드

Annoucements are used as 'news blasts' without requiring email. An alert with the annoucement's body and header is showed to users. Once it has been closed, it is never shown to that user again

protected announcement ( )

botFile() 보호된 메소드

Handles the user's submission of a new bot

protected botFile ( )

email() 보호된 메소드

Hitting this endpoint allows a user to handle the choosing of their email.

protected email ( )

emailList() 보호된 메소드

Hitting this endpoint allows a user to subscribe and unsubscribe from all Halite emails.

protected emailList ( )

errorLog() 보호된 메소드

When a users times-out or errors during a game of Halite on our server, we store their stdout and stderr output and make it available to them. Users may only see **their** error logs.

protected errorLog ( )

forums() 보호된 메소드

Handle the Discourse forums (forums.halite.io) single sign on authentication.

protected forums ( )

game() 보호된 메소드

Games are continuously run on our servers and exposed on our website

protected game ( )

history() 보호된 메소드

We store the a history of user's bot submissions. This mitigates the 'stealth' submission problem, where users submit a bot, wait for their rank to stabilize, and take it down for the sake of secrecy.

protected history ( )

notification() 보호된 메소드

Allows the downloading of all of the notifications a user has recieved over email. Notifications include "Compilation Success", "Bot received", etc

protected notification ( )

session() 보호된 메소드

Encapsulates the logged in user's info

protected session ( )

stats() 보호된 메소드

Provides a number of statistics about the competition, which would be expensive or impossible to determine using our generic endpoints.

protected stats ( )

user() 보호된 메소드

Encapsulates user information.

protected user ( )

worker() 보호된 메소드

Bots are compiled and run in games by a decentralized network of 'worker' servers. A few stats about each worker are recorded by our 'manager' server. These stats are exposed on our status page.

protected worker ( )