Class: OTS_GuildRank

Returns number of player within.

Loads rank by it's name. As there can be several ranks with same name in different guilds you can pass optional second parameter to specify in which guild script should look for rank.

Returns guild of this rank.

Returns players iterator. There is no need to implement entire Iterator interface since we have players list class for it.

Rank name.

List of characters with current rank. In difference to getPlayers() method this method returns filtered OTS_Players_List object instead of array of OTS_Player objects. It is more effective since OTS_Player_List doesn't perform all rows loading at once.

Note: Returned object is only prepared, but not initialised. When using as parameter in foreach loop it doesn't matter since it will return it's iterator, but if you will wan't to execute direct operation on that object you will need to call rewind() method first.

Loads rank with given id.

Writes custom field. Write field by it's name. Can write any field of given record that exists in database.

Note: You should use this method only for fields that are not provided in standard setters/getters (SVN fields). This method runs SQL query each time you call it so it highly overloads used resources.

Note: Make sure that you pass $value argument of correct type. This method determinates whether to quote field value. It is safe - it makes you sure that no unproper queries that could lead to SQL injection will be executed, but it can make your code working wrong way. For example: $object->setCustomField('foo', '1'); will quote 1 as as string ('1') instead of passing it as a integer.

Sets rank's access level within guild. This method only updates object state. To save changes in database you need to use save() method to flush changed to database.

Magic PHP5 method.

Returns string representation of object. If any display driver is currently loaded then it uses it's method. Else it returns rank name.