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

  • AclShell
  • ApiShell
  • BakeShell
  • CommandListShell
  • CompletionShell
  • ConsoleShell
  • I18nShell
  • SchemaShell
  • ServerShell
  • TestShell
  • TestsuiteShell
  • UpgradeShell

Class AclShell

Shell for ACL management. This console is known to have issues with zend.ze1_compatibility_mode being enabled. Be sure to turn it off when using this shell.

AppShell
Extended by AclShell
Package: Cake\Console\Command
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Console/Command/AclShell.php

Properties summary

  • $Acl public
    AclComponent
    Contains instance of AclComponent
  • $args public
    array
    Contains arguments parsed from the command line.
  • $connection public
    string
    Contains database source to use
  • $tasks public
    array
    Contains tasks to load and instantiate

Method Summary

  • _dataVars() protected
    Build data parameters based on node type
  • _getNodeId() protected

    Get the node for a given identifier. $identifier can either be a string alias or an array of properties to use in AcoNode::node()

  • _getParams() protected
    get params for standard Acl methods
  • _outputNode() protected
    Outputs a single node, Either using the alias or Model.key
  • check() public
    Check permission for a given ARO to a given ACO.
  • create() public
    Creates an ARO/ACO node
  • delete() public

    Delete an ARO/ACO node. Note there may be (as a result of poor configuration) multiple records with the same logical identifier. All are deleted.

  • deny() public
    Deny access for an ARO to an ACO.
  • getOptionParser() public
    Gets the option parser instance and configures it.
  • getPath() public
    Get path to specified ARO/ACO node.
  • grant() public
    Grant permission for a given ARO to a given ACO.
  • inherit() public
    Set an ARO to inherit permission to an ACO.
  • initdb() public
    Initialize ACL database.
  • main() public
    Override main() for help message hook
  • nodeExists() public
    Checks that given node exists
  • parseIdentifier() public

    Parse an identifier into Model.foreignKey or an alias. Takes an identifier determines its type and returns the result as used by other methods.

  • setParent() public
    Set parent for an ARO/ACO node.
  • startup() public
    Override startup of the Shell
  • view() public
    Show a specific ARO/ACO node.

Method Detail

_dataVars() protected ¶

_dataVars( string $type = null )

Build data parameters based on node type

Parameters
string $type optional null
Node type (ARO/ACO)
Returns
array
Variables

_getNodeId() protected ¶

_getNodeId( string $class , string|array|null $identifier )

Get the node for a given identifier. $identifier can either be a string alias or an array of properties to use in AcoNode::node()

Parameters
string $class
Class type you want (Aro/Aco)
string|array|null $identifier
A mixed identifier for finding the node, otherwise null.
Returns
integer
Integer of NodeId. Will trigger an error if nothing is found.

_getParams() protected ¶

_getParams( )

get params for standard Acl methods

Returns
array
aro, aco, action

_outputNode() protected ¶

_outputNode( string $class , array $node , integer $indent )

Outputs a single node, Either using the alias or Model.key

Parameters
string $class
Class name that is being used.
array $node
Array of node information.
integer $indent
indent level.

check() public ¶

check( )

Check permission for a given ARO to a given ACO.

create() public ¶

create( )

Creates an ARO/ACO node

delete() public ¶

delete( )

Delete an ARO/ACO node. Note there may be (as a result of poor configuration) multiple records with the same logical identifier. All are deleted.

deny() public ¶

deny( )

Deny access for an ARO to an ACO.

getOptionParser() public ¶

getOptionParser( )

Gets the option parser instance and configures it.

Returns
ConsoleOptionParser

getPath() public ¶

getPath( )

Get path to specified ARO/ACO node.

grant() public ¶

grant( )

Grant permission for a given ARO to a given ACO.

inherit() public ¶

inherit( )

Set an ARO to inherit permission to an ACO.

initdb() public ¶

initdb( )

Initialize ACL database.

Returns
mixed

main() public ¶

main( )

Override main() for help message hook

nodeExists() public ¶

nodeExists( )

Checks that given node exists

Returns
boolean
Success

parseIdentifier() public ¶

parseIdentifier( string $identifier )

Parse an identifier into Model.foreignKey or an alias. Takes an identifier determines its type and returns the result as used by other methods.

Parameters
string $identifier
Identifier to parse
Returns
mixed
a string for aliases, and an array for model.foreignKey

setParent() public ¶

setParent( )

Set parent for an ARO/ACO node.

startup() public ¶

startup( )

Override startup of the Shell

view() public ¶

view( )

Show a specific ARO/ACO node.

Properties detail

$Acl ¶

public AclComponent

Contains instance of AclComponent

$args ¶

public array

Contains arguments parsed from the command line.

$connection ¶

public string

Contains database source to use

'default'

$tasks ¶

public array

Contains tasks to load and instantiate

array('DbConfig')
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