Added php doc.

This commit is contained in:
James Cole
2016-01-11 21:42:51 +01:00
parent 5da5024ad3
commit da7eb615db
7 changed files with 68 additions and 1 deletions

View File

@@ -34,7 +34,6 @@ use Watson\Validating\ValidatingTrait;
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account hasMetaValue($name, $value) * @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account hasMetaValue($name, $value)
* @property string $startBalance * @property string $startBalance
* @property string $endBalance * @property string $endBalance
*
*/ */
class Account extends Model class Account extends Model
{ {

View File

@@ -27,6 +27,7 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
* @property-read Account $account * @property-read Account $account
* @property-read Collection|PiggyBankRepetition[] $piggyBankRepetitions * @property-read Collection|PiggyBankRepetition[] $piggyBankRepetitions
* @property-read Collection|PiggyBankEvent[] $piggyBankEvents * @property-read Collection|PiggyBankEvent[] $piggyBankEvents
* @property string $reminder
*/ */
class PiggyBank extends Model class PiggyBank extends Model
{ {

View File

@@ -15,6 +15,21 @@ use Illuminate\Database\Eloquent\Model;
* Class Rule * Class Rule
* *
* @package FireflyIII\Models * @package FireflyIII\Models
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property string $deleted_at
* @property integer $user_id
* @property integer $rule_group_id
* @property integer $order
* @property string $title
* @property string $description
* @property boolean $active
* @property boolean $stop_processing
* @property-read \FireflyIII\User $user
* @property-read \FireflyIII\Models\RuleGroup $ruleGroup
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\RuleAction[] $ruleActions
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\RuleTrigger[] $ruleTriggers
*/ */
class Rule extends Model class Rule extends Model
{ {

View File

@@ -15,6 +15,17 @@ use Illuminate\Database\Eloquent\Model;
* Class RuleAction * Class RuleAction
* *
* @package FireflyIII\Models * @package FireflyIII\Models
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property integer $rule_id
* @property integer $order
* @property boolean $active
* @property boolean $stop_processing
* @property string $action_field
* @property string $action
* @property string $action_value
* @property-read \FireflyIII\Models\Rule $rule
*/ */
class RuleAction extends Model class RuleAction extends Model
{ {

View File

@@ -15,6 +15,17 @@ use Illuminate\Database\Eloquent\Model;
* Class RuleGroup * Class RuleGroup
* *
* @package FireflyIII\Models * @package FireflyIII\Models
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property string $deleted_at
* @property integer $user_id
* @property integer $order
* @property string $title
* @property string $description
* @property boolean $active
* @property-read \FireflyIII\User $user
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Rule[] $rules
*/ */
class RuleGroup extends Model class RuleGroup extends Model
{ {

View File

@@ -15,6 +15,18 @@ use Illuminate\Database\Eloquent\Model;
* Class RuleTrigger * Class RuleTrigger
* *
* @package FireflyIII\Models * @package FireflyIII\Models
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property integer $rule_id
* @property integer $order
* @property string $title
* @property string $trigger_field
* @property string $trigger_type
* @property string $trigger_value
* @property boolean $active
* @property boolean $stop_processing
* @property-read \FireflyIII\Models\Rule $rule
*/ */
class RuleTrigger extends Model class RuleTrigger extends Model
{ {

View File

@@ -9,6 +9,24 @@ use Zizaco\Entrust\Traits\EntrustUserTrait;
* Class User * Class User
* *
* @package FireflyIII * @package FireflyIII
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property string $email
* @property string $password
* @property string $remember_token
* @property string $reset
* @property boolean $blocked
* @property string $blocked_code
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Account[] $accounts
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Attachment[] $attachments
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Tag[] $tags
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Bill[] $bills
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Budget[] $budgets
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Category[] $categories
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Preference[] $preferences
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\TransactionJournal[] $transactionjournals
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Role[] $roles
*/ */
class User extends Authenticatable class User extends Authenticatable
{ {