Yükleme Kütüphanesi

Dosya yükleme işlevini yerine getiren sınıftır. Ayrıca çoklu dosya yüklemenize olanak sağlarken dosya işlemleri hakkında veya süreçte oluşan hatalar hakkında da bilgi alabilmenizi sağlar.

# Kurulum

ZN dağıtımları için kurulum gerekmez.

↓ composer require znframework/package-filesystem

# Uygulamalar

# Jquery & Ajax & SweetAlert ile Çoklu Dosya Yükleme
# DropzoneJS ile Dosya Yükleme 

# INI Yapılandırması

Dosya yüklemesi ile ilgili ini ayarlarını yapmak için aşağıdaki yolda yer alan upload ayarları kullanılır.

# Yöntemler

# Extensions

Hangi uzantılı dosyaların yüklenebilir olduğunu belirtmek için kullanılır.

Parametreler

Kullanımı

Upload::extensions('jpg', 'png', 'gif', 'txt')->start('file');

# Mimes

Dosya uzantıları o dosyanın gerçek kimliği hakkında bilgi vermez. Bu nedenle hangi tür dosyaların yükleneceğini sınırlamanız gerekir. Bu yöntem ile hangi mime türlerinin yüklenebilir olacağına karar verebilirsiniz.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')->start('file');

# ConvertName

Dosya isimlerinde yer alan yabancı veya özel karakterler slug tipine dönüştürülür.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->convertName()
      ->start('file');

[string $convert]

Kendi belirleyeceğiniz isimlendirmeleri de kullanabilirsiniz.

Upload::mimes('image/jpeg', 'image/png')
      ->convertName('my-file')
      ->start('file');

# Encode

Yüklenen dosyaya şifreli bir ön ek ekler.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->encode('sha1')
      ->start('file');

# EncodeLength 

Şifrelenen ön ekin uzunluğunu ayarlamak için kullanılır.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->encode('sha1')
      ->encodeLength(10)
      ->start('file');

# Prefix

Yüklenen dosyaya kendi belirleyeceğiniz ön ek eklemek için kullanılır. Bu yöntemin encode() ile beraber kullanılması durumunda encode() işleme alınmaz.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->encode(false)
      ->prefix(time())
      ->start('file');

# Maxsize 

Yüklenen dosyanın boyutunun byte cinsinden en fazla kaç olacağını belirtmek için kullanılır. Bu parametreye string veride atayabilirsiniz. Doğrudan bayt miktarı göndermek yerine 20MB, 5KB gibi string verilerde kullanabileceksiniz.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->maxsize(1024 * 1024 * 20) // 20 MB
      ->start('file');

[string $maxsize]

Upload::mimes('image/jpeg', 'image/png')
      ->maxsize('20MB')
      ->start('file');

# Source

start() yönteminin 1. parametresi ile aynı görevi görür. Input file form nesnesinin name değerini temsil eder. Yani dosyanın hangi kaynaktan yüklendiğidir.

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->maxsize(1024 * 1024 * 20) // 20 MB
      ->source('file')
      ->start();

# Target

start() yönteminin 2. parametresi ile aynı görevi görür. Dosyanın nereye yükleneceğidir. Dosyaların Ön tanımlı olarak yükleneceği dizin her projenin kendi Resources/Uploads/ dizinidir

Parametreler

Kullanımı

Upload::mimes('image/jpeg', 'image/png')
      ->maxsize(1024 * 1024 * 20) // 20 MB
      ->source('file')
      ->target(FILES_DIR . 'my_uploads/')
      ->start();

Ya da;

Upload::mimes('image/jpeg', 'image/png')
      ->maxsize(1024 * 1024 * 20) // 20 MB
      ->start('file', FILES_DIR . 'my_uploads/');

gibi kullanabilirsiniz.

# Settings

Yukarıda opsiyonel yöntemlerin yaptığı ayarları dizi olarak yapabilmek için kullanılır.

Parametreler

Kullanımlar

Upload::settings
([
    'encode'     => false,
    'prefix'     => '__prefix__',
    'extensions' => 'jpg|png|gif',
    'maxsize'    => 8096
]);

Yukarıdaki her bir ayar için opsiyonel yöntemde kullanılabilir.

# Start

Dosya yükleme işlemini başlatır.

Parametreler

Kullanımlar

Upload::settings
([
    'encode'     => false,
    'prefix'     => '__prefix__',
    'extensions' => 'jpg|png|gif',
    'maxsize'    => 8096
])->start('upload');

Opsiyonel Yöntemler ile Yapılandırma

Yukarıdaki işlemi opsiyonel seçeneklerle yapmak isterseniz;

Upload::encode(false)
      ->prefix('__prefix__')
      ->extensions('jpg', 'png', 'gif')
      ->maxsize(8*96)
      ->target('DirrentUploadDir')
      ->start('upload');

Yukarıda start('upload') yönteminde kullanılan upload yükleme işlemine konu olan <form input="file" name="upload"> nesnesinin name değeridir.

# IsFile 

Html [input="file"] nesnesinin değer alıp almadığını kontrol etmek için kullanılır. $_FILES['file']['name'] kullanımı gibidir.

Parametreler

Kullanımı

if( Upload::isFile('upload') )
{
    Upload::start('upload');
}

# Info

