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: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 
<?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 Coast\App\Exception;
use Coast\App\Executable;
use Coast\Dir;
use Coast\File;
use Coast\Lazy;
use Coast\Path;
use Coast\Request;
use Coast\Response;
use Closure;

/**
 * Coast application object.
 */
class App implements Executable
{   
    use Executable\Implementation;

    const MODE_CLI  = 'cli';
    const MODE_HTTP = 'http';
    
    /**
     * Base directory.
     * @var Coast\Dir
     */
    protected $_baseDir;

    /**
     * Is subapp.
     * @var boolean
     */
    protected $_isSubapp = false;
       
    /**
     * Environment variables.
     * @var array
     */
    protected $_envs = [];

    /**
     * Parameters.
     * @var array
     */
    protected $_params = [];

    /**
     * Executables stack.
     * @var array
     */
    protected $_executables = [];

    /**
     * Handler for requests that are not handled by middleware.
     * @var Closure
     */
    protected $_failureHandler;

    /**
     * Handler for errors thrown in middleware.
     * @var Closure
     */
    protected $_errorHandler;

    /**
     * Construct a new Coast application.
     * @param mixed $baseDir Base directory.
     * @param array $envs Additional environment variables.
     */
    public function __construct($baseDir = null, array $envs = array())
    {
        $this->baseDir($baseDir);
        $this->_envs = array_merge(array(
            'MODE' => php_sapi_name() == 'cli' ? self::MODE_CLI : self::MODE_HTTP,
        ), $_ENV, $envs);
        $this->param('app', $this);
    }

    /**
     * Get/set base directory.
     * @return Coast\Dir
     */
    public function baseDir($baseDir = null)
    {
        if (func_num_args() > 0) {
            $baseDir = isset($baseDir) && !$baseDir instanceof Dir
                ? new Dir("{$baseDir}")
                : $baseDir;
            $this->_baseDir = $baseDir;
            return $this;
        }
        return $this->_baseDir;
    }

    /**
     * Get/set is subapp.
     * @return boolean
     */
    public function isSubapp($isSubapp = null)
    {
        if (func_num_args() > 0) {
            $this->_isSubapp = $isSubapp;
            return $this;
        }
        return $this->_isSubapp;
    }

    /**
     * Get child directory.
     * @return Coast\Dir
     */
    public function dir($path = null, $create = false)
    {
        if (!isset($this->_baseDir)) {
            throw new App\Exception('Base directory not set');
        }
        return isset($path)
            ? $this->_baseDir->dir($path, $create)
            : $this->_baseDir;
    }

    /**
     * Get child file.
     * @return Coast\File
     */
    public function file($path)
    {
        if (!isset($this->_baseDir)) {
            throw new App\Exception('Base directory not set');
        }
        return $this->_baseDir->file($path);
    }

    /**
     * Load a file without leaking variables, include app object in vars.
     * @param  mixed   $file
     * @param  array   $vars
     * @return mixed
     */
    public function load($file, array $vars = array())
    {
        $file = !$file instanceof File
            ? new File("{$file}")
            : $file;
        $file = $file->isRelative()
            ? $this->file($file)
            : $file;
        return \Coast\load($file, array_merge(['app' => $this], $vars));
    }

    /**
     * Lazy load a file without leaking variables, include app object in vars.
     * @param  mixed   $file
     * @param  array   $vars
     * @return mixed
     */
    public function lazy($source, array $vars = array())
    {
        if (is_string($source)) {
            $source = new File("{$source}");
            $source = $source->isRelative()
                ? $this->file($source)
                : $source;
        }
        return new Lazy($source, array_merge(['app' => $this], $vars));
    }

    /**
     * Get environment variables.
     * @param  string $name
     * @return mixed
     */
    public function env($name)
    {
        return isset($this->_envs[$name])
            ? $this->_envs[$name]
            : null;
    }

    /**
     * Get the mode (HTTP or CLI).
     * @return string
     */
    public function mode()
    {
        return $this->env('MODE');
    }

    /**
     * Is mode HTTP.
     * @return bool
     */
    public function isHttp()
    {
        return $this->mode() == self::MODE_HTTP;
    }

    /**
     * Is mode CLI.
     * @return bool
     */
    public function isCli()
    {
        return $this->mode() == self::MODE_CLI;
    }

    /**
     * Set/get param.
     * @param  string $name  
     * @param  mixed $value
     * @return self|mixed
     */
    public function param($name, $value = null)
    {
        if (func_num_args() > 1) {
            if ($value instanceof \Coast\App\Access) {
                $value->app($this);
            }
            $this->_params[$name] = $value;
            return $this;
        }
        return isset($this->_params[$name])
            ? $this->_params[$name]
            : null;
    }

