wpdk-array.php

Go to the documentation of this file.

<?php

class WPDKArray extends WPDKObject {

  public $__version = '1.0.3';

  public static function insertKeyValuePairs( $arr, $key, $val, $index = 0 )
  {
    $arrayEnd   = array_splice( $arr, $index );
    $arrayStart = array_splice( $arr, 0, $index );
    return ( array_merge( $arrayStart, array( $key => $val ), $arrayEnd ) );
  }

  public static function insert( &$arr, $new, $index = 0 )
  {
    /* Removes everything from offset */
    $arrayEnd   = array_splice( $arr, $index );
    $arrayStart = array_splice( $arr, 0, $index );
    return ( array_merge( $arrayStart, $new, $arrayEnd ) );
  }

  public static function prepend( $array, &$dest )
  {
    $dest = self::insert( $dest, $array );
    return $dest;
  }

  public static function append( $array, &$dest )
  {
    $dest = self::insert( $dest, $array, count( $dest ) );
    return $dest;
  }

  public static function wrapArray( $array )
  {
    $result = array();
    foreach ( $array as $element ) {
      $result[] = array( $element );
    }
    return $result;
  }

  public static function arrayMatch( $array_keys, $array_match )
  {
    $result = array();
    foreach ( $array_match as $key => $value ) {
      if ( in_array( $key, $array_keys ) ) {
        $result[$key] = $value;
      }
    }
    return $result;
  }

  public static function arrayMatchWithValues( $array, $array_match )
  {
    return self::arrayMatch( array_values( $array ), $array_match );
  }

  public static function arrayMatchWithKeys( $array, $array_match )
  {
    return self::arrayMatch( array_keys( $array ), $array_match );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Conversions
  // -------------------------------------------------------------------------------------------------------------------

  public static function arrayToObject( $array )
  {
    // First we convert the array to a json string
    $json = json_encode( $array );

    // The we convert the json string to a stdClass()
    $object = json_decode( $json );

    return $object;
  }


  public static function objectToArray( $object )
  {
    // First we convert the object into a json string
    $json = json_encode( $object );

    // Then we convert the json string to an array
    $array = json_decode( $json, true );

    return $array;
  }

  public static function stripKeys( $source, $keeplist )
  {
    $keys = array_keys( $keeplist );
    foreach ( $source as $key => $value ) {
      if ( !in_array( $key, $keys ) ) {
        unset( $source[$key] );
      }
    }
    return $source;
  }

  public static function fit( $source, $defaults )
  {
    $source = self::stripKeys( $source, $defaults );
    return array_merge( $defaults, $source );
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Miscellanea
  // -------------------------------------------------------------------------------------------------------------------

  public static function httpBuildQuery( $formdata, $numeric_prefix = null, $arg_separator = null )
  {

    /* Get PHP version. */
    if ( defined( 'PHP_MAJOR_VERSION' ) && PHP_MAJOR_VERSION >= 5 ) {
      return http_build_query( $formdata, $numeric_prefix, $arg_separator );
    }
    else {
      $version = absint( phpversion() );
      if ( !empty( $version ) && $version >= 5 ) {
        return http_build_query( $formdata, $numeric_prefix, $arg_separator );
      }
    }

    /* Emulate the behavior. */
    $result = '';
    $amp    = '';
    foreach ( $formdata as $key => $value ) {
      $result .= sprintf( '%s%s=%s', $amp, $key, urlencode( $value ) );
      $amp = $arg_separator;
    }

    return $result;
  }

  // -------------------------------------------------------------------------------------------------------------------
  // Deprecated
  // -------------------------------------------------------------------------------------------------------------------

  public static function arrayWithKey( $array_key, $array_extract )
  {
    _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '1.4.8', 'arrayMatch()' );

    $keys   = array_keys( $array_key );
    $result = array();
    foreach ( $array_extract as $key => $value ) {
      if ( in_array( $key, $keys ) ) {
        $result[$key] = $value;
      }
    }
    return $result;
  }
  public static function arrayExtractByKey( $sourceArray, $arrayKeys )
  {
    _deprecated_function( __CLASS__ . '::' . __FUNCTION__, '1.4.8', 'arrayMatch()' );

    $keys   = array_keys( $arrayKeys );
    $result = array();
    foreach ( $sourceArray as $key => $value ) {
      if ( in_array( $key, $keys ) ) {
        $result[$key] = $value;
      }
    }
    return $result;
  }

}