Overview

Namespaces

  • rsanchez
    • Deep
      • App
        • EE
        • Laravel
          • Facade
      • Collection
      • Hydrator
      • Model
      • Plugin
      • Relations
      • Repository

Classes

  • AbstractEntity
  • AbstractField
  • AbstractProperty
  • Asset
  • Category
  • CategoryField
  • CategoryPosts
  • Channel
  • Comment
  • Entry
  • Field
  • Fieldtype
  • File
  • GridCol
  • GridRow
  • JoinableScope
  • MatrixCol
  • MatrixRow
  • Member
  • MemberField
  • PlayaEntry
  • RelationshipEntry
  • Site
  • Title
  • UploadPref

Interfaces

  • FileInterface

Traits

  • GlobalAttributeVisibilityTrait
  • JoinableTrait
  • Overview
  • Namespace
  • Class
  • Tree

Class File

Model for the files table

Illuminate\Database\Eloquent\Model
Extended by rsanchez\Deep\Model\File implements rsanchez\Deep\Model\FileInterface
Namespace: rsanchez\Deep\Model
Located at Model/File.php
Methods summary
public
# setUploadPref( rsanchez\Deep\Model\UploadPref $uploadPref )

Set the UploadPref

Set the UploadPref

Var

\rsanchez\Deep\Model\UploadPref $uploadPref
public string
# getUrlAttribute( )

Get the public url to this file

Get the public url to this file

Returns

string

Implementation of

rsanchez\Deep\Model\FileInterface::getUrlAttribute()
public string
# getServerPathAttribute( )

Get the server path to this file

Get the server path to this file

Returns

string

Implementation of

rsanchez\Deep\Model\FileInterface::getServerPathAttribute()
public Carbon\Carbon
# getUploadDateAttribute( integer $value )

Get the upload_date column as a Carbon object

Get the upload_date column as a Carbon object

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon
public Carbon\Carbon
# getModifiedDateAttribute( integer $value )

Get the modified_date column as a Carbon object

Get the modified_date column as a Carbon object

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon
public string
# __toString( )

Get the public url to this file

Get the public url to this file

Returns

string

Implementation of

rsanchez\Deep\Model\FileInterface::__toString()
public rsanchez\Deep\Collection\FileCollection
# newCollection( array $models = array() )

Parameters

$models
array
$models

Returns

rsanchez\Deep\Collection\FileCollection
public Illuminate\Database\Eloquent\Builder
# scopeFromEntryCollection( Illuminate\Database\Eloquent\Builder $query, rsanchez\Deep\Collection\EntryCollection $collection )

Filter by files belonging to an EntryCollection

Filter by files belonging to an EntryCollection

EE doesn't actually have a DB of entries => files, so you have to look up from the exp_files table based on filename and upload dir

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$collection
rsanchez\Deep\Collection\EntryCollection
$collection

Returns

Illuminate\Database\Eloquent\Builder
public
# attributesToArray( )
Properties summary
protected string $table 'files'
#
protected string $primaryKey 'file_id'
#
protected array $hidden array('site_id', 'upload_location_id', 'rel_path', 'uploaded_by_member_id', 'modified_by_member_id', 'uploadPref')
#
protected array $appends array('url')
#
protected rsanchez\Deep\Model\UploadPref $uploadPref
#

UploadPref model

UploadPref model

API documentation generated by ApiGen 2.8.0