Dosya işlemleri sırasında dosya hakkında bilgi almak için kullanılır. Verileri object veri tipinde döndürür. Tek bir bilgi kullanılacaksa parametre olarak bilgi ismi yazılabilir.

Parametreler

Kullanımlar

<?php
echo Form::enctype('multipart')->open('form');
echo Form::file('uploadFile');
echo Form::submit('uploadButton');
echo Form::close();

Upload::settings
([
    'encode'     => false,
    'prefix'     => '__prefix__',
    'extensions' => 'jpg|png|gif',
    'maxsize'    => 8096
])->start('uploadFile');

output( Upload::info() );

$info = Upload::info();

echo $info->encodeName;

Çoklu dosya yükleme durumunda Upload::info() içerisinde yer alan tüm anahtarların değeri her bir yüklenen dosya için dizi türünden bilgi saklar.

$info = Upload::info();

echo $info->encodeName[0];

Yüklenen dosya bilgilerinin veritabanına kaydedilmesi gerektiği zamanlarda döngü kullanarak kayıt işlemi yaptırabilirsiniz.

$info = Upload::info();

foreach( $info->encodeName as $encodeName )
{
    DB::insert('images', ['path' => $encodeName]);
}

# Error

Yükleme işleminden sonra herhangi bir hatanın oluşup oluşmadığı hakkında bilgi verir.

Parametreler

Kullanımlar

output( Upload::error() );

# Clean [7.5.0][2022-09-09]

Yüklenen dosyaları geri silmek için kullanılır. Özellikle çoklu yüklemede belirtilen kurallara uymayan dosyaların yüklenememesinden sonra aynı yüklemede yüklenen dosyaların silinmesi için kullanılabilir.

Kullanımlar

if( Upload::error() )
{
    Upload::clean()
}

# Progress [6.12.0][2021-05-30]

Bu yöntem arka planda javascript kullanarak yüklenen dosyaların toplam boyutu, yüklenen miktar ve yüzde bilgilerinin alınmasını sağlar. Jquery kullanıldığı için bu eklentinin dahil edilmiş olması gerekir.

Parametreler

callable $callback(percent, loaded, total)

Kullanımı

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.js"></script>

@Form::enctype('multipart')->open()
    @Form::file('upload')
    @Form::submit('button', 'Submit')
@Form::close()

@Upload::progress('input[name=button]', 'input[name=upload]', 
{<
    $('input[name=button]').val('%' + percent);
>})

# Jquery & Ajax & SweetAlert ile Çoklu Dosya Yükleme

Jquery ile ajax kullanarak dosya yüklemek için aşağıdaki adımları takip edin.

Sisteminizde javascript etiketleriniz nerede yer alıyorsa aşağıdaki komutu oraya ekleyin. Bu yer genellikle [head] [/head] etiketlerinin arasıdır.

@style('sweetAlert')
@script('jquery', 'sweetAlert')

Dosya yüklemesi için form elementinin enctype değerini düzenlemeyi unutmayın.

@Form::id('uploadForm')->enctype('multipart')->open()
@Form::id('file')->file('upload', true)
@Form::onclick('ajaxDoUpload()')->button('uploadButton', 'Do Upload')
@Form::close()

Form değerlerini ilgili kontrolcüye gönderebilmek için ajax kodlarımızı oluşturuyoruz.

<script>
function ajaxDoUpload()
{
    var formData = new FormData($('#uploadForm')[0]); // Attach Form Object
 
    $.ajax
    ({
        url        : '{{ URL::site("Home/upload") }}',
        type       : 'post',
        dataType   : 'json',
        data       : formData,
        processData: false, // REQUIRED !!
        contentType: false, // REQUIRED !!
        success    : function(data)
        {
            if( data.success !== undefined )
            {
                swal("Your Successful Title", data.success, "success");
            }
            else
            {
                swal("Your Error Title", data.error, "error");
            }
        }
    });
}
</script>

Aşağıdaki kullanım, amaçlarınıza göre genişletilebilir.

public function upload() : void
{
    Upload::start('upload');

    if( $error = Upload::error() )
    {
        $data['error'] = $error;
    }
    else
    {
        $data['success'] = 'Your success messsage.';
    }

    echo json_encode($data);
}

# DropzoneJS ile Dosya Yükleme 

DropzoneJS ile ilgili detaylı kullanım için tıklayınız. Dropzone ile dosya yüklemek için aşağıdaki adımları takip edin.

Import kütüphanesini ile DropzoneJS'nin uzaktan linkini dahil edebilirsiniz. Sisteminizde javascript etiketleriniz nerede yer alıyorsa aşağıdaki komutu oraya ekleyin. Bu yer genellikle [head] [/head] etiketlerinin arasıdır.

@style('dropzone')
@script('dropzone')

Dosya yüklemesi için form elementinin enctype değerini düzenlemeyi unutmayın.

@Form::action('Home/upload')->enctype('multipart')->class('dropzone')->open('form'):
<div class="fallback" id="fallback">
@Form::file('file', true):
</div>
@Form::close():

Dropzone nesnesinin 2. parametresi extra ayarları içerir. Bu parametrenin kullanımı için DropzoneJS kullanım kılavuzuna göz atın.

<script>
var dropzone = new Dropzone("#fallback");
</script>

Aşağıdaki kullanım, amaçlarınıza göre genişletilebilir.

public function upload() : void
{
    Upload::mimes('image/jpeg', 'image/png')
          ->prefix(time())
          ->start('file');
}