getid3_handler::saveAttachment( string $name, int $offset, int $length, string $image_mime = null ): string|null

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$namestring

$offsetint

$lengthint

$image_mimestringoptional

Default: null

Return value

string|null

Performance profile

How much work a call to getid3_handler::saveAttachment() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via is_dir().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

18–88

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 158.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessis_dir()called directly

What one call costs · 19 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost getid3_handler::saveAttachment() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• getid3_handler::fseek()
• getid3_handler::fread()
• Exception::__construct()Create a new exception
• getID3::is_writable()
• getid3_lib::ImageExtFromMime()
• getid3_handler::warning()

Source code

View on Trac ↗View on GitHub ↗

2435	public function saveAttachment($name, $offset, $length, $image_mime=null) {2436		$fp_dest = null;2437		$dest = null;2438		try {2439 2440			// do not extract at all2441			if ($this->getid3->option_save_attachments === getID3::ATTACHMENTS_NONE) {2442 2443				$attachment = null; // do not set any2444 2445			// extract to return array2446			} elseif ($this->getid3->option_save_attachments === getID3::ATTACHMENTS_INLINE) {2447 2448				$this->fseek($offset);2449				$attachment = $this->fread($length); // get whole data in one pass, till it is anyway stored in memory2450				if ($attachment === false || strlen($attachment) != $length) {2451					throw new Exception('failed to read attachment data');2452				}2453 2454			// assume directory path is given2455			} else {2456 2457				// set up destination path2458				$dir = rtrim(str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $this->getid3->option_save_attachments), DIRECTORY_SEPARATOR);2459				if (!is_dir($dir) || !getID3::is_writable($dir)) { // check supplied directory2460					throw new Exception('supplied path ('.$dir.') does not exist, or is not writable');2461				}2462				$dest = $dir.DIRECTORY_SEPARATOR.$name.($image_mime ? '.'.getid3_lib::ImageExtFromMime($image_mime) : '');2463 2464				// create dest file2465				if (($fp_dest = fopen($dest, 'wb')) == false) {2466					throw new Exception('failed to create file '.$dest);2467				}2468 2469				// copy data2470				$this->fseek($offset);2471				$buffersize = ($this->data_string_flag ? $length : $this->getid3->fread_buffer_size());2472				$bytesleft = $length;2473				while ($bytesleft > 0) {2474					if (($buffer = $this->fread(min($buffersize, $bytesleft))) === false || ($byteswritten = fwrite($fp_dest, $buffer)) === false || ($byteswritten === 0)) {2475						throw new Exception($buffer === false ? 'not enough data to read' : 'failed to write to destination file, may be not enough disk space');2476					}2477					$bytesleft -= $byteswritten;2478				}2479 2480				fclose($fp_dest);2481				$attachment = $dest;2482 2483			}2484 2485		} catch (Exception $e) {2486 2487			// close and remove dest file if created2488			if (isset($fp_dest) && is_resource($fp_dest)) {2489				fclose($fp_dest);2490			}2491 2492			if (isset($dest) && file_exists($dest)) {2493				unlink($dest);2494			}2495 2496			// do not set any is case of error2497			$attachment = null;2498			$this->warning('Failed to extract attachment '.$name.': '.$e->getMessage());2499 2500		}2501 2502		// seek to the end of attachment2503		$this->fseek($offset + $length);2504 2505		return $attachment;2506	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ID3/getid3.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.