Serializer/Adapter/PythonPickle.php

Show:

inherited

Classes
- \Zend_Serializer_Adapter_PythonPickle

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Serializer
Subpackage: Adapter
Version: $Id: PythonPickle.php 24815 2012-05-24 08:50:24Z mabe $

\Zend_Serializer_Adapter_PythonPickle
jump to top

Package: Zend\Serializer\Adapter

Parent(s): \Zend_Serializer_Adapter_AdapterAbstract
See: \global\Phython3.1/Lib/pickle.py
See: \global\Phython3.1/Modules/_pickle.c
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Link: http://www.python.org
Link: http://pickle-js.googlecode.com

Constants

 
                OP_MARK
                = '('

 
                OP_STOP
                = '.'

 
                OP_POP
                = '0'

 
                OP_POP_MARK
                = '1'

 
                OP_DUP
                = '2'

 
                OP_FLOAT
                = 'F'

 
                OP_INT
                = 'I'

 
                OP_BININT
                = 'J'

 
                OP_BININT1
                = 'K'

 
                OP_LONG
                = 'L'

 
                OP_BININT2
                = 'M'

 
                OP_NONE
                = 'N'

 
                OP_PERSID
                = 'P'

 
                OP_BINPERSID
                = 'Q'

 
                OP_REDUCE
                = 'R'

 
                OP_STRING
                = 'S'

 
                OP_BINSTRING
                = 'T'

 
                OP_SHORT_BINSTRING
                = 'U'

 
                OP_UNICODE
                = 'V'

 
                OP_BINUNICODE
                = 'X'

 
                OP_APPEND
                = 'a'

 
                OP_BUILD
                = 'b'

 
                OP_GLOBAL
                = 'c'

 
                OP_DICT
                = 'd'

 
                OP_EMPTY_DICT
                = '}'

 
                OP_APPENDS
                = 'e'

 
                OP_GET
                = 'g'

 
                OP_BINGET
                = 'h'

 
                OP_INST
                = 'i'

 
                OP_LONG_BINGET
                = 'j'

 
                OP_LIST
                = 'l'

 
                OP_EMPTY_LIST
                = ']'

 
                OP_OBJ
                = 'o'

 
                OP_PUT
                = 'p'

 
                OP_BINPUT
                = 'q'

 
                OP_LONG_BINPUT
                = 'r'

 
                OP_SETITEM
                = 's'

 
                OP_TUPLE
                = 't'

 
                OP_EMPTY_TUPLE
                = ')'

 
                OP_SETITEMS
                = 'u'

 
                OP_BINFLOAT
                = 'G'

 
                OP_PROTO
                = "\x80"

 
                OP_NEWOBJ
                = "\x81"

 
                OP_EXT1
                = "\x82"

 
                OP_EXT2
                = "\x83"

 
                OP_EXT4
                = "\x84"

 
                OP_TUPLE1
                = "\x85"

 
                OP_TUPLE2
                = "\x86"

 
                OP_TUPLE3
                = "\x87"

 
                OP_NEWTRUE
                = "\x88"

 
                OP_NEWFALSE
                = "\x89"

 
                OP_LONG1
                = "\x8a"

 
                OP_LONG4
                = "\x8b"

 
                OP_BINBYTES
                = 'B'

 
                OP_SHORT_BINBYTES
                = 'C'

Properties

$_binary = false

Default valuefalseDetails

Type: n/a

bool $_isLittleEndian = null

static

Whether or not the system is little-endian

Default valuenullDetails

Type: bool

bool $_isPhp6 = null

static

Whether or not this is a PHP 6 binary

Default valuenullDetails

Type: bool

$_marker = null

Default valuenullDetails

Type: n/a

$_memo = array()

Default valuearray()Details

Type: n/a

array $_options = array('protocol' => 0)

Default options

Serializer options

Default valuearray('protocol' => 0)Details

Type: array

$_pickle = ''

Default value''Details

Type: n/a

$_pickleLen = 0

Default value0Details

Type: n/a

$_pos = 0

Default value0Details

Type: n/a

$_protocol = 0

Default value0Details

Type: n/a

array $_quoteString = array('\\' => '\\\\', "\x00" => '\\x00', "\x01" => '\\x01', "\x02" => '\\x02', "\x03" => '\\x03', "\x04" => '\\x04', "\x05" => '\\x05', "\x06" => '\\x06', "\x07" => '\\x07', "\x08" => '\\x08', "\x09" => '\\t', "\x0a" => '\\n', "\x0b" => '\\x0b', "\x0c" => '\\x0c', "\x0d" => '\\r', "\x0e" => '\\x0e', "\x0f" => '\\x0f', "\x10" => '\\x10', "\x11" => '\\x11', "\x12" => '\\x12', "\x13" => '\\x13', "\x14" => '\\x14', "\x15" => '\\x15', "\x16" => '\\x16', "\x17" => '\\x17', "\x18" => '\\x18', "\x19" => '\\x19', "\x1a" => '\\x1a', "\x1b" => '\\x1b', "\x1c" => '\\x1c', "\x1d" => '\\x1d', "\x1e" => '\\x1e', "\x1f" => '\\x1f', "\xff" => '\\xff')