    /**
     * Set/get multiple params.
     * @param  array $params
     * @return self|array
     */
    public function params(array $params = null)
    {
        if (func_num_args() > 0) {
            foreach ($params as $name => $value) {
                $this->param($name, $value);
            }
            return $this;
        }
        return $this->_params;
    }

    /**
     * Add executable to the stack.
     * @param string $name
     * @param Closure|Coast\App\Executable $value
     * @return self
     */
    public function executable($executable, $subpath = null)
    {
        if (!$executable instanceof Closure && !$executable instanceof Executable) {
            throw new App\Exception("Object is not a closure or instance of Coast\App\Executable");
        }
        if (isset($subpath)) {
            $executable = new App\Subpath($executable, $subpath);
        } else if ($executable instanceof App || $executable instanceof Lazy) {
            $executable->isSubapp(true);
        }
        array_push($this->_executables, $executable instanceof Closure
            ? $executable->bindTo($this)
            : $executable);
        return $this;
    }

    /**
     * Execute the application, running middleware in order.
     * @param  Coast\Request $req Request object.
     * @param  Coast\Response $res Response object.
     */
    public function execute(Request $req = null, Response $res = null)
    {
        $auto = false;
        if (!isset($req)) {
            $auto = true;
            $req  = (new Request())->fromGlobals();
            $res  = (new Response($req));
        } else if (!isset($res)) {
            throw new App\Exception('You must pass a Response object when passing a Request object');
        }

        $this->param('req', $req)
             ->param('res', $res);
        try {
            $this->preExecute($req, $res);
            foreach ($this->_executables as $executable) {
                if ($executable instanceof Executable && !$executable instanceof App) {
                    $executable->preExecute($req, $res);
                }
            }
            $result = null;
            foreach ($this->_executables as $executable) {
                $result = call_user_func($executable instanceof Executable
                    ? [$executable, 'execute']
                    : $executable, $req, $res);
                if (isset($result)) {
                    break;
                }
            }
            if (!$result && !$this->_isSubapp) {
                if (isset($this->_failureHandler)) {
                    $result = call_user_func($this->_failureHandler, $req, $res);
                } else {
                    throw new App\Exception('Nothing successfully handled the request');
                }
            }
            foreach ($this->_executables as $executable) {
                if ($executable instanceof Executable && !$executable instanceof App) {
                    $executable->postExecute($req, $res);
                }
            }
            $this->postExecute($req, $res);
        } catch (\Exception $e) {
            if (isset($this->_errorHandler)) {
                $result = call_user_func($this->_errorHandler, $req, $res, $e);
            } else {
                throw $e;
            }
        }
        $this->param('req', null)
             ->param('res', null);
        
        if ($auto) {
            $res->toGlobals();
        } else {
            return $result;
        }
    }

    /**
     * Set the failure handler
     * @param  Closure $failureHandler
     * @return self
     */
    public function failureHandler(Closure $failureHandler)
    {
        $this->_failureHandler = $failureHandler->bindTo($this);
        return $this;
    }

    /**
     * Set the error handler
     * @param  Closure $errorHandler
     * @return self
     */
    public function errorHandler(Closure $errorHandler)
    {
        $this->_errorHandler = $errorHandler->bindTo($this);
        return $this;
    }

    /**
     * Set a parameter.
     * @param string $name
     * @param mixed $value
     * @return self
     */
    public function __set($name, $value)
    {
        return $this->param($name, $value);
    }

    /**
     * Get a parameter.
     * @param  string $name
     * @return mixed
     */
    public function __get($name)
    {
        $value = $this->param($name);
        return $value;
    }

    /**
     * Check if a parameter exists.
     * @param  string  $name
     * @return boolean
     */
    public function __isset($name)
    {
        return $this->param($name) !== null;
    }

    /**
     * Unset a parameter.
     * @param  string  $name
     * @return boolean
     */
    public function __unset($name)
    {
        return $this->param($name, null);
    }

    /**
     * Attempts to call parameter named `$name`
     * @param string $name
     * @param array $args
     */
    public function __call($name, array $args)
    {
        $value = $this->param($name);
        if (!is_callable($value)) {
            throw new \Coast\App\Exception("Param '{$name}' is not callable");
        }
        return call_user_func_array($value, $args);
    }
}
Coast API Documentation API documentation generated by ApiGen