php zip

PhpZip هي مكتبة php للعمل الممتد مع أرشيفات ZIP.

التوثيق الروسي

الإصدارات والتبعيات

إصدار	PHP	التوثيق
^4.0 (رئيسي)	^7.4|^8.0	حاضِر
^3.0	^5.5|^7.0	المستندات v3.3

جدول المحتويات

• سمات
• متطلبات
• تثبيت
• أمثلة
• مسرد
• التوثيق
  • نظرة عامة على أساليب الفئة PhpZipZipFile
  • إنشاء/فتح أرشيف ZIP
  • قراءة الإدخالات من الأرشيف
  • إدخالات متكررة
  • الحصول على معلومات حول الإدخالات
  • إضافة إدخالات إلى الأرشيف
  • حذف الإدخالات من الأرشيف
  • العمل مع الإدخالات والأرشيف
  • العمل مع كلمات المرور
  • التراجع عن التغييرات
  • حفظ ملف أو إخراج إلى المتصفح
  • إغلاق الأرشيف
• تشغيل الاختبارات
• سجل التغيير
• يرقي
  • ترقية الإصدار 3 إلى الإصدار 4
  • ترقية الإصدار 2 إلى الإصدار 3

سمات

• فتح وفك ضغط الملفات المضغوطة.
• إنشاء أرشيفات ZIP.
• تعديل أرشيفات ZIP.
• PHP خالص (لا يتطلب الامتداد php-zip وclass ZipArchive ).
• وهو يدعم حفظ الأرشيف في ملف، أو إخراج الأرشيف إلى المتصفح، أو إخراجه كسلسلة دون حفظه في ملف.
• يتم دعم التعليقات الأرشيفية وتعليقات الإدخال الفردي.
• الحصول على معلومات حول كل إدخال في الأرشيف.
• يتم دعم طرق الضغط التالية فقط:
  • غير مضغوطة (مخزنة).
  • تفريغ الضغط.
  • ضغط BZIP2 بالامتداد php-bz2 .
• دعم ZIP64 (حجم الملف أكثر من 4 جيجابايت أو عدد الإدخالات في الأرشيف أكثر من 65535).
• العمل مع كلمات المرور

  انتباه!

  بالنسبة للأنظمة 32 بت، طريقة التشفير Traditional PKWARE Encryption (ZipCrypto) غير مدعومة حاليًا. استخدم طريقة التشفير WinZIP AES Encryption كلما أمكن ذلك.

  • قم بتعيين كلمة المرور لقراءة الأرشيف لجميع الإدخالات أو لبعضها فقط.
  • قم بتغيير كلمة المرور للأرشيف، بما في ذلك الإدخالات الفردية.
  • حذف كلمة مرور الأرشيف لجميع الإدخالات أو الفردية.
  • قم بتعيين كلمة المرور و/أو طريقة التشفير، سواء للجميع أو للإدخالات الفردية في الأرشيف.
  • قم بتعيين كلمات مرور وطرق تشفير مختلفة لإدخالات مختلفة.
  • حذف كلمة المرور لجميع أو بعض الإدخالات.
  • دعم Traditional PKWARE Encryption (ZipCrypto) وطرق تشفير WinZIP AES Encryption .
  • ضبط طريقة التشفير لجميع الإدخالات أو الفردية في الأرشيف.

متطلبات

• PHP >= 7.4 أو PHP >= 8.0 (يفضل 64 بت).
• ملحق PHP اختياري bzip2 لضغط BZIP2.
• ملحق PHP اختياري openssl لدعم WinZip Aes Encryption .

تثبيت

composer require nelexa/zip

أحدث نسخة مستقرة:

أمثلة

 // create new archive
$ zipFile = new  PhpZip  ZipFile ();
try {
    $ zipFile
        -> addFromString ( ' zip/entry/filename ' , ' Is file content ' ) // add an entry from the string
        -> addFile ( ' /path/to/file ' , ' data/tofile ' ) // add an entry from the file
        -> addDir ( __DIR__ , ' to/path/ ' ) // add files from the directory
        -> saveAsFile ( $ outputFilename ) // save the archive to a file
        -> close (); // close archive
            
    // open archive, extract, add files, set password and output to browser.
    $ zipFile
        -> openFile ( $ outputFilename ) // open archive from file
        -> extractTo ( $ outputDirExtract ) // extract files to the specified directory
        -> deleteFromRegex ( ' ~^.~ ' ) // delete all hidden (Unix) files
        -> addFromString ( ' dir/file.txt ' , ' Test file ' ) // add a new entry from the string
        -> setPassword ( ' password ' ) // set password for all entries
        -> outputAsAttachment ( ' library.jar ' ); // output to the browser without saving to a file
}
catch (  PhpZip  Exception  ZipException $ e ){
    // handle exception
}
finally {
    $ zipFile -> close ();
}

