Skip to content

Commit 083c5e7

Browse files
committed
The docs and variable names now better match the rest of the project
1 parent 1dbb974 commit 083c5e7

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

lib/Zyberspace/Telegram/Cli/Client.php

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -374,32 +374,40 @@ public function getHistory($peer, $limit = null, $offset = null)
374374
}
375375

376376
/**
377-
* Send Picture to peer
377+
* Send picture to peer
378378
*
379-
* @param string $peer The peer, gets escaped with escapePeer()
380-
* @param string $pic Picture Path
379+
* @param string $peer The peer, gets escaped with escapePeer()
380+
* @param string $path The picture path, gets formatted with formatFileName()
381381
* @return boolean
382+
*
383+
* @uses exec()
384+
* @uses escapePeer()
385+
* @uses formatFileName()
382386
*/
383-
public function sendPicture($peer, $pic)
387+
public function sendPicture($peer, $path)
384388
{
385389
$peer = $this->escapePeer($peer);
386-
$picture = $this->formatFileName($pic);
390+
$formattedPath = $this->formatFileName($path);
387391

388-
return $this->exec('send_photo ' . $peer . ' ' . $picture);
392+
return $this->exec('send_photo ' . $peer . ' ' . $formattedPath);
389393
}
390394

391395
/**
392-
* Send File to peer
396+
* Send file to peer
393397
*
394-
* @param string $peer The peer, gets escaped with escapePeer()
395-
* @param string $pic File Path
398+
* @param string $peer The peer, gets escaped with escapePeer()
399+
* @param string $path The file path, gets formatted with formatFileName()
396400
* @return boolean
401+
*
402+
* @uses exec()
403+
* @uses escapePeer()
404+
* @uses formatFileName()
397405
*/
398-
public function sendFile($peer, $file)
406+
public function sendFile($peer, $path)
399407
{
400408
$peer = $this->escapePeer($peer);
401-
$atFile = $this->formatFileName($file);
409+
$formattedPath = $this->formatFileName($path);
402410

403-
return $this->exec('send_file ' . $peer . ' ' . $atFile);
411+
return $this->exec('send_file ' . $peer . ' ' . $formattedPath);
404412
}
405413
}

0 commit comments

Comments
 (0)