From ff54252728a572172396067b9eda21c5faa7af3f Mon Sep 17 00:00:00 2001 From: froschdesign Date: Thu, 18 Feb 2016 22:27:19 +0100 Subject: [PATCH] [Docs] Removes HTML comments - See #39 --- doc/book/zend.http.client-static.md | 2 - doc/book/zend.http.headers.md | 151 ---------------------------- doc/book/zend.http.request.md | 68 ------------- doc/book/zend.http.response.md | 52 ---------- 4 files changed, 273 deletions(-) diff --git a/doc/book/zend.http.client-static.md b/doc/book/zend.http.client-static.md index d5921aa1cd..318f63bbe9 100644 --- a/doc/book/zend.http.client-static.md +++ b/doc/book/zend.http.client-static.md @@ -40,8 +40,6 @@ body. The fifth parameter can be used to pass configuration options to the HTTP Returns Zend\\Http\\Response - - **post** `post(string $url, array $params, array $headers = array(), mixed $body = null, $clientOptions = null)` diff --git a/doc/book/zend.http.headers.md b/doc/book/zend.http.headers.md index 67b89d69ee..0a04689494 100644 --- a/doc/book/zend.http.headers.md +++ b/doc/book/zend.http.headers.md @@ -63,8 +63,6 @@ strings until they are needed (they will be lazy loaded). Returns `Zend\Http\Headers` - - **setPluginClassLoader** `setPluginClassLoader(Zend\Loader\PluginClassLocator $pluginClassLoader)` @@ -72,8 +70,6 @@ Set an alternate implementation for the plugin class loader Returns `Zend\Http\Headers` - - **getPluginClassLoader** `getPluginClassLoader()` @@ -81,8 +77,6 @@ Return an instance of a `Zend\Loader\PluginClassLocator`, lazyload and inject ma Returns `Zend\Loader\PluginClassLocator` - - **addHeaders** `addHeaders(array|Traversable $headers)` @@ -92,8 +86,6 @@ Expects an array (or `Traversable` object) of type/value pairs. Returns `Zend\Http\Headers` - - **addHeaderLine** `addHeaderLine(string $headerFieldNameOrLine, string $fieldValue)` @@ -104,8 +96,6 @@ delayed until they are retrieved by either `get()` or `current()`. Returns `Zend\Http\Headers` - - **addHeader** `addHeader(Zend\Http\Header\HeaderInterface $header)` @@ -113,8 +103,6 @@ Add a Header to this container, for raw values see `addHeaderLine()` and `addHea Returns `Zend\Http\Headers` - - **removeHeader** `removeHeader(Zend\Http\Header\HeaderInterface $header)` @@ -122,8 +110,6 @@ Remove a Header from the container Returns bool - - **clearHeaders** `clearHeaders()` @@ -133,8 +119,6 @@ Removes all headers from queue Returns `Zend\Http\Headers` - - **get** `get(string $name)` @@ -142,8 +126,6 @@ Get all headers of a certain name/type Returns false| `Zend\Http\Header\HeaderInterface`| `ArrayIterator` - - **has** `has(string $name)` @@ -151,8 +133,6 @@ Test for existence of a type of header Returns bool - - **next** `next()` @@ -160,8 +140,6 @@ Advance the pointer for this object as an iterator Returns void - - **key** `key()` @@ -169,8 +147,6 @@ Return the current key for this object as an iterator Returns mixed - - **valid** `valid()` @@ -178,8 +154,6 @@ Is this iterator still valid? Returns bool - - **rewind** `rewind()` @@ -187,8 +161,6 @@ Reset the internal pointer for this object as an iterator Returns void - - **current** `current()` @@ -196,8 +168,6 @@ Return the current value for this iterator, lazy loading it if need be Returns `Zend\Http\Header\HeaderInterface` - - **count** `count()` @@ -207,8 +177,6 @@ iterate. Returns int - - **toString** `toString()` @@ -219,8 +187,6 @@ with the appropriate status/request line. Returns string - - **toArray** `toArray()` @@ -228,8 +194,6 @@ Return the headers container as an array Returns array - - **forceLoading** `forceLoading()` @@ -247,8 +211,6 @@ Factory to generate a header object from a string Returns `Zend\Http\Header\GenericHeader` - - **getFieldName** `getFieldName()` @@ -256,8 +218,6 @@ Retrieve header field name Returns string - - **getFieldValue** `getFieldValue()` @@ -265,8 +225,6 @@ Retrieve header field value Returns string - - **toString** `toString()` @@ -424,8 +382,6 @@ Does the header have the requested media type? Returns bool - - **AcceptCharset** See `Zend\Http\Header\AbstractAccept` methods<zend.http.header.abstractaccept.methods>. @@ -439,8 +395,6 @@ Does the header have the requested charset? Returns bool - - **AcceptEncoding** See `Zend\Http\Header\AbstractAccept` methods<zend.http.header.abstractaccept.methods>. @@ -454,8 +408,6 @@ Does the header have the requested encoding? Returns bool - - **AcceptLanguage** See `Zend\Http\Header\AbstractAccept` methods<zend.http.header.abstractaccept.methods>. @@ -469,15 +421,11 @@ Does the header have the requested language? Returns bool - - **AcceptRanges** `getRangeUnit()` `setRangeUnit($rangeUnit)` - - **Age** `getDeltaSeconds()` Get number of seconds @@ -489,8 +437,6 @@ Set number of seconds Returns self - - **Allow** `getAllMethods()` Get list of all defined methods @@ -522,18 +468,12 @@ Check whether method is allowed Returns bool - - **AuthenticationInfo** No additional methods - - **Authorization** No additional methods - - **CacheControl** `isEmpty()` Checks if the internal directives array is empty @@ -564,8 +504,6 @@ Remove a directive Returns self - - **Connection** `setValue($value)` Set arbitrary header value @@ -584,43 +522,27 @@ Set Connection header to define persistent connection Returns self - - **ContentDisposition** No additional methods - - **ContentEncoding** No additional methods - - **ContentLanguage** No additional methods - - **ContentLength** No additional methods - - **ContentLocation** See `Zend\Http\Header\AbstractLocation` methods<zend.http.header.abstractlocation.methods>. - - **ContentMD5** No additional methods - - **ContentRange** No additional methods - - **ContentSecurityPolicy** `getDirectives()` Retrieve the defined directives for the policy @@ -647,13 +569,9 @@ $csp->setDirective('default-src', array()) // No sources Returns self - - **ContentTransferEncoding** No additional methods - - **ContentType** `match(array|string $matchAgainst)` Determine if the mediatype value in this header matches the provided criteria @@ -690,8 +608,6 @@ Set the content-type character set encoding Returns self - - **Cookie** Extends `ArrayObject` @@ -701,118 +617,72 @@ static `fromSetCookieArray(array $setCookies)` `getEncodeValue()` - - **Date** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. - - **Etag** No additional methods - - **Expect** No additional methods - - **Expires** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. - - **From** No additional methods - - **Host** No additional methods - - **IfMatch** No additional methods - - **IfModifiedSince** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. - - **IfNoneMatch** No additional methods - - **IfRange** No additional methods - - **IfUnmodifiedSince** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. - - **KeepAlive** No additional methods - - **LastModified** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. - - **Location** See `Zend\Http\Header\AbstractLocation` methods<zend.http.header.abstractlocation.methods>. - - **MaxForwards** No additional methods - - **Origin** No additional methods - - **Pragma** No additional methods - - **ProxyAuthenticate** `toStringMultipleHeaders(array $headers)` - - **ProxyAuthorization** No additional methods - - **Range** No additional methods - - **Referer** See `Zend\Http\Header\AbstractLocation` methods<zend.http.header.abstractlocation.methods>. - - **Refresh** No additional methods - - **RetryAfter** See `Zend\Http\Header\AbstractDate` methods<zend.http.header.abstractdate.methods>. @@ -826,13 +696,9 @@ Get number of seconds Returns int - - **Server** No additional methods - - **SetCookie** `getName()` / `setName(string $name)` The cookie name @@ -918,48 +784,31 @@ Returns bool `toStringMultipleHeaders(array $headers)` Returns string - - **TE** No additional methods - - **Trailer** No additional methods - - **TransferEncoding** No additional methods - - **Upgrade** No additional methods - - **UserAgent** No additional methods - - **Vary** No additional methods - - **Via** No additional methods - **Warning** No additional methods - - **WWWAuthenticate** `toStringMultipleHeaders(array $headers)` diff --git a/doc/book/zend.http.request.md b/doc/book/zend.http.request.md index fb3297f88a..80d3a544f0 100644 --- a/doc/book/zend.http.request.md +++ b/doc/book/zend.http.request.md @@ -61,8 +61,6 @@ A factory that produces a Request object from a well-formed HTTP Request string. Returns `Zend\Http\Request` - - **setMethod** `setMethod(string $method)` @@ -70,8 +68,6 @@ Set the method for this request. Returns `Zend\Http\Request` - - **getMethod** `getMethod()` @@ -79,8 +75,6 @@ Return the method for this request. Returns string - - **setUri** `setUri(string|Zend\Uri\Http $uri)` @@ -88,8 +82,6 @@ Set the URI/URL for this request; this can be a string or an instance of `Zend\U Returns `Zend\Http\Request` - - **getUri** `getUri()` @@ -97,8 +89,6 @@ Return the URI for this request object. Returns `Zend\Uri\Http` - - **getUriString** `getUriString()` @@ -106,8 +96,6 @@ Return the URI for this request object as a string. Returns string - - **setVersion** `setVersion(string $version)` @@ -116,8 +104,6 @@ Set the HTTP version for this object, one of 1.0 or 1.1 (`Request::VERSION_10`, Returns `Zend\Http\Request` - - **getVersion** `getVersion()` @@ -125,8 +111,6 @@ Return the HTTP version for this request. Returns string - - **setQuery** `setQuery(Zend\Stdlib\ParametersInterface $query)` @@ -135,8 +119,6 @@ is NOT the primary API for value setting; for that, see `getQuery()`). Returns `Zend\Http\Request` - - **getQuery** `getQuery(string|null $name, mixed|null $default)` @@ -145,8 +127,6 @@ Return the parameter container responsible for query parameters or a single quer Returns `string`, `Zend\Stdlib\ParametersInterface`, or `null` depending on value of `$name` argument. - - **setPost** `setPost(Zend\Stdlib\ParametersInterface $post)` @@ -155,8 +135,6 @@ NOT the primary API for value setting; for that, see `getPost()`). Returns `Zend\Http\Request` - - **getPost** `getPost(string|null $name, mixed|null $default)` @@ -165,8 +143,6 @@ Return the parameter container responsible for POST parameters or a single POST Returns `string`, `Zend\Stdlib\ParametersInterface`, or `null` depending on value of `$name` argument. - - **getCookie** `getCookie()` @@ -175,8 +151,6 @@ Return the Cookie header, this is the same as calling Returns `Zend\Http\Header\Cookie` - - **setFiles** `setFiles(Zend\Stdlib\ParametersInterface $files)` @@ -185,8 +159,6 @@ NOT the primary API for value setting; for that, see `getFiles()`). Returns `Zend\Http\Request` - - **getFiles** `getFiles(string|null $name, mixed|null $default)` @@ -195,8 +167,6 @@ Return the parameter container responsible for file parameters or a single file Returns `string`, `Zend\Stdlib\ParametersInterface`, or `null` depending on value of `$name` argument. - - **setHeaders** `setHeaders(Zend\Http\Headers $headers)` @@ -205,8 +175,6 @@ primary API for value setting, for that see `getHeaders()`). Returns `Zend\Http\Request` - - **getHeaders** `getHeaders(string|null $name, mixed|null $default)` @@ -217,8 +185,6 @@ Zend\\\\Http\\\\Headers<zend.http.headers> for more information. Returns `Zend\Http\Headers` if `$name` is `null`. Returns `Zend\Http\Header\HeaderInterface` or `ArrayIterator` if `$name` matches one or more stored headers, respectively. - - **setMetadata** `setMetadata(string|int|array|Traversable $spec, mixed $value)` @@ -229,8 +195,6 @@ entire metadata container. Returns `Zend\Http\Request` - - **getMetadata** `getMetadata(null|string|int $key, null|mixed $default)` @@ -238,8 +202,6 @@ Retrieve all metadata or a single metadatum as specified by key. Returns mixed - - **setContent** `setContent(mixed $value)` @@ -247,8 +209,6 @@ Set request body (content). Returns `Zend\Http\Request` - - **getContent** `getContent()` @@ -256,8 +216,6 @@ Get request body (content). Returns mixed - - **isOptions** `isOptions()` @@ -265,8 +223,6 @@ Is this an OPTIONS method request? Returns bool - - **isGet** `isGet()` @@ -274,8 +230,6 @@ Is this a GET method request? Returns bool - - **isHead** `isHead()` @@ -283,8 +237,6 @@ Is this a HEAD method request? Returns bool - - **isPost** `isPost()` @@ -292,8 +244,6 @@ Is this a POST method request? Returns bool - - **isPut** `isPut()` @@ -301,8 +251,6 @@ Is this a PUT method request? Returns bool - - **isDelete** `isDelete()` @@ -310,8 +258,6 @@ Is this a DELETE method request? Returns bool - - **isTrace** `isTrace()` @@ -319,8 +265,6 @@ Is this a TRACE method request? Returns bool - - **isConnect** `isConnect()` @@ -328,8 +272,6 @@ Is this a CONNECT method request? Returns bool - - **isPatch** `isPatch()` @@ -337,8 +279,6 @@ Is this a PATCH method request? Returns bool - - **isXmlHttpRequest** `isXmlHttpRequest()` @@ -346,8 +286,6 @@ Is this a Javascript XMLHttpRequest? Returns bool - - **isFlashRequest** `isFlashRequest()` @@ -355,8 +293,6 @@ Is this a Flash request? Returns bool - - **renderRequestLine** `renderRequestLine()` @@ -364,15 +300,11 @@ Return the formatted request line (first line) for this HTTP request. Returns string - - **toString** `toString()` Returns string - - **\_\_toString** `__toString()` diff --git a/doc/book/zend.http.response.md b/doc/book/zend.http.response.md index 4cd9f44a36..c10d2b5d93 100644 --- a/doc/book/zend.http.response.md +++ b/doc/book/zend.http.response.md @@ -70,8 +70,6 @@ Populate object from string Returns `Zend\Http\Response` - - **renderStatusLine** `renderStatusLine()` @@ -79,8 +77,6 @@ Render the status line header Returns string - - **setHeaders** `setHeaders(Zend\Http\Headers $headers)` @@ -89,8 +85,6 @@ primary API for value setting; for that, see `getHeaders()`.) Returns `Zend\Http\Request` - - **getHeaders** `getHeaders()` @@ -100,8 +94,6 @@ Zend\\\\Http\\\\Headers<zend.http.headers> for more information. Returns `Zend\Http\Headers` - - **setVersion** `setVersion(string $version)` @@ -110,8 +102,6 @@ Set the HTTP version for this object, one of 1.0 or 1.1 (`Request::VERSION_10`, Returns `Zend\Http\Request`. - - **getVersion** `getVersion()` @@ -119,8 +109,6 @@ Return the HTTP version for this request Returns string - - **setStatusCode** `setStatusCode(numeric $code)` @@ -128,8 +116,6 @@ Set HTTP status code Returns `Zend\Http\Response` - - **getStatusCode** `getStatusCode()` @@ -137,8 +123,6 @@ Retrieve HTTP status code Returns int - - **setReasonPhrase** `setReasonPhrase(string $reasonPhrase)` @@ -146,8 +130,6 @@ Set custom HTTP status message Returns `Zend\Http\Response` - - **getReasonPhrase** `getReasonPhrase()` @@ -155,8 +137,6 @@ Get HTTP status message Returns string - - **isClientError** `isClientError()` @@ -164,8 +144,6 @@ Does the status code indicate a client error? Returns bool - - **isForbidden** `isForbidden()` @@ -173,8 +151,6 @@ Is the request forbidden due to ACLs? Returns bool - - **isInformational** `isInformational()` @@ -182,8 +158,6 @@ Is the current status "informational"? Returns bool - - **isNotFound** `isNotFound()` @@ -191,8 +165,6 @@ Does the status code indicate the resource is not found? Returns bool - - **isOk** `isOk()` @@ -200,8 +172,6 @@ Do we have a normal, OK response? Returns bool - - **isServerError** `isServerError()` @@ -209,8 +179,6 @@ Does the status code reflect a server error? Returns bool - - **isRedirect** `isRedirect()` @@ -218,8 +186,6 @@ Do we have a redirect? Returns bool - - **isSuccess** `isSuccess()` @@ -227,8 +193,6 @@ Was the response successful? Returns bool - - **decodeChunkedBody** `decodeChunkedBody(string $body)` @@ -236,8 +200,6 @@ Decode a "chunked" transfer-encoded body and return the decoded text Returns string - - **decodeGzip** `decodeGzip(string $body)` @@ -247,8 +209,6 @@ Currently requires PHP with zlib support Returns string - - **decodeDeflate** `decodeDeflate(string $body)` @@ -258,8 +218,6 @@ Currently requires PHP with zlib support Returns string - - **setMetadata** `setMetadata(string|int|array|Traversable $spec, mixed $value)` @@ -270,8 +228,6 @@ entire metadata container. Returns `Zend\Stdlib\Message` - - **getMetadata** `getMetadata(null|string|int $key, null|mixed $default)` @@ -279,8 +235,6 @@ Retrieve all metadata or a single metadatum as specified by key Returns mixed - - **setContent** `setContent(mixed $value)` @@ -288,8 +242,6 @@ Set message content Returns `Zend\Stdlib\Message` - - **getContent** `getContent()` @@ -297,8 +249,6 @@ Get raw message content Returns mixed - - **getBody** `getBody()` @@ -306,8 +256,6 @@ Get decoded message content Returns mixed - - **toString** `toString()`