يمكن العثور على أمثلة أخرى في المجلد tests/

مسرد

Zip Entry - ملف أو مجلد في أرشيف ZIP. كل إدخال في الأرشيف له خصائص معينة، على سبيل المثال: اسم الملف، طريقة الضغط، طريقة التشفير، حجم الملف قبل الضغط، حجم الملف بعد الضغط، CRC32 وغيرها.

التوثيق:

نظرة عامة على أساليب الفئة PhpZipZipFile

• ZipFile::__construct - تهيئة أرشيف ZIP.
• ZipFile::addAll - يضيف كافة الإدخالات من صفيف.
• ZipFile::addDir - يضيف الملفات إلى الأرشيف من الدليل على المسار المحدد بدون أدلة فرعية.
• ZipFile::addDirRecursive - يضيف الملفات إلى الأرشيف من الدليل على المسار المحدد مع الدلائل الفرعية.
• ZipFile::addEmptyDir - إضافة دليل جديد.
• ZipFile::addFile - يضيف ملفًا إلى أرشيف ZIP من المسار المحدد.
• ZipFile::addSplFile - يضيف SplFileInfo إلى أرشيف ZIP.
• ZipFile::addFromFinder - يضيف الملفات من SymfonyComponentFinderFinder إلى أرشيف ZIP.
• ZipFile::addFilesFromIterator - يضيف ملفات من مكرر الدلائل.
• ZipFile::addFilesFromGlob - يضيف ملفات من دليل بنمط الكرة الأرضية بدون أدلة فرعية.
• ZipFile::addFilesFromGlobRecursive - يضيف ملفات من دليل عن طريق نمط الكرة الأرضية مع الدلائل الفرعية.
• ZipFile::addFilesFromRegex - يضيف ملفات من دليل بنمط PCRE بدون أدلة فرعية.
• ZipFile::addFilesFromRegexRecursive - يضيف ملفات من دليل بواسطة نمط PCRE مع الدلائل الفرعية.
• ZipFile::addFromStream - يضيف إدخالاً من الدفق إلى أرشيف ZIP.
• ZipFile::addFromString - يضيف ملفًا إلى أرشيف ZIP باستخدام محتوياته.
• ZipFile::إغلاق - إغلاق الأرشيف.
• ZipFile::count - يُرجع عدد الإدخالات في الأرشيف.
• ZipFile::deleteFromName - يحذف إدخالاً في الأرشيف باستخدام اسمه.
• ZipFile::deleteFromGlob - يحذف الإدخالات في الأرشيف باستخدام نمط الكرة الأرضية.
• ZipFile::deleteFromRegex - يحذف الإدخالات في الأرشيف باستخدام نمط PCRE.
• ZipFile::deleteAll - يحذف جميع الإدخالات في أرشيف ZIP.
• ZipFile::disableEncryption - تعطيل التشفير لجميع الإدخالات الموجودة بالفعل في الأرشيف.
• ZipFile::disableEncryptionEntry - تعطيل تشفير الإدخال المحدد باسمه.
• ZipFile::extractTo - استخراج محتويات الأرشيف.
• ZipFile::getArchiveComment - يقوم بإرجاع تعليق أرشيف Zip.
• ZipFile::getEntryComment - يقوم بإرجاع تعليق الإدخال باستخدام اسم الإدخال.
• ZipFile::getEntryContent - يقوم بإرجاع محتويات الإدخال باستخدام اسمه.
• ZipFile::getListFiles - يقوم بإرجاع قائمة ملفات الأرشيف.
• ZipFile::hasEntry - يتحقق من وجود إدخال في الأرشيف.
• ZipFile::isDirectory - يتحقق من أن الإدخال في الأرشيف هو دليل.
• ZipFile::matcher - تحديد الإدخالات في الأرشيف لإجراء العمليات عليها.
• ZipFile::openFile - يفتح أرشيف مضغوط من ملف.
• ZipFile::openFromString - يفتح أرشيف مضغوط من سلسلة.
• ZipFile::openFromStream - يفتح أرشيف مضغوط من الدفق.
• ZipFile::outputAsAttachment - يقوم بإخراج أرشيف ZIP إلى المتصفح.
• ZipFile::outputAsPsr7Response - لإخراج أرشيف ZIP كاستجابة PSR-7.
• ZipFile::outputAsSymfonyResponse - يقوم بإخراج أرشيف ZIP كاستجابة Symfony.
• ZipFile::outputAsString - يُخرج أرشيف ZIP كسلسلة.
• ZipFile::rename - يعيد تسمية الإدخال المحدد باسمه.
• ZipFile::rewrite - احفظ التغييرات وأعد فتح الأرشيف الذي تم تغييره.
• ZipFile::saveAsFile - يحفظ الأرشيف في ملف.
• ZipFile::saveAsStream - يكتب الأرشيف إلى الدفق.
• ZipFile::setArchiveComment - قم بتعيين تعليق أرشيف ZIP.
• ZipFile::setCompressionLevel - اضبط مستوى الضغط لجميع الملفات الموجودة في الأرشيف.
• ZipFile::setCompressionLevelEntry - يضبط مستوى الضغط للإدخال حسب اسمه.
• ZipFile::setCompressionMethodEntry - يضبط طريقة الضغط للإدخال حسب اسمه.
• ZipFile::setEntryComment - قم بتعيين تعليق الإدخال المحدد حسب اسمه.
• ZipFile::setReadPassword - قم بتعيين كلمة المرور للأرشيف المفتوح.
• ZipFile::setReadPasswordEntry - يقوم بتعيين كلمة مرور لقراءة الإدخال المحدد باسمه.
• ZipFile::setPassword - يقوم بتعيين كلمة مرور جديدة لجميع الملفات الموجودة في الأرشيف.
• ZipFile::setPasswordEntry - يقوم بتعيين كلمة مرور جديدة للإدخال المحدد باسمه.
• ZipFile::unchangeAll - التراجع عن كافة التغييرات التي تم إجراؤها في الأرشيف.
• ZipFile::unchangeArchiveComment - التراجع عن التغييرات التي تم إجراؤها على تعليق الأرشيف.
• ZipFile::unchangeEntry - التراجع عن تغييرات الإدخال المحدد باسمه.

إنشاء/فتح أرشيف ZIP

ملف مضغوط ::__ البناء **

تهيئة أرشيف ZIP

 $ zipFile = new  PhpZip  ZipFile ();

ملف مضغوط::openFile

يفتح أرشيف مضغوط من ملف.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFile ( ' file.zip ' );

ملف مضغوط::openFromString

يفتح أرشيف مضغوط من سلسلة.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromString ( $ stringContents );

ملف مضغوط::openFromStream

يفتح أرشيف مضغوط من الدفق.

 $ stream = fopen ( ' file.zip ' , ' rb ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> openFromStream ( $ stream );

قراءة الإدخالات من الأرشيف

ملف مضغوط::count

إرجاع عدد الإدخالات في الأرشيف.

 $ zipFile = new  PhpZip  ZipFile ();

$ count = count ( $ zipFile );
// or
$ count = $ zipFile -> count ();

ملف مضغوط::getListFiles

إرجاع قائمة ملفات الأرشيف.

 $ zipFile = new  PhpZip  ZipFile ();
$ listFiles = $ zipFile -> getListFiles ();

// example array contents:
// array (
//   0 => 'info.txt',
//   1 => 'path/to/file.jpg',
//   2 => 'another path/',
//   3 => '0',
// ) 

ملف مضغوط::getEntryContent

إرجاع محتويات الإدخال باستخدام اسمه.

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ contents = $ zipFile [ $ entryName ];
// or
$ contents = $ zipFile -> getEntryContents ( $ entryName );

ملف مضغوط :: hasEntry

يتحقق مما إذا كان هناك إدخال في الأرشيف.

 // $entryName = 'path/to/example-entry-name.txt';
$ zipFile = new  PhpZip  ZipFile ();

$ hasEntry = isset ( $ zipFile [ $ entryName ]);
// or
$ hasEntry = $ zipFile -> hasEntry ( $ entryName );

ملف مضغوط::isDirectory

التحقق من أن الإدخال في الأرشيف هو دليل.

 // $entryName = 'path/to/';
$ zipFile = new  PhpZip  ZipFile ();

$ isDirectory = $ zipFile -> isDirectory ( $ entryName );

ملف مضغوط::extractTo

استخراج محتويات الأرشيف. يجب أن يكون الدليل موجودا.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ directory );

استخراج بعض الملفات إلى الدليل. يجب أن يكون الدليل موجودا.

 // $toDirectory = '/tmp';
$ extractOnlyFiles = [
    ' filename1 ' , 
    ' filename2 ' , 
    ' dir/dir/dir/ '
];
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> extractTo ( $ toDirectory , $ extractOnlyFiles );

إدخالات متكررة

ZipFile هو مكرر. يمكن تكرار كافة الإدخالات في حلقة foreach .

 foreach ( $ zipFile as $ entryName => $ contents ){
    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;
}

يمكن التكرار من خلال Iterator .

 $ iterator = new  ArrayIterator ( $ zipFile );
while ( $ iterator -> valid ())
{
    $ entryName = $ iterator -> key ();
    $ contents = $ iterator -> current ();

    echo " Filename: $ entryName " . PHP_EOL ;
    echo " Contents: $ contents " . PHP_EOL ;
    echo ' ----------------------------- ' . PHP_EOL ;

    $ iterator -> next ();
}

الحصول على معلومات حول الإدخالات

ملف مضغوط::getArchiveComment

إرجاع تعليق أرشيف Zip.

 $ zipFile = new  PhpZip  ZipFile ();
$ commentArchive = $ zipFile -> getArchiveComment ();

ملف مضغوط::getEntryComment

إرجاع تعليق الإدخال باستخدام اسم الإدخال.

 $ zipFile = new  PhpZip  ZipFile ();
$ commentEntry = $ zipFile -> getEntryComment ( $ entryName );

إضافة إدخالات إلى الأرشيف

تتيح لك جميع طرق إضافة الإدخالات إلى أرشيف ZIP تحديد طريقة لضغط المحتوى.

تتوفر طرق الضغط التالية:

• PhpZipConstantsZipCompressionMethod::STORED - بدون ضغط
• PhpZipConstantsZipCompressionMethod::DEFLATED - ضغط التفريغ
• PhpZipConstantsZipCompressionMethod::BZIP2 - ضغط Bzip2 بالامتداد ext-bz2

ملف مضغوط::addFile

يضيف ملفًا إلى أرشيف ZIP من المسار المحدد.

 $ zipFile = new  PhpZip  ZipFile ();
// $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile -> addFile ( $ file );

// you can specify the name of the entry in the archive (if null, then the last component from the file name is used)
$ zipFile -> addFile ( $ file , $ entryName );

// you can specify a compression method
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFile ( $ file , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addSplFile

يضيف SplFileInfo إلى أرشيف ZIP.

 // $file = '...../file.ext'; 
// $entryName = 'file2.ext'
$ zipFile = new  PhpZip  ZipFile ();

$ splFile = new  SplFileInfo ( ' README.md ' );

$ zipFile -> addSplFile ( $ splFile );
$ zipFile -> addSplFile ( $ splFile , $ entryName );
// or
$ zipFile [ $ entryName ] = new  SplFileInfo ( $ file );

// set compression method
$ zipFile -> addSplFile ( $ splFile , $ entryName , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
]);

ملف مضغوط::addFromFinder

إضافة ملفات من SymfonyComponentFinderFinder إلى أرشيف ZIP.

 $ finder = new  Symfony  Component  Finder  Finder ();
$ finder
    -> files ()
    -> name ( ' *.{jpg,jpeg,gif,png} ' )
    -> name ( ' /^[0-9a-f]./ ' )
    -> contains ( ' /lorems+ipsum$/i ' )
    -> in ( ' path ' );

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFromFinder ( $ finder , $ options = [
     PhpZip  Constants ZipOptions:: COMPRESSION_METHOD =>  PhpZip  Constants ZipCompressionMethod:: DEFLATED ,
     PhpZip  Constants ZipOptions:: MODIFIED_TIME => new  DateTimeImmutable ( ' -1 day 5 min ' )
]);

ملف مضغوط::addFromString

إضافة ملف إلى أرشيف ZIP باستخدام محتوياته.

 $ zipFile = new  PhpZip  ZipFile ();

$ zipFile [ $ entryName ] = $ contents ;
// or
$ zipFile -> addFromString ( $ entryName , $ contents );

// you can specify a compression method
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromString ( $ entryName , $ contents ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addFromStream

إضافة إدخال من الدفق إلى أرشيف ZIP.

 $ zipFile = new  PhpZip  ZipFile ();
// $stream = fopen(..., 'rb');

$ zipFile -> addFromStream ( $ stream , $ entryName );
// or
$ zipFile [ $ entryName ] = $ stream ;

// you can specify a compression method
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFromStream ( $ stream , $ entryName ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addEmptyDir

إضافة دليل جديد.

 $ zipFile = new  PhpZip  ZipFile ();
// $path = "path/to/";
$ zipFile -> addEmptyDir ( $ path );
// or
$ zipFile [ $ path ] = null ;

ملف مضغوط::addAll

يضيف كافة الإدخالات من صفيف.

 $ entries = [
    ' file.txt ' => ' file contents ' , // add an entry from the string contents
    ' empty dir/ ' => null , // add empty directory
    ' path/to/file.jpg ' => fopen ( ' ..../filename ' , ' rb ' ), // add an entry from the stream
    ' path/to/file.dat ' => new  SplFileInfo ( ' ..../filename ' ), // add an entry from the file
];

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addAll ( $ entries );

ملف مضغوط::addDir

يضيف الملفات إلى الأرشيف من الدليل على المسار المحدد بدون أدلة فرعية.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDir ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDir ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDir ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addDirRecursive

يضيف الملفات إلى الأرشيف من الدليل على المسار المحدد باستخدام الدلائل الفرعية.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addDirRecursive ( $ dirName );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addDirRecursive ( $ dirName , $ localPath );

// you can specify a compression method
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addDirRecursive ( $ dirName , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ZipFile::addFilesFromIterator

يضيف الملفات من مكرر الدلائل.

 // $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromIterator ( $ directoryIterator );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath );
// or
$ zipFile [ $ localPath ] = $ directoryIterator ;

// you can specify a compression method
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromIterator ( $ directoryIterator , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression

مثال مع تجاهل بعض الملفات:

 $ ignoreFiles = [
    ' file_ignore.txt ' , 
    ' dir_ignore/sub dir ignore/ '
];

// $directoryIterator = new DirectoryIterator($dir); // without subdirectories
// $directoryIterator = new RecursiveDirectoryIterator($dir); // with subdirectories
// use PhpZipUtilIteratorIgnoreFilesFilterIterator for non-recursive search
 
$ zipFile = new  PhpZip  ZipFile ();
$ ignoreIterator = new  PhpZip  Util  Iterator  IgnoreFilesRecursiveFilterIterator (
    $ directoryIterator , 
    $ ignoreFiles
);

$ zipFile -> addFilesFromIterator ( $ ignoreIterator );

ملف مضغوط::addFilesFromGlob

يضيف ملفات من دليل بنمط الكرة الأرضية بدون أدلة فرعية.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlob ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addFilesFromGlobRecursive

يضيف ملفات من دليل عن طريق نمط الكرة الأرضية مع الدلائل الفرعية.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromGlobRecursive ( $ dir , $ globPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ملف مضغوط::addFilesFromRegex

يضيف ملفات من دليل بنمط PCRE بدون أدلة فرعية.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegex ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

ZipFile::addFilesFromRegexRecursive

يضيف ملفات من دليل بواسطة نمط PCRE مع الدلائل الفرعية.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> add all .jpg, .jpeg, .png and .gif files

$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern );

// you can specify the path in the archive to which you want to put entries
$ localPath = ' to/path/ ' ;
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath );

// you can specify a compression method
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: STORED ); // No compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED ); // Deflate compression
$ zipFile -> addFilesFromRegexRecursive ( $ dir , $ regexPattern , $ localPath ,  PhpZip  Constants ZipCompressionMethod:: BZIP2 ); // BZIP2 compression 

حذف الإدخالات من الأرشيف

ملف مضغوط::deleteFromName

حذف إدخال في الأرشيف باستخدام اسمه.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromName ( $ entryName );

ملف مضغوط::deleteFromGlob

يحذف الإدخالات في الأرشيف باستخدام نمط الكرة الأرضية.

 $ globPattern = ' **.{jpg,jpeg,png,gif} ' ; // example glob pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromGlob ( $ globPattern );

ملف مضغوط::deleteFromRegex

يحذف الإدخالات في الأرشيف باستخدام نمط PCRE.

 $ regexPattern = ' /.(jpe?g|png|gif)$/si ' ; // example regex pattern -> delete all .jpg, .jpeg, .png and .gif files

$ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteFromRegex ( $ regexPattern );

ملف مضغوط::deleteAll

يحذف جميع الإدخالات في أرشيف ZIP.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> deleteAll ();

العمل مع الإدخالات والأرشيف

ملف مضغوط::إعادة تسمية

إعادة تسمية الإدخال المحدد باسمه.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> rename ( $ oldName , $ newName );

ملف مضغوط::setCompressionLevel

قم بتعيين مستوى الضغط لجميع الملفات الموجودة في الأرشيف.

لاحظ أن هذا الأسلوب لا ينطبق على الإدخالات التي تتم إضافتها بعد تشغيل هذا الأسلوب.

بشكل افتراضي، مستوى الضغط هو 5 ( PhpZipConstantsZipCompressionLevel::NORMAL ) أو مستوى الضغط المحدد في الأرشيف لضغط Deflate.

تتراوح القيم من 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) إلى 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM ) مدعومة. كلما زاد الرقم، كان الضغط أفضل وأطول.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevel ( PhpZip  Constants ZipCompressionLevel:: MAXIMUM );

ZipFile::setCompressionLevelEntry

يضبط مستوى الضغط للإدخال حسب اسمه.

تتراوح القيم من 1 ( PhpZipConstantsZipCompressionLevel::SUPER_FAST ) إلى 9 ( PhpZipConstantsZipCompressionLevel::MAXIMUM ) مدعومة. كلما زاد الرقم، كان الضغط أفضل وأطول.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionLevelEntry ( $ entryName ,  PhpZip  Constants ZipCompressionLevel:: FAST );

ZipFile::setCompressionMethodEntry

يضبط طريقة الضغط للإدخال حسب اسمه.

تتوفر طرق الضغط التالية:

• PhpZipConstantsZipCompressionMethod::STORED - بدون ضغط
• PhpZipConstantsZipCompressionMethod::DEFLATED - ضغط التفريغ
• PhpZipConstantsZipCompressionMethod::BZIP2 - ضغط Bzip2 بالامتداد ext-bz2

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setCompressionMethodEntry ( $ entryName ,  PhpZip  Constants ZipCompressionMethod:: DEFLATED );

ملف مضغوط::setArchiveComment

قم بتعيين تعليق أرشيف ZIP.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setArchiveComment ( $ commentArchive );

ملف مضغوط::setEntryComment

قم بتعيين تعليق الإدخال المحدد حسب اسمه.

 $ zipFile = new  PhpZip  ZipFile ();
$ zipFile -> setEntryComment ( $ entryName , $ comment );

ملف مضغوط::matcher

اختيار الإدخالات في الأرشيف لإجراء العمليات عليها.

 $ zipFile = new  PhpZip  ZipFile ();
$ matcher = $ zipFile -> matcher ();

تحديد الملفات من الأرشيف واحدًا تلو الآخر:

 $ matcher
    -> add ( ' entry name ' )
    -> add ( ' another entry ' );

حدد ملفات متعددة في الأرشيف:

 $ matcher -> add ([
    ' entry name ' ,
    ' another entry name ' ,
    ' path/ '
]);

تحديد الملفات بالتعبير العادي:

 $ matcher -> match ( ' ~.jpe?g$~i ' );

حدد كافة الملفات في الأرشيف:

 $ matcher -> all ();

count() - يحصل على عدد الإدخالات المحددة:

 $ count = count ( $ matcher );
// or
$ count = $ matcher -> count ();

getMatches() - يُرجع قائمة بالإدخالات المحددة:

 $ entries = $ matcher -> getMatches ();
// example array contents: ['entry name', 'another entry name'];

استدعاء () - استدعاء وظيفة قابلة للاستدعاء على الإدخالات المحددة:

 // example
$ matcher -> invoke ( static function ( $ entryName ) use ( $ zipFile ) {
    $ newName = preg_replace ( ' ~.(jpe?g)$~i ' , ' .no_optimize.$1 ' , $ entryName );
    $ zipFile -> rename ( $ entryName , $ newName );
});

وظائف للعمل على الإدخالات المحددة:

 $ matcher -> delete (); // remove selected entries from a ZIP archive
$ matcher -> setPassword ( $ password ); // sets a new password for the selected entries
$ matcher -> setPassword ( $ password , $ encryptionMethod ); // sets a new password and encryption method to selected entries
$ matcher -> setEncryptionMethod ( $ encryptionMethod ); // sets the encryption method to the selected entries
$ matcher -> disableEncryption (); // disables encryption for selected entries 

العمل مع كلمات المرور

الدعم المطبق لطرق التشفير:

• PhpZipConstantsZipEncryptionMethod::PKWARE - تشفير PKWARE التقليدي (قديم)
• PhpZipConstantsZipEncryptionMethod::WINZIP_AES_256 - تشفير WinZip AES 256 بت (مستحسن)
• PhpZipConstantsZipEncryptionMethod::WINZIP_AES_192 - تشفير WinZip AES 192 بت
• PhpZipConstantsZipEncryptionMethod::WINZIP_AES_128 - تشفير WinZip AES 128 بت

ملف مضغوط::setReadPassword

قم بتعيين كلمة المرور للأرشيف المفتوح.

لا يشترط تعيين كلمة مرور لإضافة إدخالات جديدة أو حذف إدخالات موجودة، ولكن إذا كنت تريد استخراج المحتوى أو تغيير الطريقة/مستوى الضغط أو طريقة التشفير أو تغيير كلمة المرور، ففي هذه الحالة يجب تحديد كلمة المرور.

 $ zipFile -> setReadPassword ( $ password );

ملف مضغوط::setReadPasswordEntry

يحصل على كلمة مرور لقراءة الإدخال المحدد باسمه.

 $ zipFile -> setReadPasswordEntry ( $ entryName , $ password );

ملف مضغوط::setPassword

تعيين كلمة مرور جديدة لجميع الملفات في الأرشيف.

لاحظ أن هذا الأسلوب لا ينطبق على الإدخالات التي تتم إضافتها بعد تشغيل هذا الأسلوب.

 $ zipFile -> setPassword ( $ password );

يمكنك ضبط طريقة التشفير:

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPassword ( $ password , $ encryptionMethod );

ملف مضغوط::setPasswordEntry

يعين كلمة مرور جديدة للإدخال المحدد باسمه.

 $ zipFile -> setPasswordEntry ( $ entryName , $ password );

يمكنك ضبط طريقة التشفير:

 $ encryptionMethod =  PhpZip  Constants ZipEncryptionMethod:: WINZIP_AES_256 ;
$ zipFile -> setPasswordEntry ( $ entryName , $ password , $ encryptionMethod );

ملف مضغوط::disableEncryption

تعطيل التشفير لجميع الإدخالات الموجودة بالفعل في الأرشيف.

لاحظ أن هذا الأسلوب لا ينطبق على الإدخالات التي تتم إضافتها بعد تشغيل هذا الأسلوب.

 $ zipFile -> disableEncryption ();

ملف مضغوط::disableEncryptionEntry

تعطيل تشفير الإدخال المحدد باسمه.

 $ zipFile -> disableEncryptionEntry ( $ entryName );

التراجع عن التغييرات

ملف مضغوط::unchangeAll

التراجع عن كافة التغييرات التي تم إجراؤها في الأرشيف.

 $ zipFile -> unchangeAll ();

ملف مضغوط::unchangeArchiveComment

التراجع عن التغييرات التي تم إجراؤها على تعليق الأرشيف.

 $ zipFile -> unchangeArchiveComment ();

ملف مضغوط::unchangeEntry

التراجع عن تغييرات الإدخال المحدد باسمه.

 $ zipFile -> unchangeEntry ( $ entryName );

حفظ ملف أو إخراج إلى المتصفح

ملف مضغوط::saveAsFile

يحفظ الأرشيف في ملف.

 $ zipFile -> saveAsFile ( $ filename );

ملف مضغوط::saveAsStream

يكتب الأرشيف إلى الدفق.

 // $fp = fopen($filename, 'w+b');

$ zipFile -> saveAsStream ( $ fp );

ملف مضغوط::outputAsString

إخراج أرشيف ZIP كسلسلة.

 $ rawZipArchiveBytes = $ zipFile -> outputAsString ();

ملف مضغوط::outputAsAttachment

يقوم بإخراج أرشيف ZIP إلى المتصفح.

 $ zipFile -> outputAsAttachment ( $ outputFilename );

يمكنك ضبط نوع Mime:

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsAttachment ( $ outputFilename , $ mimeType );

ملف مضغوط ::outputAsPsr7Response

يُخرج أرشيف ZIP كاستجابة PSR-7.

يمكن استخدام طريقة الإخراج في أي إطار عمل متوافق مع PSR-7.

 // $response = ....; // instance PsrHttpMessageResponseInterface
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename );

يمكنك ضبط نوع Mime:

 $ mimeType = ' application/zip ' ;
$ zipFile -> outputAsPsr7Response ( $ response , $ outputFilename , $ mimeType );

ZipFile::outputAsSymfonyResponse

يقوم بإخراج أرشيف ZIP كاستجابة Symfony.

يمكن استخدام طريقة الإخراج في إطار عمل Symfony.

 $ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );

يمكنك ضبط نوع Mime:

 $ mimeType = ' application/zip ' ;
$ response = $ zipFile -> outputAsSymfonyResponse ( $ outputFilename , $ mimeType );

مثال للاستخدام في وحدة تحكم Symfony:

 <?php

namespace App  Controller ;

use PhpZip  ZipFile ;
use Symfony  Component  HttpFoundation  Response ;
use Symfony  Component  Routing  Annotation  Route ;

class DownloadZipController
{
    /**
     * @Route("/downloads/{id}")
     *
     * @throws PhpZipExceptionZipException
     */
    public function __invoke ( string $ id ): Response
    {
        $ zipFile = new ZipFile ();
        $ zipFile [ ' file ' ] = ' contents ' ;

        $ outputFilename = $ id . ' .zip ' ;
        return $ zipFile -> outputAsSymfonyResponse ( $ outputFilename );
    }
}

ملف مضغوط::إعادة الكتابة

احفظ التغييرات وأعد فتح الأرشيف الذي تم تغييره.

 $ zipFile -> rewrite ();

إغلاق الأرشيف

ملف مضغوط::إغلاق

أغلق الأرشيف.

 $ zipFile -> close ();

تشغيل الاختبارات

تثبيت التبعيات للتطوير:

composer install --dev

تشغيل الاختبارات:

vendor/bin/phpunit

سجل التغيير

تم توثيق التغييرات في صفحة الإصدارات.

يرقي

ترقية الإصدار 3 إلى الإصدار 4

قم بتحديث الإصدار الرئيسي في الملف composer.json إلى ^4.0 .

{
    "require" : {
        "nelexa/zip" : " ^4.0 "
    }
}

ثم قم بتثبيت التحديثات باستخدام Composer :

composer update nelexa/zip

قم بتحديث التعليمات البرمجية الخاصة بك للعمل مع الإصدار الجديد: BC

• تمت إزالة الفئات والأساليب المهملة.
• تمت إزالة وظيفة zipalign . سيتم وضع هذه الوظيفة في حزمة منفصلة nelexa/apkfile .

ترقية الإصدار 2 إلى الإصدار 3

قم بتحديث الإصدار الرئيسي في الملف composer.json إلى ^3.0 .

{
    "require" : {
        "nelexa/zip" : " ^3.0 "
    }
}

ثم قم بتثبيت التحديثات باستخدام Composer :

composer update nelexa/zip

قم بتحديث الكود الخاص بك للعمل مع الإصدار الجديد:

• تم دمج فئة ZipOutputFile في ZipFile وإزالتها.
  • new PhpZipZipOutputFile() إلى new PhpZipZipFile()
• أساليب التهيئة الثابتة لم تعد ثابتة.
  • PhpZipZipFile::openFromFile($filename); إلى (new PhpZipZipFile())->openFile($filename);
  • PhpZipZipOutputFile::openFromFile($filename); إلى (new PhpZipZipFile())->openFile($filename);
  • PhpZipZipFile::openFromString($contents); إلى (new PhpZipZipFile())->openFromString($contents);
  • PhpZipZipFile::openFromStream($stream); إلى (new PhpZipZipFile())->openFromStream($stream);
  • PhpZipZipOutputFile::create() إلى new PhpZipZipFile()
  • PhpZipZipOutputFile::openFromZipFile(PhpZipZipFile $zipFile) > (new PhpZipZipFile())->openFile($filename);
• إعادة تسمية الأساليب:
  • addFromFile إلى addFile
  • setLevel إلى setCompressionLevel
  • ZipFile::setPassword إلى ZipFile::withReadPassword
  • ZipOutputFile::setPassword إلى ZipFile::withNewPassword
  • ZipOutputFile::disableEncryptionAllEntries إلى ZipFile::withoutPassword
  • ZipOutputFile::setComment إلى ZipFile::setArchiveComment
  • ZipFile::getComment إلى ZipFile::getArchiveComment
• تم تغيير التوقيع للأساليب addDir و addFilesFromGlob و addFilesFromRegex .
• إزالة الأساليب:
  • getLevel
  • setCompressionMethod
  • setEntryPassword