filestack/filestack-php

View on GitHub
docs/classes/Filestack_Filelink/__construct.html

Summary

Maintainability
Test Coverage
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <title>phpDox - Filestack\Filelink::__construct</title>
    <link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  </head>
  <body>
    <nav class="topnav">
      <ul>
        <li>
          <div class="logo"><span>/**</span>phpDox</div>
        </li>
        <li class="separator">
          <a href="../../index.html">Overview</a>
        </li>
        <li class="separator">
          <a href="../../namespaces.html">Namespaces</a>
        </li>
        <li>
          <a href="../../classes.html">Classes</a>
        </li>
        <li>
          <a href="../../traits.html">Traits</a>
        </li>
        <li class="separator">
          <a href="../../source/index.html">Source</a>
        </li>
      </ul>
    </nav>
    <div id="mainstage">
      <div class="box">
        <ul class="breadcrumb">
          <li>
            <a href="../../index.html">Overview</a>
          </li>
          <li class="separator">
            <a href="../../classes.html">Classes</a>
          </li>
          <li class="separator">
            <a href="../../classes.html#Filestack">Filestack</a>
          </li>
          <li class="separator">
            <a title="Filestack\Filelink" href="../../classes/Filestack_Filelink.html">Filelink</a>
          </li>
          <li class="separator">__construct</li>
        </ul>
      </div>
      <nav class="box">
        <ul>
          <li>
            <a href="#introduction">Introduction</a>
          </li>
          <li>
            <a href="#synopsis">Synopsis</a>
          </li>
          <li>
            <a href="#parameter">Parameter</a>
          </li>
          <li>
            <a href="#tests">Tests</a>
          </li>
          <li>
            <a href="../../source/Filelink.php.html#line38">Source</a>
          </li>
        </ul>
      </nav>
      <section>
        <h1><small>Filestack\Filelink::</small>__construct</h1>
        <h4>Filelink constructor</h4>
        <p/>
        <ul/>
        <h2 id="signature">Signature</h2>
        <div class="styled synopsis">
          <code>public function __construct(string
        $handle,
            [string
        $api_key = '',
            [<a title="Filestack\FilestackSecurity" href="../../classes/Filestack_FilestackSecurity.html">FilestackSecurity</a>
        $security = NULL,
            [<a title="Filestack\GuzzleHttp\Client" href="../../classes/Filestack_GuzzleHttp_Client.html">Client</a>
        $http_client = NULL,
            [string
        $cname = NULL]]]] )
            </code>
        </div>
        <h2 id="parameterlist">Parameters</h2>
        <dl class="styled">
          <dt><code>$handle</code>
                —
                string</dt>
          <dd>Filestack file handle</dd>
          <dt><code>$api_key</code>
                —
                string</dt>
          <dd>Filestack API Key</dd>
          <dt><code>$security</code>
                —
                object</dt>
          <dd>Filestack security object if<br/>security settings is turned on</dd>
          <dt><code>$http_client</code>
                —
                object</dt>
          <dd>DI http client, will instantiate<br/>one if not passed in</dd>
          <dt><code>$cname</code>
                —
                string</dt>
          <dd>Domain to use for all URLs.<br/>__Requires the custom CNAME<br/>addon__. If this is enabled then<br/>you must also set up your own<br/>OAuth applications for each cloud<br/>source you wish to use in the<br/>                                       picker.</dd>
        </dl>
        <h2 id="tests">Test Coverage</h2>
        <div class="styled">
          <h3>Information</h3>
          <ul class="styled">
            <li>Coverage: / Lines (%)</li>
            <li>Tests: 0</li>
            <li>Passed: 0 (0%)</li>
          </ul>
        </div>
      </section>
    </div>
    <footer>
      <span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
    </footer>
  </body>
</html>