static

Strings representing quotes

Default value

array('\\' => '\\\\', "\x00" => '\\x00', "\x01" => '\\x01', "\x02" => '\\x02', "\x03" => '\\x03', "\x04" => '\\x04', "\x05" => '\\x05', "\x06" => '\\x06', "\x07" => '\\x07', "\x08" => '\\x08', "\x09" => '\\t', "\x0a" => '\\n', "\x0b" => '\\x0b', "\x0c" => '\\x0c', "\x0d" => '\\r', "\x0e" => '\\x0e', "\x0f" => '\\x0f', "\x10" => '\\x10', "\x11" => '\\x11', "\x12" => '\\x12', "\x13" => '\\x13', "\x14" => '\\x14', "\x15" => '\\x15', "\x16" => '\\x16', "\x17" => '\\x17', "\x18" => '\\x18', "\x19" => '\\x19', "\x1a" => '\\x1a', "\x1b" => '\\x1b', "\x1c" => '\\x1c', "\x1d" => '\\x1d', "\x1e" => '\\x1e', "\x1f" => '\\x1f', "\xff" => '\\xff')

Details

Type: array

$_stack = array()

Default valuearray()Details

Type: n/a

Methods

__construct(array | \Zend_Config $opts = array()) : void

Constructor

Parameters

Name	Type	Description
$opts	array \| \Zend_Config	Serializer options

Details

Link: Zend_Serializer_Adapter_AdapterAbstract::__construct()

_checkProtocolNumber(int $number) : int

Check and normalize pickle protocol number

Parameters

Name	Type	Description
$number	int

Returns

Type	Description
int

Throws

Exception	Description
\Zend_Serializer_Exception

_convertMatchingUnicodeSequence2Utf8(array $match) : string

Convert a unicode sequence to UTF-8

Parameters

Name	Type	Description
$match	array

Returns

Type	Description
string

_decodeBinLong(string $data) : int | float | string

Decode a binary long sequence

Parameters

Name	Type	Description
$data	string

Returns

Type	Description
int \| float \| string

_hex2Utf8( $hex) : string

Convert a hex string to a UTF-8 string

Parameters

Name	Type	Description
$hex

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Serializer_Exception	on unmatched unicode sequence

_isArrayAssoc(array $value) : boolean

Is an array associative?

Parameters

Name	Type	Description
$value	array

Returns

Type	Description
boolean

_lastMarker() : int

Return last marker position in stack

Returns

Type	Description
int

_load(string $op) : void

Load a pickle opcode

Parameters

Name	Type	Description
$op	string

Throws

Exception	Description
\Zend_Serializer_Exception	on invalid opcode

_loadAppend() : void

Load an append (to list) sequence

_loadAppends() : void

Load multiple append (to list) sequences at once

_loadBinBytes() : void

Load arbitrary binary bytes

_loadBinFloat() : void

Load a binary float value

_loadBinGet() : void

Load a binary GET operation

Throws

Exception	Description
\Zend_Serializer_Exception	on missing GET identifier

_loadBinInt() : void

Load a binary integer operator

_loadBinInt1() : void

Load the first byte of a binary integer

_loadBinInt2() : void

Load the second byte of a binary integer

_loadBinPut() : void

Load a binary PUT

Throws

Exception	Description
\Zend_Serializer_Exception	on missing stack

_loadBinString() : void

Load a binary string

_loadBinUnicode() : void

Load binary unicode sequence

_loadDict() : void

Load an associative array (Python dictionary)

_loadEmptyDict() : void

Load an empty dictionary

_loadEmptyList() : void

Load an empty list sequence

_loadFloat() : void

Load a float value

_loadGet() : void

Load a GET operation

Throws

Exception	Description
\Zend_Serializer_Exception	on missing GET identifier

_loadInt() : void

Load an integer operator

_loadList() : void

Load an array (list)

_loadLong() : void

Load a long (float) operator

_loadLong1() : void

Load a one byte long integer

_loadLong4() : void

Load a 4 byte long integer

_loadLongBinGet() : void

Load a long binary GET operation

Throws

Exception	Description
\Zend_Serializer_Exception	on missing GET identifier

_loadLongBinPut() : void

Load a long binary PUT

