|
|
|
File: ./approot/engine/action.php
SIMU prototüüp nr 4 - GameEngine
Action
DAO
|
+-- GameEntity
|
+-- Action
Abstraktne mängu "käik", mis mõjutab mängu olekut.
|
private abstract class Action extends GameEntity
Abstraktne mängu "käik", mis mõjutab mängu olekut.
|
| |
|
Direct known subclasses: Activity, InfoRequest
|
|
|
|
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 Field Summary |
| integer |
$time_costAjakulu nädalates |
| string |
$headingPealkiri (kuvatakse tegevuse valikus) |
| string |
$descriptionKirjeldus (kuvatakse tegevuse valikus) |
| string |
$hintVihje. Võimalik lisainformatsioon valitava tegevuse kohta. |
| integer |
$subject_countVajalike subjektide arv, keda on vaja tegevuse läbiviimiseks. |
| string |
$messageTeade. Võidakse kuvada pärast tegevuse valikut. |
|
Private Field Summary |
| integer |
$weekOmab väärtust kronoloogiasse salvestatud Actioni korral. |
| unknown |
$subjects |
|
Public Method Details |
&instance |
|
public void &instance( [ mixed $instance_id ] )
|
| |
Väljastab uue iseenda klassi Action objekti, initsialiseerides selle või mitte.
|
| Parameter |
|
| mixed |
$instance_id |
= >>null<< |
|
valikuline exemprari identifikaator. Kui on ära jäetud väljastatakse
initsialiseerimata objekt |
|
| Returns |
void |
|
|
Private Method Details |
init |
|
private void init( )
|
| |
initsialiseerimine, kutsutakse välja konstruktorist.
Warning: documentation is missing.
|
| Returns |
void |
|
commit |
|
private abstract boolean commit( )
|
| |
Tegevuse/käigu toimepanek.
|
| Returns |
boolean |
|
load |
|
private void load( $week )
|
| |
load() väljakutsumine peaks olema samaväärne commit()-ga - objekt saab vajalikud väärtused.
See meetod implementeeritakse järglastes uuesti, kui on vajadus keerukama päringu järele. Mõne järglase jaoks pole siin mõnda välja vaja võibolla. Siin loetakse ka subjektid sisse (luuakse)
|
| Parameter |
|
|
$week |
|
|
Warning: documentation is missing. |
|
| Returns |
void |
|
save |
|
private abstract void save( $week )
|
| |
|
| Parameter |
|
|
$week |
|
|
Warning: documentation is missing. |
|
| Returns |
void |
|
get_subjects |
|
private void get_subjects( $week )
|
| |
See tehakse edaspidi group'i sees.
Siin tehakse: $g =& new Group($this->owner); $g->load_subjects($week); return $g;
|
| Parameter |
|
|
$week |
|
|
Warning: documentation is missing. |
|
| Returns |
void |
|
add_subjects |
|
private void add_subjects( integer $week, mixed $subjects )
|
| |
|
| Parameter |
|
|
|
| mixed |
$subjects |
|
|
- võib olla array või null või üksik value |
|
| Returns |
void |
|
commited |
|
private abstract integer commited( mixed $with_subject )
|
| |
Arv, mitu korda seda Actionit on tehtud ÜHE subjektiga..
Praegu võtab 1 parameetri Juhul kui param pole antud, võiks vaadata AB-st kas ta ise on tehtud (kas commit on tehtud)
|
| Parameter |
|
| mixed |
$with_subject |
|
|
Person'i identifikaator |
|
| Returns |
integer Arv , mitu korda tehtud (kui on 0, evalueerub false-ks - seda kasutatakse tõeväärtusena) |
|
all_commited |
|
private boolean all_commited( mixed $with_subjects )
|
| |
Väljastab, kas mingi action on läbi viidud antud subjekti(de)ga
Parameetriks kas üksikväärtus või array
|
| Parameter |
|
| mixed |
$with_subjects |
|
|
väärtus või massiiv Person'i identifikaatoritest |
|
| Returns |
boolean Kas Action on läbi viidud nende subjekti(de)ga |
|
get_related_info |
|
private void get_related_info( )
|
| |
Warning: documentation is missing.
|
| Returns |
void |
|
|
Public Field Details |
$time_cost |
|
public integer $time_cost
>>
Ajakulu nädalates
|
|
$heading |
|
public string $heading
>>
Pealkiri (kuvatakse tegevuse valikus)
|
|
$description |
|
public string $description
>>
Kirjeldus (kuvatakse tegevuse valikus)
|
|
$hint |
|
public string $hint
>>
Vihje. Võimalik lisainformatsioon valitava tegevuse kohta.
|
|
$subject_count |
|
public integer $subject_count
>>
Vajalike subjektide arv, keda on vaja tegevuse läbiviimiseks.
|
|
$message |
|
public string $message
>>
Teade. Võidakse kuvada pärast tegevuse valikut.
|
|
|
Private Field Details |
$week |
|
private integer $week
>>
Omab väärtust kronoloogiasse salvestatud Actioni korral.
|
|
$subjects |
|
private unknown $subjects
>>
|
|
|
|
|
|
| PHPDoc 1.0beta |