PHPExcel_Style
[ class tree: PHPExcel_Style ] [ index: PHPExcel_Style ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
Alignment.php
Border.php
Borders.php
Color.php
Conditional.php
Fill.php
Font.php
NumberFormat.php
Protection.php
Style.php

Classes:
PHPExcel_Style
PHPExcel_Style_Alignment
PHPExcel_Style_Border
PHPExcel_Style_Borders
PHPExcel_Style_Color
PHPExcel_Style_Conditional
PHPExcel_Style_Fill
PHPExcel_Style_Font
PHPExcel_Style_NumberFormat
PHPExcel_Style_Protection

Class: PHPExcel_Style_Protection

Source Location: /PHPExcel/Style/Protection.php

Class Overview




PHPExcel_Style_Protection




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables






Constants






Methods
























Class Details



[line 40]

PHPExcel_Style_Protection

PHPExcel_Style_Protection





Tags:





  

    copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
$_hashIndex = 

	
[line 217]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_hidden = 

	
[line 59]

  Hidden

Hidden





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_locked = 

	
[line 52]

  Locked

Locked





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_parent = 

	
[line 67]

  Parent Style

Parent Style





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style
    

      

	



	
[ Top ]


	
	

	
$_parentPropertyName = 

	
[line 74]

  Parent Borders

Parent Borders





Tags:





  

    var:  string
  

  

    access:  private
  






  

	

  

    

      Type:  
      _parentPropertyName
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 79]

	

    

    

		PHPExcel_Style_Protection __construct(
)
    

    


	
		Create a new PHPExcel_Style_Protection

Create a new PHPExcel_Style_Protection





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method applyFromArray [line 149]

	

    

    

		void applyFromArray(
[array
$pStyles = null])
    

    


	
		Apply styles from array

Apply styles from array
 
  1.  $objPHPExcel->getActiveSheet()->getStyle('B2')->getLocked()->applyFromArray( array('locked' => true, 'hidden' => false) );
    2. 






Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $pStyles  
        Array containing style information
      

        

    


        
[ Top ]

  

  

	
	
method getHashCode [line 203]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashIndex [line 227]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHidden [line 185]

	

    

    

		string getHidden(
)
    

    


	
		Get hidden

Get hidden





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLocked [line 167]

	

    

    

		string getLocked(
)
    

    


	
		Get locked

Get locked





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method propertyBeginBind [line 126]

	

    

    

		PHPExcel_Style_Protection propertyBeginBind(
)
    

    


	
		Property Begin Bind
 If no PHPExcel_Style_Protection has been bound to PHPExcel_Style then bind this one.

Property Begin Bind
 If no PHPExcel_Style_Protection has been bound to PHPExcel_Style then bind this one. Return the actual bound one.





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyGetBound [line 109]

	

    

    

		PHPExcel_Style_Protection propertyGetBound(
)
    

    


	
		Property Get Bound

Property Get Bound
 Returns the PHPExcel_Style_Protection that is actual bound to PHPExcel_Style





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method propertyPrepareBind [line 94]

	

    

    

		void propertyPrepareBind(
$parent
$parent, $parentPropertyName
$parentPropertyName)
    

    


	
		Property Prepare bind

Property Prepare bind
 Configures this object for late binding as a property of a parent object





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        $parent  
        $parent  
        
      

          

        $parentPropertyName  
        $parentPropertyName  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 239]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method setHidden [line 194]

	

    

    

		void setHidden(
[string
$pValue = self::PROTECTION_INHERIT])
    

    


	
		Set hidden

Set hidden





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setLocked [line 176]

	

    

    

		void setLocked(
[string
$pValue = self::PROTECTION_INHERIT])
    

    


	
		Set locked

Set locked





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 246]

	

    

    

		void __clone(
)
    

    


	
		Implement PHP __clone to create a deep clone, not just a shallow copy.

Implement PHP __clone to create a deep clone, not just a shallow copy.





Tags:





  

    access:  public
  









	
        
[ Top ]

  









Class Constants



	
	

	
PROTECTION_INHERIT =  'inherit'

	
[line 43]

  Protection styles

Protection styles


  

	
[ Top ]


	
	

	
PROTECTION_PROTECTED =  'protected'

	
[line 44]

  
  

	
[ Top ]


	
	

	
PROTECTION_UNPROTECTED =  'unprotected'

	
[line 45]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:38:23 +0100 by phpDocumentor 1.4.1