XG Proyect

Ranks
in package

Ranks Class

Tags
category

Classes

author

XG Proyect Team

license

http://www.xgproyect.org XG Proyect

link
http://www.xgproyect.org
version
3.1.0

Table of Contents

$_ranks  : array<string|int, mixed>
Contains the ranks
__construct()  : void
Constructor
addNew()  : array<string|int, mixed>
Create a new rank
deleteRankById()  : array<string|int, mixed>
editRankById()  : array<string|int, mixed>
Edit ranks by ID
editRankNameById()  : array<string|int, mixed>
Edit rank name
getAllRanksAsArray()  : array<string|int, mixed>
Get all the ranks permissions as an Array
getAllRanksAsJsonString()  : string
Get all the ranks permissions as a JSON
getRankById()  : array<string|int, mixed>
Get the permission for a certain rank
getRanks()  : string
Get the ranks
setRanks()  : mixed
Set the ranks
validateRankId()  : int
Validate the rank ID

Properties

$_ranks

Contains the ranks

private array<string|int, mixed> $_ranks = []

Methods

__construct()

Constructor

public __construct(string $alliance_ranks) : void
Parameters
$alliance_ranks : string

List of ranks as a JSON string

Tags
throws
Exception
Return values
void —

addNew()

Create a new rank

public addNew(string $name) : array<string|int, mixed>
Parameters
$name : string

Rank Name

Return values
array<string|int, mixed> —

deleteRankById()

public deleteRankById(mixed $rank_id) : array<string|int, mixed>
Parameters
$rank_id : mixed
Return values
array<string|int, mixed> —

editRankById()

Edit ranks by ID

public editRankById(int $rank_id, array<string|int, mixed> $rights) : array<string|int, mixed>
Parameters
$rank_id : int
$rights : array<string|int, mixed>
Tags
throws
Exception
Return values
array<string|int, mixed> —

editRankNameById()

Edit rank name

public editRankNameById(int $rank_id, string $name) : array<string|int, mixed>
Parameters
$rank_id : int
$name : string
Return values
array<string|int, mixed> —

getAllRanksAsArray()

Get all the ranks permissions as an Array

public getAllRanksAsArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getAllRanksAsJsonString()

Get all the ranks permissions as a JSON

public getAllRanksAsJsonString() : string
Return values
string —

getRankById()

Get the permission for a certain rank

public getRankById(int $rank_id) : array<string|int, mixed>
Parameters
$rank_id : int

Rank ID

Return values
array<string|int, mixed> —

getRanks()

Get the ranks

private getRanks() : string
Return values
string —

setRanks()

Set the ranks

private setRanks(string $ranks) : mixed
Parameters
$ranks : string

Ranks

Return values
mixed —

validateRankId()

Validate the rank ID

private validateRankId(type $rank_id) : int
Parameters
$rank_id : type

Rank ID

Return values
int —

Search results