Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: ./approot/engine/activity.php
SIMU prototüüp nr 4 - GameEngine

Activity

DAO
   |
  +-- GameEntity
     |
    +-- Action
       |
      +-- Activity

Mängu tegevus.

 

public class Activity extends Action

Mängu tegevus.
Tegevus, mida mängija saab mängus ette võtta. Selleks saadakse vastav Activity $game objekti meetodiga get_action() mille parameetriteks on $action_id ja $activity_id. Tegevuse sooritamiseks tuleb kustuda meetod commit().

 

Methods inherited from Action

init, &instance, get_subjects, add_subjects, all_commited, get_related_info

Methods inherited from GameEntity

gameentity, set_owner, init, id

Methods inherited from DAO

db_connect, assign_vars, assign_record, exec_sql, get_db_objects, get_db_key_objects, get_db_record, get_db_records, get_db_pairs, get_db_key_records, get_db_vertical_values, get_db_value

Public Method Summary

array

get_items()

Väljastab kõik mängu tegevused assotsiatiivmassiivina, mille elemendid on kujul (activity_id => name).Warning: documentation is missing.
void

commit([ mixed $subjects ])

Paneb toime tegevuse.Warning: documentation is missing.

Private Method Summary

void

set_id(integer $id)

Määrab missugust activitit objekt esindab.Warning: documentation is missing.
void

load( $week)

See implementeeritakse järglastes uuesti, kui on vajadus keerukama päringu järele.Warning: documentation is missing.
integer

execute_rules(array $rules, mixed $subjects)

Väljastab yes_result või no_result, milleni jõudis, ükskõik mis seal väljal ka ei ole (null?),
boolean

preconditions_satisfied(mixed $subjects)

Kontrollib kas eeltingimused, mis lubavad tegevust sooritada on rahuldatud.
mixed

determine_result(mixed $subjects)

void

save( $week)

Warning: documentation is missing.
void

commit_result(mixed $subjects)

Viib tegevuse põhjustatud muudatused andmebaasi.
void

give_points(string $subjects)

Annab punktid. Selleks peab olema eelnevalt determine_result($subjects) tehtud.
integer

commited(integer $with_subject)

Praegu võtab 1 parameetriWarning: documentation is missing.
void

P1( $id)

Warning: documentation is missing.

Fields inherited from Action

$time_cost, $heading, $description, $hint, $subject_count, $week, $message, $subjects

Fields inherited from GameEntity

$id, $name, $game_id, $user_id, $owner

Public Field Summary

integer

$result_id

Tulemuse identifikaator.
integer

$dice

Täringu väärtus.
string

$result_text

Tulemus tekstina (toimunu kirjeldus).
string

$points_by_words

Punktiarvestuse kirjeldus.

Public Method Details

get_items

public array get_items( )

  Väljastab kõik mängu tegevused assotsiatiivmassiivina, mille elemendid on kujul (activity_id => name).
(Saab kasutada eksemplari loomata, kui väljakutsuv objekt pärineb DAO klassist ehk omab meetodit get_db_pairs(). See ei ole staatiliselt kasutamine..)

Warning: documentation is missing.

Returns array

Massiiv elementidega kujul (activity_id => name)


commit

public void commit( [ mixed $subjects ] )

  Paneb toime tegevuse.

Warning: documentation is missing.

Parameter
mixed $subjects = >>null<<
Massiiv või üksikväärtus ($person_id), kellega tegevust tehakse.
Returns void


Private Method Details

set_id

private void set_id( integer $id )

  Määrab missugust activitit objekt esindab.

Warning: documentation is missing.

Parameter
integer $id
Activity identifikaator.
Returns void


load

private void load( $week )

  See implementeeritakse järglastes uuesti, kui on vajadus keerukama päringu järele.
Mõne järglase puhul tehakse võibolla tühja tööd, aga praegu vähem kirjutamist. Siin loetakse ka subjektid sisse (luuakse)

Warning: documentation is missing.

Parameter
$week
Warning: documentation is missing.
Returns void


execute_rules

private integer execute_rules( array $rules, mixed $subjects )

  Väljastab yes_result või no_result, milleni jõudis, ükskõik mis seal väljal ka ei ole (null?),
ebaõnnestumisel (lõpmatu tsükkel) mittenumbrilise väärtuse (false)

Parameter
array $rules
mixed $subjects
Massiiv või üksikväärtus ($person_id), kellega tegevust tehakse.
Returns integer


preconditions_satisfied

private boolean preconditions_satisfied( mixed $subjects )

  Kontrollib kas eeltingimused, mis lubavad tegevust sooritada on rahuldatud.
Kui ei ole rahuldatud, paneb message = by_words et kasutaja saaks aru milles oli probleem.

Parameter
mixed $subjects
Massiiv või üksikväärtus ($person_id), kellega tegevust tehakse.
Returns boolean


determine_result

private mixed determine_result( mixed $subjects )

 

Parameter
mixed $subjects
Massiiv või üksikväärtus ($person_id), kellega tegevust tehakse.
Returns mixed


save

private void save( $week )

 

Warning: documentation is missing.

Parameter
$week
Warning: documentation is missing.
Returns void


commit_result

private void commit_result( mixed $subjects )

  Viib tegevuse põhjustatud muudatused andmebaasi.

Parameter
mixed $subjects
Massiiv või üksikväärtus ($person_id), kellega tegevust tehakse.
Returns void


give_points

private void give_points( string $subjects )

  Annab punktid. Selleks peab olema eelnevalt determine_result($subjects) tehtud.

Parameter
string $subjects
Warning: documentation is missing.
Returns void


commited

private integer commited( integer $with_subject )

  Praegu võtab 1 parameetri
arv, mitu korda tehtud ÜHE subjektiga..

Warning: documentation is missing.

Parameter
integer $with_subject
Subjekt ($person_id)
Returns integer

arv , mitu korda tehtud (kui on 0, evalueerub false-ks - seda kasutatakse tõeväärtusena)


P1

private void P1( $id )

 

Warning: documentation is missing.

Parameter
$id
Warning: documentation is missing.
Returns void


Public Field Details

$result_id

public integer $result_id

>><<

Tulemuse identifikaator.
Saab väärtuse pärast meetodi commit() sooritamist.


$dice

public integer $dice

>><<

Täringu väärtus.
Saab väärtuse pärast meetodi commit() sooritamist.


$result_text

public string $result_text

>><<

Tulemus tekstina (toimunu kirjeldus).
Saab väärtuse pärast meetodi commit() sooritamist.


$points_by_words

public string $points_by_words

>><<

Punktiarvestuse kirjeldus.
Saab väärtuse pärast meetodi commit() sooritamist.



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta