CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.9 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.9
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper
  • None

Classes

  • BaseShellHelper
  • ConsoleOutputStub
  • ProgressShellHelper
  • TableShellHelper

Class ConsoleOutputStub

StubOutput makes testing shell commands/shell helpers easier.

You can use this class by injecting it into a Helper instance:

App::uses("ConsoleOutputStub", "TestSuite/Stub");

$output = new ConsoleOutputStub();
$helper = new ProgressHelper($output);
ConsoleOutput
Extended by ConsoleOutputStub
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/Stub/ConsoleOutputStub.php

Inherited Constants

  • COLOR, LF, PLAIN, RAW

Properties summary

  • $_lastWritten protected
    integer
    The number of bytes written by last call to write
  • $_out protected
    array
    Buffered messages.

Inherited Properties

  • _backgroundColors, _foregroundColors, _options, _output, _outputAs, _styles

Method Summary

  • messages() public
    Get the buffered output.
  • overwrite() public
    Overwrite output already written to the buffer.
  • write() public
    Write output to the buffer.

Method Detail

messages() public ¶

messages( )

Get the buffered output.

Returns
array

overwrite() public ¶

overwrite( array|string $message , integer $newlines = 1 , integer $size = null )

Overwrite output already written to the buffer.

Parameters
array|string $message
The message to output.
integer $newlines optional 1
Number of newlines to append.
integer $size optional null

The number of bytes to overwrite. Defaults to the length of the last message output.

Overrides
ConsoleOutput::overwrite()

write() public ¶

write( string|array $message , integer $newlines = 1 )

Write output to the buffer.

Parameters
string|array $message
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append
Overrides
ConsoleOutput::write()

Methods inherited from ConsoleOutput

__construct() public ¶

__construct( string $stream = 'php://stdout' )

Construct the output object.

Checks for a pretty console environment. Ansicon and ConEmu allows pretty consoles on Windows, and is supported.

Parameters
string $stream optional 'php://stdout'
The identifier of the stream to write output to.

__destruct() public ¶

__destruct( )

Clean up and close handles

_replaceTags() protected ¶

_replaceTags( array $matches )

Replace tags with color codes.

Parameters
array $matches
An array of matches to replace.
Returns
string

_write() protected ¶

_write( string $message )

Writes a message to the output stream.

Parameters
string $message
Message to write.
Returns
boolean
success

outputAs() public ¶

outputAs( integer $type = null )

Get/Set the output type to use. The output type how formatting tags are treated.

Parameters
integer $type optional null
The output type to use. Should be one of the class constants.
Returns
mixed
Either null or the value if getting.

styleText() public ¶

styleText( string $text )

Apply styling to text.

Parameters
string $text
Text with styling tags.
Returns
string
String with color codes added.

styles() public ¶

styles( string $style = null , array $definition = null )

Get the current styles offered, or append new ones in.

Get a style definition

$this->output->styles('error');

Get all the style definitions

$this->output->styles();

Create or modify an existing style

$this->output->styles('annoy', array('text' => 'purple', 'background' => 'yellow', 'blink' => true));

Remove a style

$this->output->styles('annoy', false);

Parameters
string $style optional null
The style to get or create.
array $definition optional null

The array definition of the style to change or create a style or false to remove a style.

Returns
mixed

If you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.


Properties detail

$_lastWritten ¶

protected integer

The number of bytes written by last call to write

$_out ¶

protected array

Buffered messages.

array()
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs