Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Utility;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides PHP environment helper methods.
Chris@0:  */
Chris@0: class Environment {
Chris@0: 
Chris@0:   /**
Chris@0:    * Compares the memory required for an operation to the available memory.
Chris@0:    *
Chris@0:    * @param string $required
Chris@0:    *   The memory required for the operation, expressed as a number of bytes with
Chris@0:    *   optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes,
Chris@0:    *   9mbytes).
Chris@0:    * @param $memory_limit
Chris@0:    *   (optional) The memory limit for the operation, expressed as a number of
Chris@0:    *   bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G,
Chris@0:    *   6GiB, 8bytes, 9mbytes). If no value is passed, the current PHP
Chris@0:    *   memory_limit will be used. Defaults to NULL.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if there is sufficient memory to allow the operation, or FALSE
Chris@0:    *   otherwise.
Chris@0:    */
Chris@0:   public static function checkMemoryLimit($required, $memory_limit = NULL) {
Chris@0:     if (!isset($memory_limit)) {
Chris@0:       $memory_limit = ini_get('memory_limit');
Chris@0:     }
Chris@0: 
Chris@0:     // There is sufficient memory if:
Chris@0:     // - No memory limit is set.
Chris@0:     // - The memory limit is set to unlimited (-1).
Chris@0:     // - The memory limit is greater than or equal to the memory required for
Chris@0:     //   the operation.
Chris@0:     return ((!$memory_limit) || ($memory_limit == -1) || (Bytes::toInt($memory_limit) >= Bytes::toInt($required)));
Chris@0:   }
Chris@0: 
Chris@0: }