Throws

Exception	Description
\Zend_Serializer_Exception	on missing stack

_loadMark() : void

Load a marker sequence

_loadNewFalse() : void

Load a boolean FALSE operator

_loadNewTrue() : void

Load a boolean TRUE operator

_loadNone() : void

Load a NONE operator

_loadProto() : void

Load a proto value

Throws

Exception	Description
\Zend_Serializer_Exception	if Pickle version does not support this feature

_loadPut() : void

Load a PUT opcode

Throws

Exception	Description
\Zend_Serializer_Exception	on missing stack

_loadSetItem() : void

Load an item from a set

_loadSetItems() : void

Load set items

_loadShortBinBytes() : void

Load a single binary byte

_loadShortBinString() : void

Load a short binary string

_loadString() : void

Load a string

_loadTuple() : void

Load a tuple

_loadTuple1() : void

Load single item tuple

_loadTuple2() : void

Load two item tuple

_loadTuple3() : void

Load three item tuple

_loadUnicode() : void

Load a unicode string

_momorize(mixed $value) : void

Add a value to the memo and write the id

Parameters

Name	Type	Description
$value	mixed

_quoteString(string $str) : string

Quote/Escape a string

Parameters

Name	Type	Description
$str	string

Returns

Type	Description
string	quoted string

_read(mixed $len) : string

Read a segment of the pickle

Parameters

Name	Type	Description
$len	mixed

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Serializer_Exception	if position matches end of data

_readline() : string

Read a line of the pickle at once

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Serializer_Exception	if no EOL character found

_searchMomo(mixed $value) : int | false

Search a value in the meno and return the id

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
int \| false	The id or false

_unquoteString(string $str) : string

Unquote/Unescape a quoted string

Parameters

Name	Type	Description
$str	string	quoted string

Returns

Type	Description
string	unquoted string

_write(mixed $value) : void

Write a value

Parameters

Name	Type	Description
$value	mixed

Throws

Exception	Description
\Zend_Serializer_Exception	on invalid or unrecognized value type

_writeArrayDict(array $value) : void

Write an associative array value as dictionary

Parameters

Name	Type	Description
$value	array

_writeArrayList(array $value) : void

Write a simple array value as list

Parameters

Name	Type	Description
$value	array

_writeFalse() : void

Write a boolean false

_writeFloat(float $value) : void

Write a float value

Parameters

Name	Type	Description
$value	float

_writeGet(int $id) : void

Write a get

Parameters

Name	Type	Description
$id	int	Id of memo

_writeInt(int $value) : void

Write an integer value

Parameters

Name	Type	Description
$value	int

_writeNull() : void

Write a null as None

_writeObject(object $value) : void

Write an object as an dictionary

Parameters

Name	Type	Description
$value	object

_writeProto(int $protocol) : void

Write pickle protocol

Parameters

Name	Type	Description
$protocol	int

_writePut(int $id) : void

Write a put

Parameters

Name	Type	Description
$id	int	Id of memo

_writeStop() : void

Write stop

_writeString(string $value) : void

Write a string value

Parameters

Name	Type	Description
$value	string

_writeTrue() : void

Write a boolean true

getOption(string $name) : mixed

inherited

Get a serializer option

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::getOption()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Serializer_Exception

getOptions() : array

inherited

Get serializer options

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::getOptions()

Returns

Type	Description
array

serialize(mixed $value, array $opts = array()) : string

Serialize PHP to PythonPickle format

Parameters

Name	Type	Description
$value	mixed
$opts	array

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Serializer_Exception

setOption(string $name, mixed $value) : \Zend_Serializer_Adapter_PythonPickle

Set an option

Parameters

Name	Type	Description
$name	string
$value	mixed

Returns

Type	Description
\Zend_Serializer_Adapter_PythonPickle

Details

Link: Zend_Serializer_Adapter_AdapterAbstract::setOption()

setOptions(array | \Zend_Config $opts) : \Zend_Serializer_Adapter_AdapterAbstract

inherited

Set serializer options

Inherited from: \Zend_Serializer_Adapter_AdapterAbstract::setOptions()

Parameters

Name	Type	Description
$opts	array \| \Zend_Config	Serializer options

Returns

Type	Description
\Zend_Serializer_Adapter_AdapterAbstract

unserialize(string $pickle, array $opts = array()) : mixed

Unserialize from Python Pickle format to PHP

Parameters

Name	Type	Description
$pickle	string
$opts	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Serializer_Exception	on invalid Pickle string

Serializer/Adapter/PythonPickle.php

\Zend_Serializer_Adapter_PythonPicklejump to top

Constants

Properties

Methods

\Zend_Serializer_Adapter_PythonPickle
jump to top