1. Documentation
  2. API
  3. Library
  4. Auth
  5. Models
  6. User

October\Rain\Auth\Models\User

Extends:

Implements:

  • Illuminate\Contracts\Routing\UrlRoutable
  • Illuminate\Contracts\Queue\QueueableEntity
  • JsonSerializable
  • Illuminate\Contracts\Support\Jsonable
  • ArrayAccess
  • Illuminate\Contracts\Support\Arrayable
  • Illuminate\Contracts\Auth\Authenticatable

User model

Public properties

public array $rules

rules for validation

public array $belongsToMany

belongsToMany relation

public array $belongsTo

belongsTo relation

public array $attributeNames

attributeNames array of custom attribute names

public array $customMessages

customMessages array of custom error messages

public static string $loginAttribute

loginAttribute

Show inherited public properties

Inherited public properties

  • public array $implement - defined in October\Rain\Database\Model. Behaviors implemented by this model.
  • public array $attributes - defined in October\Rain\Database\Model. Make the model's attributes public so behaviors can modify them.
  • public bool $duplicateCache - defined in October\Rain\Database\Model. duplicateCache queries from this model should be cached in memory.
  • public bool $trimStrings - defined in October\Rain\Database\Model. trimStrings will trim all string attributes of whitespace.
  • public bool $incrementing - defined in Illuminate\Database\Eloquent\Model. Indicates if the IDs are auto-incrementing.
  • public bool $exists - defined in Illuminate\Database\Eloquent\Model. Indicates if the model exists.
  • public bool $wasRecentlyCreated - defined in Illuminate\Database\Eloquent\Model. Indicates if the model was inserted during the current request lifecycle.
  • public static bool $snakeAttributes - defined in Illuminate\Database\Eloquent\Model. Indicates whether attributes are snake cased on arrays.
  • public static array $manyMethods - defined in Illuminate\Database\Eloquent\Model. The many to many relationship methods.
  • public bool $timestamps - defined in Illuminate\Database\Eloquent\Model. Indicates if the model should be timestamped.
  • public array $hasMany - defined in October\Rain\Database\Model. Cleaner declaration of relationships.
  • public $hasOne - defined in October\Rain\Database\Model. protected $hasOne = [.
  • public $morphTo - defined in October\Rain\Database\Model. protected $morphTo = [.
  • public $morphOne - defined in October\Rain\Database\Model. protected $morphOne = [.
  • public $morphMany - defined in October\Rain\Database\Model. protected $morphMany = [.
  • public $morphToMany - defined in October\Rain\Database\Model. protected $morphToMany = [.
  • public $morphedByMany - defined in October\Rain\Database\Model.
  • public $attachOne - defined in October\Rain\Database\Model. protected $attachOne = [.
  • public $attachMany - defined in October\Rain\Database\Model. protected $attachMany = [.
  • public $hasManyThrough - defined in October\Rain\Database\Model. protected $hasManyThrough = [.
  • public $hasOneThrough - defined in October\Rain\Database\Model. protected $hasOneThrough = [.
  • public string $sessionKey - defined in October\Rain\Database\Model. A unique session key used for deferred binding.

Protected properties

protected string $table

table associated with the model

protected array $dates

dates attributes that should be mutated to dates

protected array $hidden

hidden attributes removed from the API representation of the model (ex. toArray())

protected array $guarded

guarded attributes aren't mass assignable

protected array $hashable

hashable list of attribute names which should be hashed using the Bcrypt hashing algorithm

protected array $purgeable

purgeable list of attribute names which should not be saved to the database

protected array $jsonable

jsonable attribute names that are json encoded and decoded from the database

protected array $allowedPermissionsValues

allowedPermissionsValues

Possible options: -1 => Deny (adds to array, but denies regardless of user's group). 0 => Remove. 1 => Add.

protected string $rememberTokenName

rememberTokenName is the column name of the "remember me" token

protected array $mergedPermissions

mergedPermissions for the user

protected array $originalHashableValues

List of original attribute values before they were hashed.

protected array $originalPurgeableValues

List of original attribute values before they were purged.

protected Illuminate\Support\MessageBag $validationErrors

validationErrors message bag instance containing validation error messages

protected array $validationDefaultAttrNames

validationDefaultAttrNames default custom attribute names

Show inherited protected properties

Inherited protected properties

  • protected static array $eventsBooted - defined in October\Rain\Database\Model. The array of models booted events.
  • protected string|null $connection - defined in Illuminate\Database\Eloquent\Model. The connection name for the model.
  • protected string $primaryKey - defined in Illuminate\Database\Eloquent\Model. The primary key for the model.
  • protected string $keyType - defined in Illuminate\Database\Eloquent\Model. The "type" of the primary key ID.
  • protected array $with - defined in Illuminate\Database\Eloquent\Model. The relations to eager load on every query.
  • protected array $withCount - defined in Illuminate\Database\Eloquent\Model. The relationship counts that should be eager loaded on every query.
  • protected int $perPage - defined in Illuminate\Database\Eloquent\Model. The number of models to return for pagination.
  • protected static Illuminate\Database\ConnectionResolverInterface $resolver - defined in Illuminate\Database\Eloquent\Model. The connection resolver instance.
  • protected static Illuminate\Contracts\Events\Dispatcher $dispatcher - defined in Illuminate\Database\Eloquent\Model. The event dispatcher instance.
  • protected static array $booted - defined in Illuminate\Database\Eloquent\Model. The array of booted models.
  • protected static array $traitInitializers - defined in Illuminate\Database\Eloquent\Model. The array of trait initializers that will be called on each new instance.
  • protected static array $globalScopes - defined in Illuminate\Database\Eloquent\Model. The array of global scopes on the model.
  • protected static array $ignoreOnTouch - defined in Illuminate\Database\Eloquent\Model. The list of models classes that should not be affected with touch.
  • protected array $original - defined in Illuminate\Database\Eloquent\Model. The model attribute's original state.
  • protected array $changes - defined in Illuminate\Database\Eloquent\Model. The changed model attributes.
  • protected array $casts - defined in Illuminate\Database\Eloquent\Model. The attributes that should be cast to native types.
  • protected string $dateFormat - defined in Illuminate\Database\Eloquent\Model. The storage format of the model's date columns.
  • protected array $appends - defined in Illuminate\Database\Eloquent\Model. The accessors to append to the model's array form.
  • protected static array $mutatorCache - defined in Illuminate\Database\Eloquent\Model. The cache of the mutated attributes for each class.
  • protected array $dispatchesEvents - defined in Illuminate\Database\Eloquent\Model. The event map for the model.
  • protected array $observables - defined in Illuminate\Database\Eloquent\Model. User exposed observable events.
  • protected array $relations - defined in Illuminate\Database\Eloquent\Model. The loaded relationships for the model.
  • protected array $touches - defined in Illuminate\Database\Eloquent\Model. The relationships that should be touched on save.
  • protected array $visible - defined in Illuminate\Database\Eloquent\Model. The attributes that should be visible in serialization.
  • protected array $fillable - defined in Illuminate\Database\Eloquent\Model. The attributes that are mass assignable.
  • protected static bool $unguarded - defined in Illuminate\Database\Eloquent\Model. Indicates if all mass assignment is enabled.
  • protected static array $guardableColumns - defined in Illuminate\Database\Eloquent\Model. The actual columns that exist on the database and can be guarded.
  • protected static array $relationTypes - defined in October\Rain\Database\Model. Excepted relationship types, used to cycle and verify relationships.
  • protected array $emitterSingleEventCollection - defined in October\Rain\Database\Model. Collection of registered events to be fired once only.
  • protected array $emitterEventCollection - defined in October\Rain\Database\Model. Collection of registered events.
  • protected array $emitterEventSorted - defined in October\Rain\Database\Model. Sorted collection of events.
  • protected array $extensionData - defined in October\Rain\Database\Model. extensionData contains class reflection information, including behaviors.
  • protected static array $extendableCallbacks - defined in October\Rain\Database\Model. Used to extend the constructor of an extendable class.
  • protected static array $extendableStaticMethods - defined in October\Rain\Database\Model. Collection of static methods used by behaviors.
  • protected static bool $extendableGuardProperties - defined in October\Rain\Database\Model. Indicates if dynamic properties can be created.

Public methods

public bool addGroup(Group $group)

addGroup adds the user to the given group

Parameters
  • Group $group

public $this addHashable(array|string|null $attributes=NULL)

Adds an attribute to the hashable attributes list

Parameters
  • array|string|null $attributes

public $this addPurgeable(array|string|null $attributes=NULL)

Adds an attribute to the purgeable attributes list

Parameters
  • array|string|null $attributes

public bool afterDelete()

afterDelete deletes the user groups

public void afterLogin()

afterLogin event

public bool attemptActivation(string $activationCode)

attemptActivation the given user by checking the activate code. If the user is activated already, an Exception is thrown

Parameters
  • string $activationCode

public bool attemptResetPassword(string $resetCode, string $newPassword)

attemptResetPassword a user's password by matching the reset code generated with the users

Parameters
  • string $resetCode
  • string $newPassword

public void beforeLogin()

beforeLogin event

public static void bootHashable()

Boot the hashable trait for a model.

public static void bootPurgeable()

Boot the purgeable trait for a model.

public static void bootValidation()

bootValidation for this model

public bool checkHashValue(string $key, string $value)

Checks if the supplied plain value matches the stored hash value.

Parameters
  • string $key - Attribute to check
  • string $value - Value to check

public bool checkPassword(string $password)

checkPassword checks the password passed matches the user's password

Parameters
  • string $password

public bool checkPersistCode(string $persistCode)

checkPersistCode checks the given persist code

Parameters
  • string $persistCode

public bool checkResetPasswordCode(string $resetCode)

checkResetPasswordCode checks if the provided user reset password code is valid without actually resetting the password

Parameters
  • string $resetCode

public void clearResetPassword()

clearResetPassword wipes out the data associated with resetting a password

public Illuminate\Support\MessageBag errors()

errors gets validation error message collection for the Model

public bool forceSave($options=NULL, $sessionKey=NULL)

forceSave the model even if validation fails

Parameters
  • $options
  • $sessionKey

public string getActivationCode()

getActivationCode for the given user

public mixed getAuthIdentifier()

getAuthIdentifier gets the unique identifier for the user

public string getAuthIdentifierName()

getAuthIdentifierName gets the name of the unique identifier for the user

public string getAuthPassword()

getAuthPassword gets the password for the user

public array getGroups()

getGroups returns an array of groups which the given user belongs to

public array getHashableAttributes()

Returns a collection of fields that will be hashed.

public bool getIsActivatedAttribute(mixed $activated)

getIsActivatedAttribute is a get mutator for giving the activated property

Parameters
  • mixed $activated

public mixed getLogin()

public string getLoginName()

public array getMergedPermissions()

getMergedPermissions returns an array of merged permissions for each group the user is in

public mixed getOriginalHashValue($attribute)

Returns the original values of any hashed attributes.

Parameters
  • $attribute

public array getOriginalHashValues()

Returns the original values of any hashed attributes.

public void getOriginalPurgeValue($attribute)

Returns the original values of any purged attributes.

Parameters
  • $attribute

public void getOriginalPurgeValues()

Returns the original values of any purged attributes.

public string getPersistCode()

getPersistCode gets a code for when the user is persisted to a cookie or session which identifies the user

public void getPurgeableAttributes()

Returns a collection of fields that will be hashed.

public string getRandomString($length=42)

getRandomString generates a random string

Parameters
  • $length

public string getRememberToken()

getRememberToken gets the token value for the "remember me" session

public string getRememberTokenName()

getRememberTokenName gets the column name for the "remember me" token

public string getReminderEmail()

getReminderEmail gets the e-mail address where password reminders are sent

public string getResetPasswordCode()

getResetPasswordCode gets a reset password code for the given user

public October\Rain\Auth\Models\Role getRole()

getRole returns the role assigned to this user

public bool hasAccess(string|array $permissions, bool $all=true)

hasAccess sees if a user has access to the passed permission(s). Permissions are merged from all groups the user belongs to and then are checked against the passed permission(s).

If multiple permissions are passed, the user must have access to all permissions passed through, unless the "all" flag is set to false.

Super users have access no matter what.

Parameters
  • string|array $permissions
  • bool $all

public bool hasAnyAccess(array $permissions)

hasAnyAccess returns if the user has access to any of the given permissions

Parameters
  • array $permissions

public bool hasPermission(string|array $permissions, bool $all=true)

hasPermission sees if a user has access to the passed permission(s). Permissions are merged from all groups the user belongs to and then are checked against the passed permission(s).

If multiple permissions are passed, the user must have access to all permissions passed through, unless the "all" flag is set to false.

Super users don't have access no matter what.

Parameters
  • string|array $permissions
  • bool $all

public bool inGroup(Group $group)

inGroup see if the user is in the given group

Parameters
  • Group $group

public boolean isAttributeRequired(string $attribute, boolean $checkDependencies=true)

isAttributeRequired determines if an attribute is required based on the validation rules. checkDependencies checks the attribute dependencies (for required_if & required_with rules). Note that it will only be checked up to the next level, if another dependent rule is found then it will just assume the field is required.

Parameters
  • string $attribute
  • boolean $checkDependencies

public bool isSuperUser()

isSuperUser checks if the user is a super user - has access to everything regardless of permissions

public string makeHashValue(string $key, string $value)

Hashes an attribute value and saves it in the original locker.

Parameters
  • string $key - Attribute
  • string $value - Value to hash

public array purgeAttributes($attributes $attributesToPurge=NULL)

Removes purged attributes from the dataset, used before saving.

Parameters
  • $attributes $attributesToPurge - Mixed Attribute(s) to purge, if unspecified, $purgable property is used

public bool removeGroup(Group $group)

removeGroup removes the user from the given group

Parameters
  • Group $group

public void restorePurgedValues()

Restores the original values of any purged attributes.

public void setPasswordAttribute($value)

setPasswordAttribute protects the password from being reset to null

Parameters
  • $value

public void setPermissionsAttribute(array $permissions)

setPermissionsAttribute validates any set permissions

Parameters
  • array $permissions

public void setRememberToken(string $value)

setRememberToken sets the token value for the "remember me" session

Parameters
  • string $value

public void setValidationAttributeName(string $attr, string $name)

setValidationAttributeName programatically sets the validation attribute names, will take lower priority to model defined attribute names found in $attributeNames

Parameters
  • string $attr
  • string $name

public void setValidationAttributeNames(array $attributeNames)

setValidationAttributeNames programatically sets multiple validation attribute names

Parameters
  • array $attributeNames

public bool validate($rules=NULL, $customMessages=NULL, $attributeNames=NULL)

validate the model instance

Parameters
  • $rules
  • $customMessages
  • $attributeNames

public static void validated(Closure|string $callback)

validated create a new native event for handling afterValidate()

Parameters
  • Closure|string $callback

public static void validating(Closure|string $callback)

validating creates a new native event for handling beforeValidate()

Parameters
  • Closure|string $callback

Show inherited public methods

Inherited public methods

  • public void __call($name, $params) - defined in October\Rain\Database\Model.
  • public static mixed __callStatic(string $method, array $parameters) - defined in Illuminate\Database\Eloquent\Model. Handle dynamic static method calls into the method.
  • public void __construct($attributes=array()) - defined in October\Rain\Database\Model. Constructor.
  • public void __get($name) - defined in October\Rain\Database\Model.
  • public bool __isset(string $key) - defined in October\Rain\Database\Model. Determine if an attribute or relation exists on the model.
  • public void __set($name, $value) - defined in October\Rain\Database\Model.
  • public string __toString() - defined in Illuminate\Database\Eloquent\Model. Convert the model to its string representation.
  • public void __unset(string $key) - defined in Illuminate\Database\Eloquent\Model. Unset an attribute on the model.
  • public void __wakeup() - defined in Illuminate\Database\Eloquent\Model. When a model is being unserialized, check if it needs to be booted.
  • public void addCasts(array $attributes) - defined in October\Rain\Database\Model. Add attribute casts for the model.
  • public void addDateAttribute(string $attribute) - defined in October\Rain\Database\Model. Adds a datetime attribute to convert to an instance of Carbon/DateTime object.
  • public void addDynamicMethod(string $dynamicName, callable $method, string $extension=NULL) - defined in October\Rain\Database\Model. Programmatically adds a method to the extendable class.
  • public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in October\Rain\Database\Model. Programmatically adds a property to the extendable class.
  • public void addFillable(array|string|null $attributes=NULL) - defined in October\Rain\Database\Model. Add fillable attributes for the model.
  • public static mixed addGlobalScope(Illuminate\Database\Eloquent\Scope|\Closure|string $scope, Closure|null $implementation=NULL) - defined in Illuminate\Database\Eloquent\Model. Register a new global scope on the model.
  • public void addHidden(array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Add hidden attributes for the model.
  • public void addJsonable(array|string|null $attributes=NULL) - defined in October\Rain\Database\Model. Add jsonable attributes for the model.
  • public void addObservableEvents(array|mixed $observables) - defined in Illuminate\Database\Eloquent\Model. Add an observable event name.
  • public void addVisible(array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Add visible attributes for the model.
  • public static Illuminate\Database\Eloquent\Collection|static[] all(array|mixed $columns=array( 0=>'*')) - defined in Illuminate\Database\Eloquent\Model. Get all of the models from the database.
  • public bool alwaysPush(array $options, string $sessionKey) - defined in October\Rain\Database\Model. Pushes the first level of relations even if the parent.
  • public $this append(array|string $attributes) - defined in Illuminate\Database\Eloquent\Model. Append attributes to query when building a query.
  • public mixed asExtension(string $shortName) - defined in October\Rain\Database\Model. Short hand for getClassExtension() method, except takes the short.
  • public October\Rain\Database\Relations\MorphMany attachMany($related, $isPublic=NULL, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define an attachment one-to-many relationship.
  • public October\Rain\Database\Relations\MorphOne attachOne($related, $isPublic=true, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define an attachment one-to-one relationship.
  • public array attributesToArray() - defined in October\Rain\Database\Model. Convert the model's attributes to an array.
  • public October\Rain\Database\Relations\BelongsTo belongsTo($related, $foreignKey=NULL, $parentKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define an inverse one-to-one or many relationship.
  • public October\Rain\Database\Relations\BelongsToMany belongsToMany($related, $table=NULL, $primaryKey=NULL, $foreignKey=NULL, $parentKey=NULL, $relatedKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a many-to-many relationship.
  • public void bindDeferred($relation, $record, $sessionKey, $pivotData=array()) - defined in October\Rain\Database\Model. Bind a deferred relationship to the supplied record.
  • public self bindEvent($event, $callback, $priority=0) - defined in October\Rain\Database\Model. Create a new event binding.
  • public self bindEventOnce($event, $callback) - defined in October\Rain\Database\Model. Create a new event binding that fires once only.
  • public static void cacheMutatedAttributes(string $class) - defined in Illuminate\Database\Eloquent\Model. Extract and cache all the mutated attributes of a class.
  • public void cancelDeferred($sessionKey) - defined in October\Rain\Database\Model. Cancel all deferred bindings to this model.
  • public static void clearBootedModels() - defined in Illuminate\Database\Eloquent\Model. Clear the list of booted models so they will be re-booted.
  • public static void clearExtendedClasses() - defined in October\Rain\Database\Model. Clear the list of extended classes so they will be re-extended.
  • public void commitDeferred($sessionKey) - defined in October\Rain\Database\Model. Commit all deferred bindings to this model.
  • public static Illuminate\Database\Eloquent\Model|static create(array $attributes=array(), string $sessionKey=NULL) - defined in October\Rain\Database\Model. Save a new model and return the instance.
  • public static void created(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a created model event with the dispatcher.
  • public static void creating(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a creating model event with the dispatcher.
  • public bool|null delete() - defined in Illuminate\Database\Eloquent\Model. Delete the model from the database.
  • public static void deleted(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a deleted model event with the dispatcher.
  • public static void deleting(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a deleting model event with the dispatcher.
  • public static int destroy(Illuminate\Support\Collection|array|int $ids) - defined in Illuminate\Database\Eloquent\Model. Destroy the models for the given IDs.
  • public static void extend($callback) - defined in October\Rain\Database\Model. Extend this object properties upon construction.
  • public void extendClassWith(string $extensionName) - defined in October\Rain\Database\Model. Dynamically extend a class with a specified behavior.
  • public mixed extendableCall(string $name, array $params=NULL) - defined in October\Rain\Database\Model. Magic method for __call().
  • public static mixed extendableCallStatic(string $name, array $params=NULL) - defined in October\Rain\Database\Model. Magic method for __callStatic().
  • public void extendableConstruct() - defined in October\Rain\Database\Model. extendableConstruct should be called as part of the constructor.
  • public static void extendableExtendCallback(callable $callback) - defined in October\Rain\Database\Model. extendableExtendCallback is a helper method for ::extend() static method.
  • public string extendableGet(string $name) - defined in October\Rain\Database\Model. Magic method for __get().
  • public string extendableSet(string $name, string $value) - defined in October\Rain\Database\Model. Magic method for __set().
  • public static void fetched(Closure|string $callback) - defined in October\Rain\Database\Model. Create a new native event for handling afterFetch().
  • public static void fetching(Closure|string $callback) - defined in October\Rain\Database\Model. Create a new native event for handling beforeFetch().
  • public $this fill(array $attributes) - defined in Illuminate\Database\Eloquent\Model. Fill the model with an array of attributes.
  • public $this fillJsonAttribute(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set a given JSON attribute on the model.
  • public $this fillable(array $fillable) - defined in Illuminate\Database\Eloquent\Model. Set the fillable attributes for the model.
  • public array fireEvent(string $event, array $params=array(), boolean $halt=false) - defined in October\Rain\Database\Model. Fire an event and call the listeners.
  • public static void flushDuplicateCache() - defined in October\Rain\Database\Model. Flush the memory cache.
  • public static void flushEventListeners() - defined in October\Rain\Database\Model. Remove all of the event listeners for the model.
  • public bool|null forceDelete() - defined in Illuminate\Database\Eloquent\Model. Force a hard delete on a soft deleted model.
  • public $this forceFill(array $attributes) - defined in Illuminate\Database\Eloquent\Model. Fill the model with an array of attributes. Force mass assignment.
  • public static|null fresh(array|string $with=array()) - defined in Illuminate\Database\Eloquent\Model. Reload a fresh model instance from the database.
  • public October\Rain\Argon\Argon freshTimestamp() - defined in October\Rain\Database\Model. Get a fresh timestamp for the model.
  • public string freshTimestampString() - defined in Illuminate\Database\Eloquent\Model. Get a fresh timestamp for the model.
  • public string fromDateTime(DateTime|int $value) - defined in October\Rain\Database\Model. Convert a DateTime to a storable string.
  • public mixed fromFloat(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Decode the given float.
  • public mixed fromJson(string $value, bool $asObject=false) - defined in Illuminate\Database\Eloquent\Model. Decode the given JSON back into an array or object.
  • public static string getActualClassNameForMorph(string $class) - defined in Illuminate\Database\Eloquent\Model. Retrieve the actual class name for a given morph class.
  • public mixed getAttribute($key) - defined in October\Rain\Database\Model. Get an attribute from the model.
  • public mixed getAttributeValue(string $key) - defined in October\Rain\Database\Model. Get a plain attribute (not a relationship).
  • public array getAttributes() - defined in Illuminate\Database\Eloquent\Model. Get all of the current attributes on the model.
  • public array getCasts() - defined in Illuminate\Database\Eloquent\Model. Get the casts array.
  • public array getChanges() - defined in Illuminate\Database\Eloquent\Model. Get the attributes that were changed.
  • public mixed getClassExtension(string $name) - defined in October\Rain\Database\Model. Returns a behavior object from an extendable class, example:.
  • public array getClassMethods() - defined in October\Rain\Database\Model. Get a list of class methods, extension equivalent of get_class_methods().
  • public Illuminate\Database\Connection getConnection() - defined in Illuminate\Database\Eloquent\Model. Get the database connection for the model.
  • public string|null getConnectionName() - defined in Illuminate\Database\Eloquent\Model. Get the current connection name for the model.
  • public static Illuminate\Database\ConnectionResolverInterface getConnectionResolver() - defined in Illuminate\Database\Eloquent\Model. Get the connection resolver instance.
  • public string|null getCreatedAtColumn() - defined in Illuminate\Database\Eloquent\Model. Get the name of the "created at" column.
  • public string getDateFormat() - defined in Illuminate\Database\Eloquent\Model. Get the format for database stored dates.
  • public array getDates() - defined in Illuminate\Database\Eloquent\Model. Get the attributes that should be converted to dates.
  • public array getDirty() - defined in Illuminate\Database\Eloquent\Model. Get the attributes that have been changed since last sync.
  • public array getDynamicProperties() - defined in October\Rain\Database\Model. Returns all dynamic properties and their values.
  • public static Illuminate\Contracts\Events\Dispatcher getEventDispatcher() - defined in Illuminate\Database\Eloquent\Model. Get the event dispatcher instance.
  • public array getFillable() - defined in Illuminate\Database\Eloquent\Model. Get the fillable attributes for the model.
  • public string getForeignKey() - defined in Illuminate\Database\Eloquent\Model. Get the default foreign key name for the model.
  • public static Illuminate\Database\Eloquent\Scope|\Closure|null getGlobalScope(Illuminate\Database\Eloquent\Scope|string $scope) - defined in Illuminate\Database\Eloquent\Model. Get a global scope registered with the model.
  • public array getGlobalScopes() - defined in Illuminate\Database\Eloquent\Model. Get the global scopes for this class instance.
  • public array getGuarded() - defined in Illuminate\Database\Eloquent\Model. Get the guarded attributes for the model.
  • public array getHidden() - defined in Illuminate\Database\Eloquent\Model. Get the hidden attributes for the model.
  • public bool getIncrementing() - defined in Illuminate\Database\Eloquent\Model. Get the value indicating whether the IDs are incrementing.
  • public array getJsonable() - defined in October\Rain\Database\Model. Get the jsonable attributes name.
  • public mixed getKey() - defined in Illuminate\Database\Eloquent\Model. Get the value of the model's primary key.
  • public string getKeyName() - defined in Illuminate\Database\Eloquent\Model. Get the primary key for the model.
  • public string getKeyType() - defined in Illuminate\Database\Eloquent\Model. Get the auto-incrementing key type.
  • public string getMorphClass() - defined in Illuminate\Database\Eloquent\Model. Get the class name for polymorphic relations.
  • public array getMutatedAttributes() - defined in Illuminate\Database\Eloquent\Model. Get the mutated attributes for a given instance.
  • public array getObservableEvents() - defined in October\Rain\Database\Model. Get the observable event names.
  • public mixed|array getOriginal(string|null $key=NULL, mixed $default=NULL) - defined in Illuminate\Database\Eloquent\Model. Get the model's original attribute values.
  • public int getPerPage() - defined in Illuminate\Database\Eloquent\Model. Get the number of models to return per page.
  • public string getQualifiedCreatedAtColumn() - defined in Illuminate\Database\Eloquent\Model. Get the fully qualified "created at" column.
  • public string getQualifiedKeyName() - defined in Illuminate\Database\Eloquent\Model. Get the table qualified key name.
  • public string getQualifiedUpdatedAtColumn() - defined in Illuminate\Database\Eloquent\Model. Get the fully qualified "updated at" column.
  • public string|null getQueueableConnection() - defined in Illuminate\Database\Eloquent\Model. Get the queueable connection for the entity.
  • public mixed getQueueableId() - defined in Illuminate\Database\Eloquent\Model. Get the queueable identity for the entity.
  • public array getQueueableRelations() - defined in Illuminate\Database\Eloquent\Model. Get the queueable relationships for the entity.
  • public mixed getRelation(string $relation) - defined in Illuminate\Database\Eloquent\Model. Get a specified relationship.
  • public array getRelationDefinition(string $name) - defined in October\Rain\Database\Model. Returns relationship details from a supplied name.
  • public array getRelationDefinitions() - defined in October\Rain\Database\Model. Returns relationship details for all relations defined on this model.
  • public October\Rain\Database\Relation getRelationType(string $name) - defined in October\Rain\Database\Model. Returns a relationship type based on a supplied name.
  • public void getRelationValue($relationName) - defined in October\Rain\Database\Model. Returns a relation key value(s), not as an object.
  • public array getRelations() - defined in Illuminate\Database\Eloquent\Model. Get all the loaded relations for the instance.
  • public mixed getRouteKey() - defined in Illuminate\Database\Eloquent\Model. Get the value of the model's route key.
  • public string getRouteKeyName() - defined in Illuminate\Database\Eloquent\Model. Get the route key for the model.
  • public string getTable() - defined in Illuminate\Database\Eloquent\Model. Get the table associated with the model.
  • public array getTouchedRelations() - defined in Illuminate\Database\Eloquent\Model. Get the relationships that are touched on save.
  • public string|null getUpdatedAtColumn() - defined in Illuminate\Database\Eloquent\Model. Get the name of the "updated at" column.
  • public array getVisible() - defined in Illuminate\Database\Eloquent\Model. Get the visible attributes for the model.
  • public $this guard(array $guarded) - defined in Illuminate\Database\Eloquent\Model. Set the guarded attributes for the model.
  • public bool hasCast(string $key, array|string|null $types=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine whether an attribute should be cast to a native type.
  • public bool hasGetMutator(string $key) - defined in October\Rain\Database\Model. Determine if a get mutator exists for an attribute.
  • public static bool hasGlobalScope(Illuminate\Database\Eloquent\Scope|string $scope) - defined in Illuminate\Database\Eloquent\Model. Determine if a model has a global scope.
  • public October\Rain\Database\Relations\HasMany hasMany($related, $primaryKey=NULL, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a one-to-many relationship.
  • public October\Rain\Database\Relations\HasManyThrough hasManyThrough($related, $through, $primaryKey=NULL, $throughKey=NULL, $localKey=NULL, $secondLocalKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a has-many-through relationship.
  • public October\Rain\Database\Relations\HasOne hasOne($related, $primaryKey=NULL, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a one-to-one relationship.
  • public October\Rain\Database\Relations\HasOneThrough hasOneThrough($related, $through, $primaryKey=NULL, $throughKey=NULL, $localKey=NULL, $secondLocalKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a has-one-through relationship.
  • public bool hasRelation(string $name) - defined in October\Rain\Database\Model. Checks if model has a relationship by supplied name.
  • public bool hasSetMutator(string $key) - defined in October\Rain\Database\Model. Determine if a set mutator exists for an attribute.
  • public bool is(Illuminate\Database\Eloquent\Model|null $model) - defined in Illuminate\Database\Eloquent\Model. Determine if two models have the same ID and belong to the same table.
  • public boolean isClassExtendedWith(string $name) - defined in October\Rain\Database\Model. Check if extendable class is extended with a behavior object.
  • public bool isClean(array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine if the model and all the given attribute(s) have remained the same.
  • public void isDeferrable($relationName) - defined in October\Rain\Database\Model. Returns true if a relation exists and can be deferred.
  • public bool isDirty(array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine if the model or any of the given attribute(s) have been modified.
  • public bool isFillable(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine if the given attribute may be mass assigned.
  • public bool isGuarded(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine if the given key is guarded.
  • public static bool isIgnoringTouch(string|null $class=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine if the given model is ignoring touches.
  • public array isJsonable($key) - defined in October\Rain\Database\Model. Checks if an attribute is jsonable or not.
  • public bool isNot(Illuminate\Database\Eloquent\Model|null $model) - defined in Illuminate\Database\Eloquent\Model. Determine if two models are not the same.
  • public boolean isRelationPushable(string $name) - defined in October\Rain\Database\Model. Determines whether the specified relation should be saved.
  • public static bool isUnguarded() - defined in Illuminate\Database\Eloquent\Model. Determine if current state is "unguarded".
  • public string joiningTable(string $related, Illuminate\Database\Eloquent\Model|null $instance=NULL) - defined in Illuminate\Database\Eloquent\Model. Get the joining table name for a many-to-many relation.
  • public string joiningTableSegment() - defined in Illuminate\Database\Eloquent\Model. Get this model's half of the intermediate table name for belongsToMany relationships.
  • public array jsonSerialize() - defined in Illuminate\Database\Eloquent\Model. Convert the object into something JSON serializable.
  • public $this jsonable(array $jsonable) - defined in October\Rain\Database\Model. Set the jsonable attributes for the model.
  • public $this load(array|string $relations) - defined in Illuminate\Database\Eloquent\Model. Eager load relations on the model.
  • public $this loadCount(array|string $relations) - defined in Illuminate\Database\Eloquent\Model. Eager load relation counts on the model.
  • public $this loadMissing(array|string $relations) - defined in Illuminate\Database\Eloquent\Model. Eager load relations on the model if they are not already eager loaded.
  • public static Illuminate\Database\Eloquent\Model|static make(array $attributes=array()) - defined in October\Rain\Database\Model. Create a new model and return the instance.
  • public $this makeHidden(array|string $attributes) - defined in Illuminate\Database\Eloquent\Model. Make the given, typically visible, attributes hidden.
  • public string makeRelation(string $name) - defined in October\Rain\Database\Model. Returns a relation class object.
  • public $this makeVisible(array|string $attributes) - defined in Illuminate\Database\Eloquent\Model. Make the given, typically hidden, attributes visible.
  • public boolean methodExists(string $name) - defined in October\Rain\Database\Model. Checks if a method exists, extension equivalent of method_exists().
  • public October\Rain\Database\Relations\MorphMany morphMany($related, $name, $type=NULL, $id=NULL, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a polymorphic one-to-many relationship.
  • public October\Rain\Database\Relations\MorphOne morphOne($related, $name, $type=NULL, $id=NULL, $localKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a polymorphic one-to-one relationship.
  • public October\Rain\Database\Relations\BelongsTo morphTo($name=NULL, $type=NULL, $id=NULL, $ownerKey=NULL) - defined in October\Rain\Database\Model. Define an polymorphic, inverse one-to-one or many relationship.
  • public October\Rain\Database\Relations\MorphToMany morphToMany($related, $name, $table=NULL, $primaryKey=NULL, $foreignKey=NULL, $parentKey=NULL, $relatedKey=NULL, $inverse=false, $relationName=NULL) - defined in October\Rain\Database\Model. Define a polymorphic many-to-many relationship.
  • public October\Rain\Database\Relations\MorphToMany morphedByMany($related, $name, $table=NULL, $primaryKey=NULL, $foreignKey=NULL, $parentKey=NULL, $relatedKey=NULL, $relationName=NULL) - defined in October\Rain\Database\Model. Define a polymorphic many-to-many inverse relationship.
  • public October\Rain\Database\Collection newCollection(array $models=array()) - defined in October\Rain\Database\Model. Create a new Model Collection instance.
  • public October\Rain\Database\Builder|static newEloquentBuilder(October\Rain\Database\QueryBuilder $query) - defined in October\Rain\Database\Model. Create a new Eloquent query builder for the model.
  • public Illuminate\Database\Eloquent\Model|static newFromBuilder(array $attributes=array(), $connection=NULL) - defined in October\Rain\Database\Model. Create a new model instance that is existing.
  • public static newInstance(array $attributes=array(), bool $exists=false) - defined in Illuminate\Database\Eloquent\Model. Create a new instance of the given model.
  • public Illuminate\Database\Eloquent\Builder|static newModelQuery() - defined in Illuminate\Database\Eloquent\Model. Get a new query builder that doesn't have any global scopes or eager loading.
  • public October\Rain\Database\Pivot newPivot(October\Rain\Database\Model $parent, array $attributes, string $table, bool $exists, string|null $using=NULL) - defined in October\Rain\Database\Model. Create a generic pivot model instance.
  • public Illuminate\Database\Eloquent\Builder newQuery() - defined in Illuminate\Database\Eloquent\Model. Get a new query builder for the model's table.
  • public Illuminate\Database\Eloquent\Builder newQueryForRestoration(array|int $ids) - defined in Illuminate\Database\Eloquent\Model. Get a new query to restore one or more models by their queueable IDs.
  • public Illuminate\Database\Eloquent\Builder newQueryWithoutRelationships() - defined in Illuminate\Database\Eloquent\Model. Get a new query builder with no relationships loaded.
  • public Illuminate\Database\Eloquent\Builder newQueryWithoutScope(Illuminate\Database\Eloquent\Scope|string $scope) - defined in Illuminate\Database\Eloquent\Model. Get a new query instance without a given scope.
  • public Illuminate\Database\Eloquent\Builder|static newQueryWithoutScopes() - defined in Illuminate\Database\Eloquent\Model. Get a new query builder that doesn't have any global scopes.
  • public October\Rain\Database\Pivot newRelationPivot(October\Rain\Database\Model $parent, string $relationName, array $attributes, string $table, bool $exists) - defined in October\Rain\Database\Model. Create a pivot model instance specific to a relation.
  • public static void observe(object|array|string $classes) - defined in Illuminate\Database\Eloquent\Model. Register observers with the model.
  • public bool offsetExists(mixed $offset) - defined in October\Rain\Database\Model. This a custom piece of logic specifically to satisfy Twig's.
  • public mixed offsetGet(mixed $offset) - defined in Illuminate\Database\Eloquent\Model. Get the value for a given offset.
  • public void offsetSet(mixed $offset, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set the value for a given offset.
  • public void offsetUnset(mixed $offset) - defined in Illuminate\Database\Eloquent\Model. Unset the value for a given offset.
  • public static Illuminate\Database\Eloquent\Builder on(string|null $connection=NULL) - defined in Illuminate\Database\Eloquent\Model. Begin querying the model on a given connection.
  • public static Illuminate\Database\Query\Builder onWriteConnection() - defined in Illuminate\Database\Eloquent\Model. Begin querying the model on the write connection.
  • public array only(array|mixed $attributes) - defined in Illuminate\Database\Eloquent\Model. Get a subset of the model's attributes.
  • public bool originalIsEquivalent(string $key, mixed $current) - defined in Illuminate\Database\Eloquent\Model. Determine if the new and old values for a given key are equivalent.
  • public boolean propertyExists(string $name) - defined in October\Rain\Database\Model. Checks if a property exists, extension equivalent of property_exists().
  • public bool push(array $options=NULL, null $sessionKey=NULL) - defined in October\Rain\Database\Model. Save the model and all of its relationships.
  • public string qualifyColumn(string $column) - defined in Illuminate\Database\Eloquent\Model. Qualify the given column name by the model's table.
  • public static Illuminate\Database\Eloquent\Builder query() - defined in Illuminate\Database\Eloquent\Model. Begin querying the model.
  • public $this refresh() - defined in Illuminate\Database\Eloquent\Model. Reload the current model instance with fresh attributes from the database.
  • public Illuminate\Database\Eloquent\Builder registerGlobalScopes(Illuminate\Database\Eloquent\Builder $builder) - defined in Illuminate\Database\Eloquent\Model. Register the global scopes for this builder instance.
  • public static void reguard() - defined in Illuminate\Database\Eloquent\Model. Enable the mass assignment restrictions.
  • public bool relationLoaded(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine if the given relation is loaded.
  • public array relationsToArray() - defined in Illuminate\Database\Eloquent\Model. Get the model's relationships in array form.
  • public Illuminate\Database\Eloquent\Model|static reload() - defined in October\Rain\Database\Model. Reloads the model attributes from the database.
  • public void reloadRelations(string $relationName=NULL) - defined in October\Rain\Database\Model. Reloads the model relationship cache.
  • public void removeObservableEvents(array|mixed $observables) - defined in Illuminate\Database\Eloquent\Model. Remove an observable event name.
  • public static replicate(array|null $except=NULL) - defined in Illuminate\Database\Eloquent\Model. Clone the model into a new, non-existing instance.
  • public static void replicating(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a replicating model event with the dispatcher.
  • public static Illuminate\Database\Connection resolveConnection(string|null $connection=NULL) - defined in Illuminate\Database\Eloquent\Model. Resolve a connection instance.
  • public Illuminate\Database\Eloquent\Model|null resolveRouteBinding(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Retrieve the model for a bound value.
  • public static void retrieved(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a retrieved model event with the dispatcher.
  • public bool save(array $options=NULL, null $sessionKey=NULL) - defined in October\Rain\Database\Model. Save the model to the database.
  • public bool saveOrFail(array $options=array()) - defined in Illuminate\Database\Eloquent\Model. Save the model to the database using transaction.
  • public static void saved(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a saved model event with the dispatcher.
  • public static void saving(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a saving model event with the dispatcher.
  • public $this setAppends(array $appends) - defined in Illuminate\Database\Eloquent\Model. Set the accessors to append to model arrays.
  • public void setAttribute(string $key, mixed $value) - defined in October\Rain\Database\Model. Set a given attribute on the model.
  • public $this setConnection(string|null $name) - defined in Illuminate\Database\Eloquent\Model. Set the connection associated with the model.
  • public static void setConnectionResolver(Illuminate\Database\ConnectionResolverInterface $resolver) - defined in Illuminate\Database\Eloquent\Model. Set the connection resolver instance.
  • public $this setCreatedAt(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set the value of the "created at" attribute.
  • public $this setDateFormat(string $format) - defined in Illuminate\Database\Eloquent\Model. Set the date format used by the model.
  • public static void setEventDispatcher(Illuminate\Contracts\Events\Dispatcher $dispatcher) - defined in Illuminate\Database\Eloquent\Model. Set the event dispatcher instance.
  • public $this setHidden(array $hidden) - defined in Illuminate\Database\Eloquent\Model. Set the hidden attributes for the model.
  • public $this setIncrementing(bool $value) - defined in Illuminate\Database\Eloquent\Model. Set whether IDs are incrementing.
  • public $this setKeyName(string $key) - defined in Illuminate\Database\Eloquent\Model. Set the primary key for the model.
  • public $this setKeyType(string $type) - defined in Illuminate\Database\Eloquent\Model. Set the data type for the primary key.
  • public $this setObservableEvents(array $observables) - defined in Illuminate\Database\Eloquent\Model. Set the observable event names.
  • public $this setPerPage(int $perPage) - defined in Illuminate\Database\Eloquent\Model. Set the number of models to return per page.
  • public $this setRawAttributes(array $attributes, bool $sync=false) - defined in Illuminate\Database\Eloquent\Model. Set the array of model attributes. No checking is done.
  • public $this setRelation(string $relation, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set the given relationship on the model.
  • public $this setRelations(array $relations) - defined in Illuminate\Database\Eloquent\Model. Set the entire relations array on the model.
  • public $this setTable(string $table) - defined in Illuminate\Database\Eloquent\Model. Set the table associated with the model.
  • public $this setTouchedRelations(array $touches) - defined in Illuminate\Database\Eloquent\Model. Set the relationships that are touched on save.
  • public $this setUpdatedAt(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set the value of the "updated at" attribute.
  • public $this setVisible(array $visible) - defined in Illuminate\Database\Eloquent\Model. Set the visible attributes for the model.
  • public $this syncChanges() - defined in Illuminate\Database\Eloquent\Model. Sync the changed attributes.
  • public $this syncOriginal() - defined in Illuminate\Database\Eloquent\Model. Sync the original attributes with the current.
  • public $this syncOriginalAttribute(string $attribute) - defined in Illuminate\Database\Eloquent\Model. Sync a single original attribute with its current value.
  • public $this syncOriginalAttributes(array|string $attributes) - defined in Illuminate\Database\Eloquent\Model. Sync multiple original attribute with their current values.
  • public array toArray() - defined in Illuminate\Database\Eloquent\Model. Convert the model instance to an array.
  • public string toJson(int $options=0) - defined in Illuminate\Database\Eloquent\Model. Convert the model instance to JSON.
  • public bool totallyGuarded() - defined in Illuminate\Database\Eloquent\Model. Determine if the model is totally guarded.
  • public bool touch() - defined in Illuminate\Database\Eloquent\Model. Update the model's update timestamp.
  • public void touchOwners() - defined in Illuminate\Database\Eloquent\Model. Touch the owning relations of the model.
  • public bool touches(string $relation) - defined in Illuminate\Database\Eloquent\Model. Determine if the model touches a given relation.
  • public void unbindDeferred($relation, $record, $sessionKey) - defined in October\Rain\Database\Model. Unbind a deferred relationship to the supplied record.
  • public self unbindEvent(string $event=NULL) - defined in October\Rain\Database\Model. Destroys an event binding.
  • public static void unguard(bool $state=true) - defined in Illuminate\Database\Eloquent\Model. Disable all mass assignable restrictions.
  • public static mixed unguarded(callable $callback) - defined in Illuminate\Database\Eloquent\Model. Run the given callable while being unguarded.
  • public static void unsetConnectionResolver() - defined in Illuminate\Database\Eloquent\Model. Unset the connection resolver for models.
  • public static void unsetEventDispatcher() - defined in Illuminate\Database\Eloquent\Model. Unset the event dispatcher for models.
  • public $this unsetRelation(string $relation) - defined in Illuminate\Database\Eloquent\Model. Unset a loaded relationship.
  • public $this unsetRelations() - defined in Illuminate\Database\Eloquent\Model. Unset all the loaded relations for the instance.
  • public bool update(array $attributes=array(), array $options=array()) - defined in Illuminate\Database\Eloquent\Model. Update the model in the database.
  • public static void updated(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register an updated model event with the dispatcher.
  • public static void updating(Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register an updating model event with the dispatcher.
  • public bool usesTimestamps() - defined in Illuminate\Database\Eloquent\Model. Determine if the model uses timestamps.
  • public bool wasChanged(array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine if the model or any of the given attribute(s) have been modified.
  • public static Illuminate\Database\Eloquent\Builder with(array|string $relations) - defined in Illuminate\Database\Eloquent\Model. Begin querying a model with eager loading.
  • public static mixed withoutEvents(callable $callback) - defined in Illuminate\Database\Eloquent\Model. Execute a callback without firing any model events for any model type.
  • public $this withoutRelations() - defined in Illuminate\Database\Eloquent\Model. Duplicate the instance and unset all the loaded relations.
  • public static void withoutTouching(callable $callback) - defined in Illuminate\Database\Eloquent\Model. Disables relationship model touching for the current class during given callback scope.
  • public static void withoutTouchingOn(array $models, callable $callback) - defined in Illuminate\Database\Eloquent\Model. Disables relationship model touching for the given model classes during given callback scope.

Protected methods

protected void getRelationValidationValue($relationName)

getRelationValidationValue handles attachments that validate differently to their simple values

Parameters
  • $relationName

protected array getValidationAttributes()

getValidationAttributes returns the model data used for validation

protected static Illuminate\Validation\Validator makeValidator($data, $rules, $customMessages, $attributeNames, $connection=NULL)

makeValidator instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.

Parameters
  • $data
  • $rules
  • $customMessages
  • $attributeNames
  • $connection

protected array processRuleFieldNames(array $rules)

processRuleFieldNames processes field names in a rule array

Converts any field names using array notation (ie. field[child]) into dot notation (ie. field.child)

Parameters
  • array $rules - Rules array

protected void processValidationRules($rules)

processValidationRules

Parameters
  • $rules

protected string processValidationUniqueRule(string $definition, string $fieldName)

processValidationUniqueRule rebuilds the unique validation rule to force for the existing ID

Parameters
  • string $definition
  • string $fieldName

Show inherited protected methods

Inherited protected methods

  • protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes) - defined in Illuminate\Database\Eloquent\Model. Add the casted attributes to the attributes array.
  • protected array addDateAttributesToArray(array $attributes) - defined in Illuminate\Database\Eloquent\Model. Add the date attributes to the attributes array.
  • protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes) - defined in Illuminate\Database\Eloquent\Model. Add the mutated attributes to the attributes array.
  • protected void afterCreate() - defined in October\Rain\Database\Model. Handle the "created" model event.
  • protected void afterFetch() - defined in October\Rain\Database\Model. Handle the "fetched" model event.
  • protected void afterSave() - defined in October\Rain\Database\Model. Handle the "saved" model event.
  • protected void afterUpdate() - defined in October\Rain\Database\Model. Handle the "updated" model event.
  • protected Illuminate\Support\Carbon asDate(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Return a timestamp as DateTime object with time set to 00:00:00.
  • protected Carbon\Carbon asDateTime(mixed $value) - defined in October\Rain\Database\Model. Return a timestamp as DateTime object.
  • protected string asDecimal(float $value, int $decimals) - defined in Illuminate\Database\Eloquent\Model. Return a decimal as string.
  • protected string asJson(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Encode the given value as JSON.
  • protected int asTimestamp(mixed $value) - defined in Illuminate\Database\Eloquent\Model. Return a timestamp as unix timestamp.
  • protected void beforeCreate() - defined in October\Rain\Database\Model. Handle the "creating" model event.
  • protected void beforeDelete() - defined in October\Rain\Database\Model. Handle the "deleting" model event.
  • protected void beforeFetch() - defined in October\Rain\Database\Model. Handle the "fetching" model event.
  • protected void beforeSave() - defined in October\Rain\Database\Model. Handle the "saving" model event.
  • protected void beforeUpdate() - defined in October\Rain\Database\Model. Handle the "updating" model event.
  • protected static void boot() - defined in Illuminate\Database\Eloquent\Model. The "booting" method of the model.
  • protected void bootIfNotBooted() - defined in Illuminate\Database\Eloquent\Model. Check if the model needs to be booted and if so, do it.
  • protected void bootNicerEvents() - defined in October\Rain\Database\Model. Bind some nicer events to this model, in the format of method overrides.
  • protected static void bootTraits() - defined in Illuminate\Database\Eloquent\Model. Boot all of the bootable traits on the model.
  • protected mixed castAttribute(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Cast an attribute to a native PHP type.
  • protected string castAttributeAsJson(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Cast the given attribute to JSON.
  • protected void commitDeferredAfter($sessionKey) - defined in October\Rain\Database\Model. Internally used method to commit all deferred bindings after saving.
  • protected void commitDeferredBefore($sessionKey) - defined in October\Rain\Database\Model. Internally used method to commit all deferred bindings before saving.
  • protected void commitDeferredOfType($sessionKey, $include=NULL, $exclude=NULL) - defined in October\Rain\Database\Model. Internal method for committing deferred relations.
  • protected int decrement(string $column, float|int $amount=1, array $extra=array()) - defined in Illuminate\Database\Eloquent\Model. Decrement a column's value by a given amount.
  • protected array emitterEventSortEvents(string $eventName) - defined in October\Rain\Database\Model. Sort the listeners for a given event by priority.
  • protected boolean extendableIsAccessible(mixed $class, string $propertyName) - defined in October\Rain\Database\Model. Checks if a property is accessible, property equivalent of is_callable().
  • protected void extensionExtractMethods(string $extensionName, object $extensionObject) - defined in October\Rain\Database\Model. Extracts the available methods from a behavior and adds it to the.
  • protected array fillableFromArray(array $attributes) - defined in Illuminate\Database\Eloquent\Model. Get the fillable attributes of a given array.
  • protected mixed filterModelEventResults(mixed $result) - defined in Illuminate\Database\Eloquent\Model. Filter the model event results.
  • protected void finishSave(array $options) - defined in Illuminate\Database\Eloquent\Model. Perform any actions that are necessary after the model is saved.
  • protected mixed|null fireCustomModelEvent(string $event, string $method) - defined in Illuminate\Database\Eloquent\Model. Fire a custom model event for the given event.
  • protected mixed fireModelEvent(string $event, bool $halt=true) - defined in Illuminate\Database\Eloquent\Model. Fire the given event for the model.
  • protected mixed forwardCallTo(mixed $object, string $method, array $parameters) - defined in Illuminate\Database\Eloquent\Model. Forward a method call to the given object.
  • protected array getArrayAttributeByKey(string $key) - defined in Illuminate\Database\Eloquent\Model. Get an array attribute or return an empty array if it is not set.
  • protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Get an array attribute with the given key and value set.
  • protected array getArrayableAppends() - defined in Illuminate\Database\Eloquent\Model. Get all of the appendable values that are arrayable.
  • protected array getArrayableAttributes() - defined in Illuminate\Database\Eloquent\Model. Get an attribute array of all arrayable attributes.
  • protected array getArrayableItems(array $values) - defined in Illuminate\Database\Eloquent\Model. Get an attribute array of all arrayable values.
  • protected array getArrayableRelations() - defined in Illuminate\Database\Eloquent\Model. Get an attribute array of all arrayable relations.
  • protected mixed getAttributeFromArray(string $key) - defined in Illuminate\Database\Eloquent\Model. Get an attribute from the $attributes array.
  • protected string getCastType(string $key) - defined in Illuminate\Database\Eloquent\Model. Get the type of cast for a model attribute.
  • protected array getDeferrableRelationTypes() - defined in October\Rain\Database\Model. Returns all possible relation types that can be deferred.
  • protected October\Rain\Database\Collection getDeferredBindingRecords($sessionKey) - defined in October\Rain\Database\Model. Returns any outstanding binding records for this model.
  • protected mixed getKeyForSaveQuery() - defined in Illuminate\Database\Eloquent\Model. Get the primary key value for a save query.
  • protected array getMorphs(string $name, string $type, string $id) - defined in Illuminate\Database\Eloquent\Model. Get the polymorphic relationship columns.
  • protected static array getMutatorMethods(mixed $class) - defined in Illuminate\Database\Eloquent\Model. Get all of the attribute mutator methods.
  • protected void getRelationCaller() - defined in October\Rain\Database\Model. Finds the calling function name from the stack trace.
  • protected array getRelationDefaults(string $type) - defined in October\Rain\Database\Model. Returns default relation arguments for a given type.
  • protected mixed getRelationshipFromMethod(string $method) - defined in Illuminate\Database\Eloquent\Model. Get a relationship value from a method.
  • protected string|null guessBelongsToManyRelation() - defined in Illuminate\Database\Eloquent\Model. Get the relationship name of the belongsToMany relationship.
  • protected string guessBelongsToRelation() - defined in Illuminate\Database\Eloquent\Model. Guess the "belongs to" relationship name.
  • protected Illuminate\Database\Eloquent\Relations\Relation handleRelation(string $relationName) - defined in October\Rain\Database\Model. Looks for the relation and does the correct magic as Eloquent would require.
  • protected bool hasChanges(array $changes, array|string|null $attributes=NULL) - defined in Illuminate\Database\Eloquent\Model. Determine if any of the given attributes were changed.
  • protected int increment(string $column, float|int $amount=1, array $extra=array()) - defined in Illuminate\Database\Eloquent\Model. Increment a column's value by a given amount.
  • protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method) - defined in Illuminate\Database\Eloquent\Model. Run the increment or decrement method on the model.
  • protected void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method) - defined in Illuminate\Database\Eloquent\Model. Increment the underlying attribute value and sync with original.
  • protected void initializeTraits() - defined in Illuminate\Database\Eloquent\Model. Initialize any initializable traits on the model.
  • protected void insertAndSetId(Illuminate\Database\Eloquent\Builder $query, array $attributes) - defined in Illuminate\Database\Eloquent\Model. Insert the given attributes and set the ID on the model.
  • protected bool isCustomDateTimeCast(string $cast) - defined in Illuminate\Database\Eloquent\Model. Determine if the cast type is a custom date time cast.
  • protected bool isDateAttribute(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine if the given attribute is a date or date castable.
  • protected bool isDateCastable(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine whether a value is Date / DateTime castable for inbound manipulation.
  • protected bool isDecimalCast(string $cast) - defined in Illuminate\Database\Eloquent\Model. Determine if the cast type is a decimal cast.
  • protected bool isGuardableColumn(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine if the given column is a valid, guardable column.
  • protected bool isJsonCastable(string $key) - defined in Illuminate\Database\Eloquent\Model. Determine whether a value is JSON castable for inbound manipulation.
  • protected bool isStandardDateFormat(string $value) - defined in Illuminate\Database\Eloquent\Model. Determine if the given value is a standard date format.
  • protected Illuminate\Database\Eloquent\Relations\MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey) - defined in October\Rain\Database\Model. Define a polymorphic, inverse one-to-one or many relationship.
  • protected Illuminate\Database\Eloquent\Relations\MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey) - defined in October\Rain\Database\Model. Define a polymorphic, inverse one-to-one or many relationship.
  • protected mixed mutateAttribute(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Get the value of an attribute using its mutator.
  • protected mixed mutateAttributeForArray(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Get the value of an attribute using its mutator for array conversion.
  • protected October\Rain\Database\QueryBuilder newBaseQueryBuilder() - defined in October\Rain\Database\Model. Get a new query builder instance for the connection.
  • protected Illuminate\Database\Eloquent\Relations\BelongsTo newBelongsTo(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $child, string $foreignKey, string $ownerKey, string $relation) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new BelongsTo relationship.
  • protected Illuminate\Database\Eloquent\Relations\BelongsToMany newBelongsToMany(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName=NULL) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new BelongsToMany relationship.
  • protected Illuminate\Database\Eloquent\Relations\HasMany newHasMany(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $foreignKey, string $localKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new HasMany relationship.
  • protected Illuminate\Database\Eloquent\Relations\HasManyThrough newHasManyThrough(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $farParent, Illuminate\Database\Eloquent\Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new HasManyThrough relationship.
  • protected Illuminate\Database\Eloquent\Relations\HasOne newHasOne(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $foreignKey, string $localKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new HasOne relationship.
  • protected Illuminate\Database\Eloquent\Relations\HasOneThrough newHasOneThrough(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $farParent, Illuminate\Database\Eloquent\Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new HasOneThrough relationship.
  • protected Illuminate\Database\Eloquent\Relations\MorphMany newMorphMany(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $type, string $id, string $localKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new MorphMany relationship.
  • protected Illuminate\Database\Eloquent\Relations\MorphOne newMorphOne(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $type, string $id, string $localKey) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new MorphOne relationship.
  • protected Illuminate\Database\Eloquent\Relations\MorphTo newMorphTo(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new MorphTo relationship.
  • protected Illuminate\Database\Eloquent\Relations\MorphToMany newMorphToMany(Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName=NULL, bool $inverse=false) - defined in Illuminate\Database\Eloquent\Model. Instantiate a new MorphToMany relationship.
  • protected mixed newRelatedInstance(string $class) - defined in Illuminate\Database\Eloquent\Model. Create a new model instance for a related model.
  • protected void performDeleteOnModel() - defined in October\Rain\Database\Model. Perform the actual delete query on this model instance.
  • protected void performDeleteOnRelations() - defined in October\Rain\Database\Model. Locates relations with delete flag and cascades the delete event.
  • protected bool performInsert(Illuminate\Database\Eloquent\Builder $query) - defined in Illuminate\Database\Eloquent\Model. Perform a model insert operation.
  • protected bool performUpdate(Illuminate\Database\Eloquent\Builder $query) - defined in Illuminate\Database\Eloquent\Model. Perform a model update operation.
  • protected static void registerModelEvent(string $event, Closure|string $callback) - defined in Illuminate\Database\Eloquent\Model. Register a model event with the dispatcher.
  • protected void registerObserver(object|string $class) - defined in Illuminate\Database\Eloquent\Model. Register a single observer with the model.
  • protected string removeTableFromKey(string $key) - defined in Illuminate\Database\Eloquent\Model. Remove the table name from a given key.
  • protected bool saveInternal(array $options=array()) - defined in October\Rain\Database\Model. Save the model to the database. Is used by {@link save()} and {@link forceSave()}.
  • protected string serializeDate(DateTimeInterface $date) - defined in Illuminate\Database\Eloquent\Model. Prepare a date for array / JSON serialization.
  • protected Illuminate\Database\Eloquent\Builder setKeysForSaveQuery(Illuminate\Database\Eloquent\Builder $query) - defined in Illuminate\Database\Eloquent\Model. Set the keys for a save update query.
  • protected mixed setMutatedAttributeValue(string $key, mixed $value) - defined in Illuminate\Database\Eloquent\Model. Set the value of an attribute using its mutator.
  • protected void setRelationValue($relationName, $value) - defined in October\Rain\Database\Model. Sets a relation value directly from its attribute.
  • protected static void throwBadMethodCallException(string $method) - defined in Illuminate\Database\Eloquent\Model. Throw a bad method call exception for the given method.
  • protected void updateTimestamps() - defined in Illuminate\Database\Eloquent\Model. Update the creation and update timestamps.
  • protected void validateRelationArgs($relationName, $optional, $required=array()) - defined in October\Rain\Database\Model. Validate relation supplied arguments.