Overview

Namespaces

  • Coast
    • App
      • Access
      • Executable
    • Controller
    • Csrf
    • Dir
    • Feed
    • File
    • Filter
      • Rule
    • Http
    • Image
    • Model
      • Exception
    • Resolver
    • Router
    • Sitemap
    • Transformer
      • Rule
    • Validator
      • Rule
    • View

Classes

  • Coast\Acl
  • Coast\App
  • Coast\App\Subpath
  • Coast\Coast
  • Coast\Collection
  • Coast\Config
  • Coast\Controller
  • Coast\Controller\Action
  • Coast\Csp
  • Coast\Csrf
  • Coast\Dir
  • Coast\Dir\Iterator
  • Coast\Feed
  • Coast\Feed\Content
  • Coast\Feed\Item
  • Coast\Feed\Person
  • Coast\File
  • Coast\File\Path
  • Coast\Filter
  • Coast\Filter\Rule
  • Coast\Filter\Rule\CamelCase
  • Coast\Filter\Rule\CamelCaseSplit
  • Coast\Filter\Rule\Custom
  • Coast\Filter\Rule\DecimalType
  • Coast\Filter\Rule\EmailAddress
  • Coast\Filter\Rule\EncodeSpecialChars
  • Coast\Filter\Rule\FloatType
  • Coast\Filter\Rule\IntegerType
  • Coast\Filter\Rule\LowerCase
  • Coast\Filter\Rule\NumberType
  • Coast\Filter\Rule\Slugify
  • Coast\Filter\Rule\StripTags
  • Coast\Filter\Rule\TitleCase
  • Coast\Filter\Rule\Trim
  • Coast\Filter\Rule\UpperCase
  • Coast\Filter\Rule\Url
  • Coast\Http
  • Coast\Http\Request
  • Coast\Http\Response
  • Coast\Image
  • Coast\Lazy
  • Coast\Model
  • Coast\Model\Metadata
  • Coast\Path
  • Coast\Request
  • Coast\Resolver
  • Coast\Response
  • Coast\Router
  • Coast\Session
  • Coast\Sitemap
  • Coast\Sitemap\Url
  • Coast\Transformer
  • Coast\Transformer\Rule
  • Coast\Transformer\Rule\BooleanType
  • Coast\Transformer\Rule\Custom
  • Coast\Transformer\Rule\DateTime
  • Coast\Transformer\Rule\IntegerType
  • Coast\Transformer\Rule\NullType
  • Coast\Transformer\Rule\Url
  • Coast\Url
  • Coast\Validator
  • Coast\Validator\Rule
  • Coast\Validator\Rule\ArrayType
  • Coast\Validator\Rule\BooleanType
  • Coast\Validator\Rule\Count
  • Coast\Validator\Rule\Custom
  • Coast\Validator\Rule\DateTime
  • Coast\Validator\Rule\DecimalType
  • Coast\Validator\Rule\EmailAddress
  • Coast\Validator\Rule\Equals
  • Coast\Validator\Rule\File
  • Coast\Validator\Rule\FloatType
  • Coast\Validator\Rule\Func
  • Coast\Validator\Rule\Hostname
  • Coast\Validator\Rule\In
  • Coast\Validator\Rule\IntegerType
  • Coast\Validator\Rule\IpAddress
  • Coast\Validator\Rule\Length
  • Coast\Validator\Rule\Max
  • Coast\Validator\Rule\Min
  • Coast\Validator\Rule\Not
  • Coast\Validator\Rule\NumberType
  • Coast\Validator\Rule\ObjectType
  • Coast\Validator\Rule\Password
  • Coast\Validator\Rule\Range
  • Coast\Validator\Rule\Recaptcha
  • Coast\Validator\Rule\Regex
  • Coast\Validator\Rule\Set
  • Coast\Validator\Rule\StringType
  • Coast\Validator\Rule\Upload
  • Coast\Validator\Rule\Url
  • Coast\View
  • Coast\View\Content
  • Coast\Xml

Interfaces

  • Coast\App\Access
  • Coast\App\Executable
  • Coast\Router\Routable

Traits

  • Coast\App\Access\Implementation
  • Coast\App\Executable\Implementation

Exceptions

  • Coast\App\Exception
  • Coast\Controller\Exception
  • Coast\Controller\Failure
  • Coast\Csrf\Exception
  • Coast\Exception
  • Coast\Http\Exception
  • Coast\Image\Exception
  • Coast\Model\Exception
  • Coast\Model\Exception\NotDefined
  • Coast\Resolver\Exception
  • Coast\Router\Exception
  • Coast\Router\Failure
  • Coast\View\Exception
  • Coast\View\Failure
  • Overview
  • Namespace
  • Class
  • Deprecated
  • Todo
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 
<?php
/*
 * Copyright 2017 Jack Sleight <http://jacksleight.com/>
 * This source file is subject to the MIT license that is bundled with this package in the file LICENCE. 
 */

namespace Coast;

use DateTime;
use Coast\Dir;

class File extends \Coast\File\Path
{
    protected $_chars = [',', '"', '\\'];

    protected $_handle;

    public static function createTemp()
    {
        $path = str_replace(DIRECTORY_SEPARATOR, '/', tempnam(sys_get_temp_dir(), 'php'));
        if (!$path) {
            throw new \Exception('Could not create tempoary file');
        }
        return new \Coast\File($path);
    }

    public static function createMemory($max = null)
    {
        return new \Coast\File("php://temp" . (isset($max) ? "/maxmemory:{$max}" : null));
    }

    public function chars($delimiter = ',', $enclosure = '"', $escape = '\\')
    {
        $this->_chars = [$delimiter, $enclosure, $escape];
        return $this;
    }

    public function readAll()
    {
        if ($this->isOpen()) {
            throw new \Exception("File '{$this}' is open");
        }
        return file_get_contents($this->_name);
    }

    public function writeAll($string)
    {
        if ($this->isOpen()) {
            throw new \Exception("File '{$this}' is open");
        }
        file_put_contents($this->_name, $string);
        return $this;
    }
    
    public function open($mode = 'r')
    {
        $this->_handle = fopen($this->_name, $mode);
        return $this;
    }
    
    public function handle()
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return $this->_handle;
    }

    public function close()
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        fclose($this->_handle);
        $this->_handle = null;
        return $this;
    }

    public function read($length = null)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        if (!isset($length)) {
            $this->rewind();
            $size = $this->size();
            $length = $size ? $size : 1;
        }
        return fread($this->_handle, $length);
    }

    public function write($string, $length = null)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        isset($length)
            ? fwrite($this->_handle, $string, $length)
            : fwrite($this->_handle, $string);
        return $this;
    }

    public function get($length = null)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return isset($length)
            ? fgets($this->_handle, $length)
            : fgets($this->_handle);
    }

    public function put($string, $length = null)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        $this->write($string, $length) . $this->write("\n");
        return $this;
    }

    public function getCsv($length = 0)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return fgetcsv($this->_handle, $length, $this->_chars[0], $this->_chars[1], $this->_chars[2]);
    }

    public function putCsv($array)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        fputcsv($this->_handle, $array, $this->_chars[0], $this->_chars[1]);
        return $this;
    }

    public function seek($offset, $whence = SEEK_SET)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        fseek($this->_handle, $offset, $whence);
        return $this;
    }

    public function rewind()
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        rewind($this->_handle);
        return $this;
    }

    public function truncate($length = 0)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        ftruncate($this->_handle, $length);
        return $this;
    }

    public function tell()
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return ftell($this->_handle);
    }

    public function flush()
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return fflush($this->_handle);
    }

    public function lock($operation = LOCK_EX)
    {
        if (!$this->isOpen()) {
            throw new \Exception("File '{$this}' is not open");
        }
        return flock($this->_handle, $operation);
    }

    public function unlock()
    {
        return $this->lock(LOCK_UN);
    }

    public function output()
    {
        if ($this->isOpen()) {
            $this->rewind();
            fpassthru($this->_handle);
        } else {
            readfile($this->_name);
        }        
        return $this;
    }

    public function isOpen()
    {
        return isset($this->_handle);
    }

    public function moveUpload(\Coast\Dir $dir, $baseName = null)
    {
        $name = "{$dir}/" . (isset($baseName)
            ? $this->_parseBaseName($baseName)
            : $this->baseName());
        move_uploaded_file($this->_name, $name);
        $this->_name = $name;
        return $this;
    }

    public function copy(\Coast\Dir $dir, $baseName = null)
    {
        $name = "{$dir}/" . (isset($baseName)
            ? $this->_parseBaseName($baseName)
            : $this->baseName());
        copy($this->_name, $name);
        return new File($name);
    }

    public function remove()
    {
        unlink($this->_name);
        return $this;
    }

    public function permissions($mode = null)
    {
        if (isset($mode)) {
            chmod($this->_name, $mode);
            return $this;
        }
        return parent::permissions();
    }

    public function touch(DateTime $modify = null, \DateTime $access = null)
    {
        touch($this->_name, $modify->getTimestamp(), $access->getTimestamp());
        return $this;
    }

    public function size()
    {
        if ($this->isOpen()) {
            $stat = fstat($this->_handle);
            return $stat['size'];
        } else {
            return filesize($this->_name);
        }
    }

    public function hash($type)
    {
        return hash_file($type, $this->_name);
    }

    public function dir($create = false)
    {
        return new Dir($this->dirName(), $create);
    }
}
Coast API Documentation API documentation generated by ApiGen